Skip to content
StoryShelf

CaptureJobOptions

Defined in: packages/core/src/capture/orchestrator.ts:49

Inputs for running a capture job against a Storybook build.

Properties

Section titled “Properties”

db

Section titled “db”

db: DatabaseAdapter

Defined in: packages/core/src/capture/orchestrator.ts:50

design?

Section titled “design?”

optional design?: DesignProvider[]

Defined in: packages/core/src/capture/orchestrator.ts:62

Design providers validating declared design links; none ⇒ links are not extracted.

enqueue?

Section titled “enqueue?”

optional enqueue?: (job) => Promise<void>

Defined in: packages/core/src/capture/orchestrator.ts:76

Puts a job on the capture queue. Sharding needs it to hand the shards out; without it every build runs in one piece.

Parameters

Section titled “Parameters”
job
Section titled “job”

ShardJob

Returns

Section titled “Returns”

Promise<void>

limits?

Section titled “limits?”

optional limits?: ExtractionLimits

Defined in: packages/core/src/capture/orchestrator.ts:56

Entry and size caps of the zip extraction (maxZipEntries, maxUnzippedBytes); built-in defaults when unset.

logger?

Section titled “logger?”

optional logger?: Logger

Defined in: packages/core/src/capture/orchestrator.ts:58

publicOrigin?

Section titled “publicOrigin?”

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

Defined in: packages/core/src/capture/orchestrator.ts:64

The resolved public origin (ADR 0007, decision 6); targets that need a URL wait for it.

Returns

Section titled “Returns”

Promise<string | undefined>

renderTimeoutMs?

Section titled “renderTimeoutMs?”

optional renderTimeoutMs?: number

Defined in: packages/core/src/capture/orchestrator.ts:66

Render budget override (tests use a short fuse).

runner

Section titled “runner”

runner: CaptureRunner

Defined in: packages/core/src/capture/orchestrator.ts:53

scratchDir

Section titled “scratchDir”

scratchDir: string

Defined in: packages/core/src/capture/orchestrator.ts:54

secret?

Section titled “secret?”

optional secret?: SecretInput

Defined in: packages/core/src/capture/orchestrator.ts:60

Server secret for decrypting webhook secrets at send time.

shardSize?

Section titled “shardSize?”

optional shardSize?: number

Defined in: packages/core/src/capture/orchestrator.ts:71

Target captures (story x viewport x engine) per shard. Unset turns sharding off; a build of up to twice this size still runs as one shard, in this process, exactly as without sharding.

storage

Section titled “storage”

storage: StorageAdapter

Defined in: packages/core/src/capture/orchestrator.ts:52

tables

Section titled “tables”

tables: OrchestratorTables

Defined in: packages/core/src/capture/orchestrator.ts:51

viewports?

Section titled “viewports?”

optional viewports?: Viewport[]

Defined in: packages/core/src/capture/orchestrator.ts:57