Skip to content

Add callback documentation to some pubsub methods. #646

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

Closed
jgeewax wants to merge 1 commit into from
Closed

Add callback documentation to some pubsub methods. #646

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
11 changes: 11 additions & 0 deletions lib/pubsub/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,10 @@ function PubSub(options) {
* @param {string=} query.pageToken - Page token.
* @param {number=} query.pageSize - Max number of results to return.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error from the API call, may be null.
* @param {module:pubsub/topic[]} callback.topics - The list of topics returned.
* @param {object} callback.nextQuery - A query object representing the next page of topics.
* @param {object} callback.apiResponse - The full API response from the service.
*
* @example
* // Get all topics.
Expand Down Expand Up @@ -143,6 +147,9 @@ PubSub.prototype.getTopics = function(query, callback) {
*
* @param {string} name - Name of the topic.
* @param {function=} callback - The callback function.
* @param {?error} callback.err - An error from the API call, may be null.
* @param {module:pubsub/topic} callback.topic - The newly created topic.
* @param {object} callback.apiResponse - The full API response from the service.
*
* @example
* pubsub.createTopic('my-new-topic', function(err, topic, apiResponse) {
Expand Down Expand Up @@ -199,6 +206,10 @@ PubSub.prototype.topic = function(name, options) {
* @param {string=} query.pageToken - Page token.
* @param {number=} query.pageSize - Maximum number of results to return.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error from the API call, may be null.
* @param {module:pubsub/subscription[]} callback.subscriptions - The list of subscriptions returned.
* @param {object} callback.nextQuery - A query object representing the next page of topics.
* @param {object} callback.apiResponse - The full API response from the service.
*
* @example
* var callback = function(err, subscriptions, nextQuery, apiResponse) {
Expand Down