3.2.1 • Published 9 years ago

pubsub v3.2.1

Weekly downloads
211
License
MIT
Repository
gitlab
Last release
9 years ago

Installation

Install and save the pubsub module. npm i --save pubsub

Or use with script tag <script type="text/javascript" src="https://gitlab.me/wski/pubsub/raw/master/dist.js"></script>

Then simply require it at the root level of your project.

require('pubsub');

Usage

Join a channel

PubSub.join('general', (message, uuid) => {
  // Upon joining you will receive a uuid without a message.
  // Other times, you will be sent a message, and a uuid.
  if (message)
    console.log(`${uuid} recived message`, message);
});

Leave a channel

// You can leave the channel by passing the uuid provided in join.
PubSub
  .leave('general', uuid)
  .then(() => {
    // successfully left channel
  });

Publish to a channel

PubSub
  .publish('general', {test: 'passed'})
  .then(() => {
    // message sent to all subscribers
  });

Enable cross tab communication (for web applications)

PubSub.setFlag('crossTabEnabled', true);

Enable history

PubSub.setFlag('historyEnabled', true);

Increase history limit (default 15)

PubSub.setFlag('historyLength', 30);

Get history

PubSub.history('general', 15); // Returns 15 messages from history

Example

JSFiddle.net example

3.2.1

9 years ago

3.2.0

9 years ago

3.1.8

9 years ago

3.1.2

9 years ago

3.1.1

9 years ago

3.1.0

9 years ago

3.0.6

9 years ago

3.0.5

9 years ago

3.0.4

9 years ago

3.0.3

9 years ago

3.0.2

9 years ago

3.0.1

9 years ago

3.0.0

9 years ago

2.1.7

9 years ago

2.1.6

9 years ago

2.1.5

9 years ago

2.1.4

9 years ago

2.1.3

9 years ago

2.1.2

9 years ago

2.1.1

9 years ago

2.1.0

9 years ago

2.0.1

9 years ago

2.0.0

9 years ago

0.0.1-security

10 years ago

1.0.0

10 years ago

1.0.2

12 years ago

1.0.1

12 years ago

0.0.6

12 years ago

0.0.5

12 years ago

0.0.4

12 years ago

0.0.3

12 years ago