CaptureConsumerOptions

Defined in: packages/core/src/capture/consumer/types.ts:59

Options of createCaptureConsumer.

Properties

cadence?

optional cadence?: PollCadence

Defined in: packages/core/src/capture/consumer/types.ts:83

Poll cadence of the database queue (default ADR 0006’s).

---

capture?

optional capture?: Omit<CaptureHandlerOptions, "enqueue" | "logger"> & Partial<Pick<CaptureHandlerOptions, "enqueue">>

Defined in: packages/core/src/capture/consumer/types.ts:63

Capture jobs: wires the capture kind to the core dispatch (shorthand for handlers.capture).

---

compare?

optional compare?: ShelfCompareOptions

Defined in: packages/core/src/capture/consumer/types.ts:73

Diff pool size, as the server’s compare option.

---

config?

optional config?: ConsumerConfig

Defined in: packages/core/src/capture/consumer/types.ts:67

---

handlers?

optional handlers?: Partial<Record<CaptureJobKind, KindHandler | ((job, context) => Promise<void>) | undefined>>

Defined in: packages/core/src/capture/consumer/types.ts:66

Handlers by kind; publish and notify register here. Overrides capture’s.

---

images?

optional images?: ShelfImagesOptions

Defined in: packages/core/src/capture/consumer/types.ts:71

Image engine, as the server’s images option; start() fails when it cannot load.

---

lease?

optional lease?: object

Defined in: packages/core/src/capture/consumer/types.ts:86

Lease renewal throttle and state-check interval overrides (tests).

checkMs?

optional checkMs?: number

renewEveryMs?

optional renewEveryMs?: number

---

logger?

optional logger?: Logger

Defined in: packages/core/src/capture/consumer/types.ts:78

---

metrics?

optional metrics?: ConsumerMetrics

Defined in: packages/core/src/capture/consumer/types.ts:77

Optional observation hooks; core does not depend on any metrics library.

---

now?

optional now?: () => number

Defined in: packages/core/src/capture/consumer/types.ts:80

Clock and timers (tests inject a manual clock).

Returns

number

---

onProgress?

optional onProgress?: (job) => void

Defined in: packages/core/src/capture/consumer/types.ts:75

Called whenever a running job makes progress (the forked child reports it to its parent).

Parameters

job

ConsumerJob

Returns

void

---

queue

queue: PollableCaptureQueue

Defined in: packages/core/src/capture/consumer/types.ts:61

Queue to consume: the database queue, or the IPC queue of a forked child.

---

random?

optional random?: () => number

Defined in: packages/core/src/capture/consumer/types.ts:84

Returns

number

---

scratchDir?

optional scratchDir?: string

Defined in: packages/core/src/capture/consumer/types.ts:69

Scratch directory swept at start; defaults to capture.scratchDir.

---

timers?

optional timers?: QueueTimers

Defined in: packages/core/src/capture/consumer/types.ts:81