HandlerContext
Defined in: packages/pubsub/src/types.ts:281
Handler context used to explicitly control delivery disposition.
Properties
Section titled “Properties”attempt
Section titled “attempt”
readonlyattempt:number
Defined in: packages/pubsub/src/types.ts:285
One-based delivery attempt count reported by the transport.
contextValues
Section titled “contextValues”
readonlycontextValues:ContextValues
Defined in: packages/pubsub/src/types.ts:287
Context values for passing data between interceptors and handlers.
readonlyevent:CloudEvent
Defined in: packages/pubsub/src/types.ts:283
The raw CloudEvent currently being handled.
Methods
Section titled “Methods”ack():
Promise<void>
Defined in: packages/pubsub/src/types.ts:289
Mark the delivery as successfully processed.
Returns
Section titled “Returns”Promise<void>
deadLetter()
Section titled “deadLetter()”deadLetter():
Promise<void>
Defined in: packages/pubsub/src/types.ts:293
Send the delivery to a dead-letter path.
Returns
Section titled “Returns”Promise<void>
reject()
Section titled “reject()”reject():
Promise<void>
Defined in: packages/pubsub/src/types.ts:295
Reject the delivery as invalid input or unsupported data.
Returns
Section titled “Returns”Promise<void>
retry()
Section titled “retry()”retry(
options?):Promise<void>
Defined in: packages/pubsub/src/types.ts:291
Request a retry, optionally delayed durably by the transport.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<void>