CaptureHandlerOptions

Defined in: packages/core/src/capture/consumer/capture-handler.ts:20

What the capture handler needs: the same adapters the server’s own capture setup uses.

Properties

buildState?

optional buildState?: BuildStatePublisher

Defined in: packages/core/src/capture/consumer/capture-handler.ts:37

Shows a build’s state on its git channels at every transition. Default: deliver inline through notifiers (a capture always has testing on); the app passes its queue-backed publisher.

config?

optional config?: Pick<ShelfConfig, "publicBaseUrl" | "publishedBaseDomain" | "maxZipEntries" | "maxUnzippedBytes">

Defined in: packages/core/src/capture/consumer/capture-handler.ts:39

Links in statuses are absolute from publicBaseUrl; published Storybooks use publishedBaseDomain.

db

db: DatabaseAdapter

Defined in: packages/core/src/capture/consumer/capture-handler.ts:22

Database adapter; its own tables are used (never a dialect’s defaults).

design?

optional design?: DesignProvider[]

Defined in: packages/core/src/capture/consumer/capture-handler.ts:49

Design providers validating declared design links during capture.

enqueue

enqueue: (job) => Promise<void>

Defined in: packages/core/src/capture/consumer/capture-handler.ts:30

Puts a shard job on the queue; sharding needs it. Defaults to the consumed queue’s enqueue.

Parameters

job

ShardJob

Returns

Promise<void>

logger

logger: Logger

Defined in: packages/core/src/capture/consumer/capture-handler.ts:28

maxRetries?

optional maxRetries?: number

Defined in: packages/core/src/capture/consumer/capture-handler.ts:56

Retries assumed for jobs that do not state maxAttempts (default 2).

notifiers?

optional notifiers?: NotifierProvider[]

Defined in: packages/core/src/capture/consumer/capture-handler.ts:32

Notifier providers; state channels (git hosts) get the build statuses.

publicOrigin?

optional publicOrigin?: () => Promise<string | undefined>

Defined in: packages/core/src/capture/consumer/capture-handler.ts:47

The resolved public origin (ADR 0007, decision 6): status links and URL-reaching targets use it. Default: config.publicBaseUrl, then the platform’s address, then the origin an admin stored.