localcast
v2.0.1
Published
A shared event emitter that works across multiple processes on the same machine, including the browser!
Downloads
29
Readme
localcast
A shared event emitter that works across multiple processes on the same machine, including the browser!
npm install localcastUsage
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.jsRunning 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.jsBoth 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.htmlOpen 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