BuildStateDeps
Defined in: packages/core/src/capture/build-state/types.ts:13
What delivering a build’s state needs.
Properties
Section titled “Properties”config
Section titled “config”config:
Pick<ShelfConfig,"publishedBaseDomain">
Defined in: packages/core/src/capture/build-state/types.ts:22
The published-Storybook domain for Storybook links.
db:
DatabaseAdapter
Defined in: packages/core/src/capture/build-state/types.ts:14
flags: (
project) =>BuildStateFlags
Defined in: packages/core/src/capture/build-state/types.ts:29
Which statuses a project’s builds show: testing from the server options, review from the project.
Parameters
Section titled “Parameters”project
Section titled “project”Returns
Section titled “Returns”logger
Section titled “logger”logger:
Logger
Defined in: packages/core/src/capture/build-state/types.ts:30
notifiers
Section titled “notifiers”notifiers: readonly
NotifierProvider[]
Defined in: packages/core/src/capture/build-state/types.ts:18
Notifier providers; only the state ones (git hosts) take part.
publicOrigin
Section titled “publicOrigin”publicOrigin: () =>
Promise<string|undefined>
Defined in: packages/core/src/capture/build-state/types.ts:27
The resolved public origin (ADR 0007, decision 6): the origin every link starts with. While it resolves to nothing, no state is requested or delivered (ADR 0014, decision 11).
Returns
Section titled “Returns”Promise<string | undefined>
secret
Section titled “secret”secret:
SecretInput
Defined in: packages/core/src/capture/build-state/types.ts:20
Server secret that decrypts channel tokens.
storage?
Section titled “storage?”
optionalstorage?:StorageAdapter
Defined in: packages/core/src/capture/build-state/types.ts:16
Read to tell whether the build’s Storybook is published; without it publishing reads as pending.