Giter Site home page Giter Site logo

nichoth / localcast Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mafintosh/localcast

0.0 3.0 0.0 8 KB

A shared event emitter that works across multiple processes on the same machine, including the browser!

License: MIT License

JavaScript 100.00%

localcast's Introduction

localcast

A shared event emitter that works across multiple processes on the same machine, including the browser!

npm install localcast

Usage

First save the example below in file called example.js.

var localcast = require('localcast')
var cast = localcast()

cast.on('hello', function (data) {
  console.log('hello', data)
})

cast.emit('hello', 'world')

Then try running the example in a terminal.

# in one terminal
$ node example.js

Running the above should print out hello world and keep the process running.

Then try running opening a new terminal and run the example again.

# in a new terminal
$ node example.js

Both the new and old terminal should print out hello world.

Now try browserifying the example

browserify example.js > bundle.js
echo '<html><body><script src="bundle.js"></script></body></html>' > example.html

Open example.html in a browser. Now both the browser and the two previous terminals should print out hello world!

API

var cast = localcast([name])

Create a new localcast event emitter.

Optionally you can give it a name if you are running multiple and want them to avoid clashing.

cast.on('localcast', peer)

Whenever you are connected to another localcast instance a special localcast event is emitted with an object describing the other instance.

cast.on('localcast', function (peer) {
  console.log('we are connected to another instance', peer)
})

If the other peer is a browser the peer looks like this

{
  type: 'browser',
  localhost: urlOfWebsite
}

If the other peer is a node process it looks like this

{
  type: 'node',
  pid: pid
}

License

MIT

localcast's People

Contributors

mafintosh avatar nichoth avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.