StorageAdapter
Defined in: packages/core/src/adapters/storage.ts:9
Blob storage abstraction for screenshots, diffs and Storybook archives.
Extends
Section titled “Extends”Adapter<{category:"storage"; }>
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:"storage"
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”delete()
Section titled “delete()”delete(
path):Promise<void>
Defined in: packages/core/src/adapters/storage.ts:15
Delete the object at path if it exists.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
exists()
Section titled “exists()”exists(
path):Promise<boolean>
Defined in: packages/core/src/adapters/storage.ts:17
Return whether an object exists at path.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
list()
Section titled “list()”list(
prefix):Promise<string[]>
Defined in: packages/core/src/adapters/storage.ts:19
List object paths under the given key prefix.
Parameters
Section titled “Parameters”prefix
Section titled “prefix”string
Returns
Section titled “Returns”Promise<string[]>
read()
Section titled “read()”read(
path):Promise<Buffer<ArrayBufferLike>>
Defined in: packages/core/src/adapters/storage.ts:11
Read the bytes stored at path.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Buffer<ArrayBufferLike>>
readStream()
Section titled “readStream()”readStream(
path):Promise<Readable>
Defined in: packages/core/src/adapters/storage.ts:29
Open a stream for the bytes stored at path.
Rejects when no object exists at path.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Readable>
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”write()
Section titled “write()”write(
path,data):Promise<void>
Defined in: packages/core/src/adapters/storage.ts:13
Write data to path, creating parent directories as needed.
Parameters
Section titled “Parameters”string
Buffer
Returns
Section titled “Returns”Promise<void>
writeStream()
Section titled “writeStream()”writeStream(
path,stream):Promise<void>
Defined in: packages/core/src/adapters/storage.ts:24
Stream stream to path, creating parent directories as needed.
Resolves when the stream is fully consumed and persisted.
Parameters
Section titled “Parameters”string
stream
Section titled “stream”Readable
Returns
Section titled “Returns”Promise<void>