Skip to content

lukelex/courier.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#Courier.js

Simple and flexible pub-sub for JavaScript.

##Using it

var courier = new Courier();

// subscribing to a message
courier.receive("new-message", function(msg){
  // do something with the message
  ...
});

// sending a new message
// the first parameter is the message identifier
// the second parameter can be anything
// and will just be forwarded to the receiver
courier.send("new-message", {
  your: "message"
});

// By default, an exception will be thrown if the specified
// receiver isn't found. To avoid this set throwOnMissing: false
courier.send("new-message", {
  your: "delegation"
}, {throwOnMissing: false});

// Regular Expressions can also be used as both `receiver` and
// `sender` identifiers
courier.send(/[Aa]\s(regex)?\ssender/, {
  your: "message"
});

courier.receive(/[Aa]\s(regex)?\sreceiver/, function(msg){
  ...
});

###Unsubscribe

Courier allows you to unsubscribe to any message with the given receiver returned function, like so:

var unsubscribe = courier.receive("one-time-receiver", function(msg){
  // do some work
  unsubscribe(); // this will tell courier to remove this
});

About

Simple pub-sub for JavaScript

Resources

License

Stars

Watchers

Forks

Packages

No packages published