Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: messages published as JSON #2212

Merged
merged 1 commit into from
Apr 11, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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