PollableCaptureQueue
Defined in: packages/core/src/adapters/capture-queue.ts:91
Extension for queues that support worker-side polling.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Properties
Section titled “Properties”lifecycle?
Section titled “lifecycle?”
readonlyoptionallifecycle?:AdapterLifecycle
Defined in: packages/core/src/adapters/metadata.ts:84
Optional lifecycle hooks.
Inherited from
Section titled “Inherited from”metadata
Section titled “metadata”
readonlymetadata:AdapterMetadata&object
Defined in: packages/core/src/adapters/metadata.ts:82
Adapter identity (mandatory).
Type Declaration
Section titled “Type Declaration”category
Section titled “category”
readonlycategory:"capture-queue"
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”ack(
job):Promise<void>
Defined in: packages/core/src/adapters/capture-queue.ts:95
Acknowledge successful processing of a polled job.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
active()
Section titled “active()”active():
Promise<QueueEntry[]>
Defined in: packages/core/src/adapters/capture-queue.ts:79
Queue entries that are queued or running.
Returns
Section titled “Returns”Promise<QueueEntry[]>
Inherited from
Section titled “Inherited from”cancel()?
Section titled “cancel()?”
optionalcancel(id):Promise<boolean>
Defined in: packages/core/src/adapters/capture-queue.ts:87
Cancel by job id, or every unfinished job of a build by build id (every job kind of the build on the database queue). Optional. A job that has not
started ends cancelled at once; a running one is flagged, and its holder sees "cancelled"
from extend/inspect. Resolves true when anything matched.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
Inherited from
Section titled “Inherited from”enqueue()
Section titled “enqueue()”enqueue(
job):Promise<void>
Defined in: packages/core/src/adapters/capture-queue.ts:75
Submit a build for capture. Resolves once the build is queued.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”extend()?
Section titled “extend()?”
optionalextend(job):Promise<LeaseRenewal>
Defined in: packages/core/src/adapters/capture-queue.ts:111
Extend the lease on an in-flight job by another job.leaseMs. Optional:
queues without a renewable lease (e.g. Redis) omit it. May update
job.receipt in place when the transport rotates it. Resolves "lost"
only when the transport conclusively reports the message is no longer
owned by this consumer; transient failures must reject.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<LeaseRenewal>
inspect()?
Section titled “inspect()?”
optionalinspect(job):Promise<LeaseRenewal>
Defined in: packages/core/src/adapters/capture-queue.ts:116
Read the job’s state without renewing its lease: the holder’s periodic cancel check.
Optional; same outcomes as extend.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<LeaseRenewal>
nack()
Section titled “nack()”nack(
job,options?):Promise<void>
Defined in: packages/core/src/adapters/capture-queue.ts:100
Negatively acknowledge; requeue with optional delay when possible. requeue: false is a final
failure: the job is dropped, and error says why for queues that keep a record of it.
Parameters
Section titled “Parameters”options?
Section titled “options?”delayMs?
Section titled “delayMs?”number
error?
Section titled “error?”string
requeue?
Section titled “requeue?”boolean
Returns
Section titled “Returns”Promise<void>
poll()
Section titled “poll()”poll(
options?):Promise<PollableJob|null>
Defined in: packages/core/src/adapters/capture-queue.ts:93
Poll for a single job; returns null if none available within waitMs.
Parameters
Section titled “Parameters”options?
Section titled “options?”waitMs?
Section titled “waitMs?”number
Returns
Section titled “Returns”Promise<PollableJob | null>
recent()
Section titled “recent()”recent(
limit):Promise<QueueEntry[]>
Defined in: packages/core/src/adapters/capture-queue.ts:81
The most recent queue entries, newest first.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<QueueEntry[]>
Inherited from
Section titled “Inherited from”setLogger()?
Section titled “setLogger()?”
optionalsetLogger(logger):void
Defined in: packages/core/src/adapters/metadata.ts:90
Bind the host-owned runtime logger. Called by the app/worker when
present; factories must never create their own loggers — they only
store what they are given (explicit options.logger wins over bound).
Parameters
Section titled “Parameters”logger
Section titled “logger”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”status()
Section titled “status()”status(
buildId):Promise<QueueEntry|null>
Defined in: packages/core/src/adapters/capture-queue.ts:77
Return the current status entry for a build, or null if untracked.
Parameters
Section titled “Parameters”buildId
Section titled “buildId”string
Returns
Section titled “Returns”Promise<QueueEntry | null>