Skip to content

pubsub: publicly document publisher options #2570

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.

Sign up for GitHub

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

Merged
stephenplusplus merged 1 commit into from
Aug 27, 2017
Merged

pubsub: publicly document publisher options #2570

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 9 additions & 8 deletions packages/pubsub/src/publisher.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,6 @@ var is = require('is');
*
* @param {module:pubsub/topic} topic - The topic associated with this
* publisher.
* @param {object=} options - Configuration object.
* @param {object} options.batching - Batching settings.
* @param {number} options.batching.maxBytes - The maximum number of bytes to
* buffer before sending a payload.
* @param {number} options.batching.maxMessages - The maximum number of messages
* to buffer before sending a payload.
* @param {number} options.batching.maxMilliseconds - The maximum duration to
* wait before sending a payload.
*/
/**
* A Publisher object allows you to publish messages to a specific topic.
Expand All @@ -47,6 +39,15 @@ var is = require('is');
*
* @resource [Topics: publish API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/publish}
*
* @param {object=} options - Configuration object.
* @param {object} options.batching - Batching settings.
* @param {number} options.batching.maxBytes - The maximum number of bytes to
* buffer before sending a payload.
* @param {number} options.batching.maxMessages - The maximum number of messages
* to buffer before sending a payload.
* @param {number} options.batching.maxMilliseconds - The maximum duration to
* wait before sending a payload.
*
* @example
* var topic = pubsub.topic('my-topic');
* var publisher = topic.publisher();
Expand Down