DatabaseCaptureQueue
Defined in: packages/core/src/capture/db-queue/types.ts:73
The database queue: a PollableCaptureQueue plus multi-kind enqueue and a local wake.
Extends
Section titled “Extends”Properties
Section titled “Properties”lifecycle
Section titled “lifecycle”
readonlylifecycle:AdapterLifecycle
Defined in: packages/core/src/capture/db-queue/types.ts:74
Optional lifecycle hooks.
Overrides
Section titled “Overrides”PollableCaptureQueue.lifecycle
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>
Inherited from
Section titled “Inherited from”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()”cancel(
id):Promise<boolean>
Defined in: packages/core/src/capture/db-queue/types.ts:80
Cancel a job by job id, or every unfinished job of a build (every kind) by build id.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
Overrides
Section titled “Overrides”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”enqueueJob()
Section titled “enqueueJob()”enqueueJob(
job):Promise<string>
Defined in: packages/core/src/capture/db-queue/types.ts:78
Put a job of any kind on the queue; resolves to its job id.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<string>
extend()
Section titled “extend()”extend(
job):Promise<LeaseRenewal>
Defined in: packages/core/src/capture/db-queue/types.ts:76
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>
Overrides
Section titled “Overrides”inspect()
Section titled “inspect()”inspect(
job):Promise<LeaseRenewal>
Defined in: packages/core/src/capture/db-queue/types.ts:82
Read the job’s state without renewing its lease (the 5 s cancel check).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<LeaseRenewal>
Overrides
Section titled “Overrides”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>
Inherited from
Section titled “Inherited from”poll()
Section titled “poll()”poll(
options?):Promise<DatabaseJob|null>
Defined in: packages/core/src/capture/db-queue/types.ts:75
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<DatabaseJob | null>
Overrides
Section titled “Overrides”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”PollableCaptureQueue.setLogger
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>
Inherited from
Section titled “Inherited from”waitForWork()
Section titled “waitForWork()”waitForWork(
ms):Promise<boolean>
Defined in: packages/core/src/capture/db-queue/types.ts:87
Resolve true when this instance enqueues a job (including one enqueued since the last poll
began, so no wake-up is lost), false after ms.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<boolean>