https://github.com/mafintosh/localcast

A shared event emitter that works across multiple processes on the same machine, including the browser!
https://github.com/mafintosh/localcast

Last synced: 12 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/mafintosh/localcast
• Owner: mafintosh
• License: mit
• Created: 2017-03-09T15:29:33.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-04-21T00:28:57.000Z (over 7 years ago)
• Last Synced: 2024-10-23T02:56:35.774Z (20 days ago)
• Language: JavaScript
• Size: 8.79 KB
• Stars: 165
• Watchers: 7
• Forks: 16
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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`.

``` 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.

``` sh

# 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.

``` sh

# in a new terminal

$ node example.js

```

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

Now try browserifying the example

``` sh

browserify example.js > bundle.js

echo '' > 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.

``` js

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

``` js

{

  type: 'browser',

  localhost: urlOfWebsite

}

```

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

``` js

{

  type: 'node',

  pid: pid

}

```

## License

MIT