CaptureQueue
Defined in: packages/core/src/adapters/capture-queue.ts:73
A capture job queue, decoupled from the runtime.
enqueue submits a build for capture and returns quickly; the build is
tracked as “queued”. The capture itself runs in a worker:
- the in-memory implementation (
InMemoryCaptureQueue, incapture/capture-queue.ts) runs the job in-process on a long-lived Node server; - a remote implementation (e.g. SQS, Cloudflare Queues, Azure Storage
Queues) pushes the job and leaves execution to a separately-assembled
worker that polls the queue and runs
executeCaptureJob.
status/active/recent back the live queue view regardless of transport.
Extends
Section titled “Extends”Adapter<{category:"capture-queue"; }>
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”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[]>
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>
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>
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[]>
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>