mirror of
https://github.com/Hopiu/postal.js.git
synced 2026-04-22 23:54:50 +00:00
Updating README
This commit is contained in:
parent
3441008c1f
commit
d80554aeba
3 changed files with 6 additions and 4 deletions
|
|
@ -126,7 +126,7 @@ There are four main ways you can extend Postal:
|
|||
* Write a plugin. Need more complex behavior that the built-in SubscriptionDefinition doesn't offer? Write a plugin that you can attach to the global postal object. See [postal.when](https://github.com/ifandelse/postal.when) for an example of how to do this.
|
||||
* Write a custom channel implementation for postal. The `postal.channelTypes` namespace can contain as many channel types as you wish. See the [postal.socket](https://github.com/ifandelse/postal.socket) proof-of-concept plugin for an example of a custom channel that could be applicable in both the browser and node.js (a full production worthy version of this plugin is already in the works). Other custom channels specific to environments like node.js could be considered as well (ex - a bridge to redis pub/sub, AMQP/RabbitMQ, etc.).
|
||||
* You can write an entirely new bus implementation if you wanted. The postal `subscribe`, `publish` and `addWiretap` calls all simply wrap a concrete implementation provided by the `postal.configuration.bus` object. For example, if you wanted a bus that stored message history in local storage and pushed a dump of past messages to a new subscriber, you'd simply write your implementation and then swap the default one out by calling: `postal.configuration.bus = myWayBetterBusImplementation`.
|
||||
* You can also change how the `bindingResolver` matches subscriptions to message topics being published. You may not care for the RabbitMQ-style bindings functionality. No problem! Write your own resolver object that implements a `compare` and `reset` method and swap the core version out with your implementation by calling: `postal.configuration.resolver = myWayBetterResolver`.
|
||||
* You can also change how the `bindingResolver` matches subscriptions to message topics being published. You may not care for the inverted RabbitMQ-style bindings functionality (postal currently inverts the treatment of asterisk and hash wildcard symbols compared to AMQP). No problem! Write your own resolver object that implements a `compare` and `reset` method and swap the core version out with your implementation by calling: `postal.configuration.resolver = myWayBetterResolver`.
|
||||
|
||||
It's also possible to extend the monitoring of messages passing through Postal by adding a "wire tap". A wire tap is a callback that will get invoked for any published message (even if no actual subscriptions would bind to the message's topic). Wire taps should _not_ be used in lieu of an actual subscription - but instead should be used for diagnostics, logging, forwarding (to a websocket publisher or a local storage wrapper, for example) or other concerns that fall along those lines. This repository includes a console logging wiretap called postal.diagnostics.js. This diagnostics wiretap can be configured with filters to limit the firehose of message data to specific channels/topics and more.
|
||||
|
||||
|
|
@ -136,6 +136,7 @@ Please - by all means! While I hope the API is relatively stable, I'm open to p
|
|||
## Roadmap for the Future
|
||||
Here's where Postal is headed:
|
||||
|
||||
* The default binding resolver will be changed in v0.7.0 to match AMQP binding conventions exactly.
|
||||
* Add-ons to enable message capture and replay are in the works and should be ready soon.
|
||||
* The `SubscriptionDefinition` object will be given the ability to pause (skip) responding to subscriptions
|
||||
* What else would you like to see?
|
||||
|
|
@ -21,6 +21,7 @@ define( [
|
|||
self.navigate( $( this ).attr( 'href' ), { trigger : true } );
|
||||
} );
|
||||
bus.router.publish( "initialized" );
|
||||
|
||||
},
|
||||
|
||||
activateUI : function ( uiName, context ) {
|
||||
|
|
|
|||
|
|
@ -9,18 +9,18 @@
|
|||
},
|
||||
"author" : {
|
||||
"name" : "Jim Cowart",
|
||||
"email" : "jim@ifandelse.com",
|
||||
"email" : "WhyNotJustComment@OnMyBlog.com",
|
||||
"url" : "http://freshbrewedcode.com/jimcowart"
|
||||
},
|
||||
"contributors": [
|
||||
{
|
||||
"name" : "Jim Cowart",
|
||||
"email" : "jim@ifandelse.com",
|
||||
"email" : "WhyNotJustComment@OnMyBlog.com",
|
||||
"url" : "http://freshbrewedcode.com/jimcowart"
|
||||
}
|
||||
],
|
||||
"bugs" : {
|
||||
"email" : "jim@ifandelse.com",
|
||||
"email" : "PleaseJustUseTheIssuesPage@github.com",
|
||||
"url" : "http://github.com/ifandelse/postal.js/issues"
|
||||
},
|
||||
"directories" : { "lib" : "./" },
|
||||
|
|
|
|||
Loading…
Reference in a new issue