Skip to content

Commit

Permalink
docs: messages published as JSON (#2212)
Browse files Browse the repository at this point in the history
  • Loading branch information
JanPretzel authored and stephenplusplus committed Apr 11, 2017
1 parent cd41c31 commit 184f9bb
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions packages/pubsub/src/topic.js
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,9 @@ Topic.prototype.getSubscriptionsStream = function(options) {
* box your message in to an object with a `data` and `attributes` property.
* `data` will be the raw message value you want to publish, and
* `attributes` is a key/value pair of attributes to apply to the message.
* All messages not provided as `Buffer` will be published in JSON format.
* If your receiving end uses another library, make sure it parses the
* message properly.
* @param {object=} options - Configuration object.
* @param {boolean} options.raw - Enable if you require setting attributes on
* your messages.
Expand Down

0 comments on commit 184f9bb

Please sign in to comment.