KindHandler
Defined in: packages/core/src/capture/consumer/types.ts:34
The code that runs jobs of one kind.
Extended by
Section titled “Extended by”Properties
Section titled “Properties”backoff?
Section titled “backoff?”
optionalbackoff?:object
Defined in: packages/core/src/capture/consumer/types.ts:40
Retry delay of this kind: baseMs * 2^n capped at maxMs; defaults to the consumer’s.
baseMs
Section titled “baseMs”baseMs:
number
maxMs:
number
Methods
Section titled “Methods”accepts()?
Section titled “accepts()?”
optionalaccepts(job):boolean
Defined in: packages/core/src/capture/consumer/types.ts:38
Whether the job is well-formed; a job that is not is failed without retries.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
cancel()?
Section titled “cancel()?”
optionalcancel(job):Promise<void>
Defined in: packages/core/src/capture/consumer/types.ts:42
Stop a running job (lease lost or cancelled); must tolerate a job that already ended.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
run(
job,context):Promise<void>
Defined in: packages/core/src/capture/consumer/types.ts:36
Run the job; resolve to ack it, reject to retry (or fail it on its last attempt).
Parameters
Section titled “Parameters”context
Section titled “context”Returns
Section titled “Returns”Promise<void>