Repository navigation
Update pubsub.Subscription.ack()'s docstring to say the ID is explicitly an ackId #518
Copy link
Copy link
Closed
Labels
api: pubsubIssues related to the Pub/Sub API.Issues related to the Pub/Sub API.type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Milestone
Description
Activity
- addedtype: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.Error or flaw in code with unintended results or allowing sub-optimal usage patterns.api: pubsubIssues related to the Pub/Sub API.Issues related to the Pub/Sub API.
on May 1, 2015 Simple enough. I will change this today.
Style I was thinking was
@param {string|string[]} ids - A single or multiple message acknowledgement IDs.but feel free to write whatever.Just want to make it clear that a Message itself doesn't have an ID we care about. Instead a
ReceivedMessagehas an acknowledgement ID (ackId) which you pass around.Yeah I'll come up with something. I understand the confusion.
10 remaining items
- added a commit that references this issue
on Feb 3, 2026 - added a commit that references this issue
on Feb 3, 2026 - added a commit that references this issue
on Feb 5, 2026 - added a commit that references this issue
on Feb 5, 2026 - added a commit that references this issue
on Feb 17, 2026 - added a commit that references this issue
on Feb 23, 2026 - added a commit that references this issue
on Feb 26, 2026 - added a commit that references this issue
on Mar 12, 2026 - added a commit that references this issue
on Mar 18, 2026 - added 2 commits that reference this issue
on Mar 23, 2026 - added a commit that references this issue
on Mar 27, 2026 - added a commit that references this issue
on May 5, 2026
Metadata
Metadata
Assignees
Labels
api: pubsubIssues related to the Pub/Sub API.Issues related to the Pub/Sub API.type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
@pierre-b wrote in #487:
At first I thought we had this right, but it seems like the
messageIdmight not be the same as theackId(see RecievedMessage which says "ackId: This ID can be used to acknowledge the received message.")Note: I still think we should call the parameter "ids", but that we should update the docstring.
On https://github.com/GoogleCloudPlatform/gcloud-node/blob/686fe62e7103f80dc053417e08c13abfc501f67f/lib/pubsub/subscription.js#L250