Hopiu/postal.js
1
0
Fork 0
mirror of https://github.com/Hopiu/postal.js.git synced 2026-03-16 22:20:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

README Updates

Browse source
This commit is contained in:
Jim Cowart 2012-03-22 01:37:20 -04:00
parent 1f8bf876e2
commit 3e01e81040
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -69,10 +69,14 @@ var starChannel = postal.channel( { channel: "Doctor.Who", topic: "DrWho.*.Chang
$( '<li>' + data.type + " Changed: " + data.value + '</li>' ).appendTo( "#example3" );
});
/*
demonstrating how we're re-using the channel delcared above to publish, but overriding the topic in the second argument
note to override the topic, you have to use the "envelope" structure, which means an object like:
{ channel: "myChannel", topic: "myTopic", data: { someProp: "SomeVal, moarData: "MoarValue" } };
The only thing to note is that since we are publishing from a channel definition, you don't need to pass "channel" (in fact, it would be ignored)
Demonstrating how we're re-using the channel delcared above to publish, but overriding the topic
in the second argument. Note to override the topic, you have to use the "envelope" structure,
which means an object like:
{ channel: "myChannel", topic: "myTopic", data: { someProp: "SomeVal, moarData: "MoarValue" } };
The only thing to note is that since we are publishing from a channel definition, you don't need
to pass "channel" (in fact, it would be ignored)
*/
starChannel.publish( { topic: "DrWho.NinthDoctor.Companion.Changed", data: { type: "Name", value:"Rose" } } );
starChannel.publish( { topic: "DrWho.TenthDoctor.Companion.Changed", data: { type: "Name", value:"Martha" } } );