AsyncAdapter
Defined in: packages/core/src/adapters/async.ts:55
An adapter designed for asynchronous persistence, such as REST APIs. Includes built-in support for concurrency control (AbortController or Sequential Queue) and error handling.
It is not intended to be subclassed (though you can if you know what you’re doing).
Instead, it’s supposed to be instantiated with new AsyncAdapter(options), passing
AsyncAdapterOptions for customization.
See documentation for usage guide.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AsyncAdapter(
options):AsyncAdapter
Defined in: packages/core/src/adapters/async.ts:65
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”AsyncAdapter
Overrides
Section titled “Overrides”Methods
Section titled “Methods”read()
Section titled “read()”read():
Promise<void|AdapterEnvelope<unknown> |null|undefined>
Defined in: packages/core/src/adapters/async.ts:70
Retrieves the current settings and optional metadata from the storage medium.
Returns
Section titled “Returns”Promise<void | AdapterEnvelope<unknown> | null | undefined>
An AdapterEnvelope containing config and metadata,
or null/undefined/void if empty, depending on adapter implementation.
Overrides
Section titled “Overrides”write()
Section titled “write()”write(
nextConfig,metadata):Promise<void|AdapterEnvelope<unknown> |null|undefined>
Defined in: packages/core/src/adapters/async.ts:79
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”Promise<void | AdapterEnvelope<unknown> | null | undefined>
The saved envelope (if the backend modifies it), or void/null/undefined.