BaseAdapter
Defined in: packages/core/src/adapters/base.ts:8
Abstract base class for all storage adapters.
Implementations must handle reading and writing the AdapterEnvelope to a persistence layer.
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BaseAdapter():
BaseAdapter
Returns
Section titled “Returns”BaseAdapter
Methods
Section titled “Methods”read()
Section titled “read()”
abstractread():void|AdapterEnvelope<unknown> |Promise<void|AdapterEnvelope<unknown> |null|undefined> |null|undefined
Defined in: packages/core/src/adapters/base.ts:15
Retrieves the current settings and optional metadata from the storage medium.
Returns
Section titled “Returns”void | AdapterEnvelope<unknown> | Promise<void | AdapterEnvelope<unknown> | null | undefined> | null | undefined
An AdapterEnvelope containing config and metadata,
or null/undefined/void if empty, depending on adapter implementation.
write()
Section titled “write()”
abstractwrite(nextConfig,metadata):void|AdapterEnvelope<unknown> |Promise<void|AdapterEnvelope<unknown> |null|undefined> |null|undefined
Defined in: packages/core/src/adapters/base.ts:29
Persists changes to the storage medium.
Parameters
Section titled “Parameters”nextConfig
Section titled “nextConfig”unknown
The full settings object to be saved.
metadata
Section titled “metadata”The opaque metadata (e.g. dataVersion) from the Manager.
Returns
Section titled “Returns”void | AdapterEnvelope<unknown> | Promise<void | AdapterEnvelope<unknown> | null | undefined> | null | undefined
The saved envelope (if the backend modifies it), or void/null/undefined.