AsyncAdapterOptions
Defined in: packages/core/src/adapters/async.ts:14
Configuration options for the AsyncAdapter.
Properties
Section titled “Properties”concurrency?
Section titled “concurrency?”
optionalconcurrency:ConcurrencyStrategy
Defined in: packages/core/src/adapters/async.ts:41
The concurrency strategy to use. Defaults to 'abort'.
read()
Section titled “read()”read: () =>
Promise<void|AdapterEnvelope<unknown> |null|undefined>
Defined in: packages/core/src/adapters/async.ts:21
Function to retrieve data from the remote source.
Returns
Section titled “Returns”Promise<void | AdapterEnvelope<unknown> | null | undefined>
Should return AdapterEnvelope if the backend responds with data.
When the backend has no config stored for the user, return null or undefined.
write()
Section titled “write()”write: (
nextConfig,lastCommittedConfig,metadata,signal?) =>Promise<void|AdapterEnvelope<unknown> |null|undefined>
Defined in: packages/core/src/adapters/async.ts:33
Function to persist data to the remote source.
Parameters
Section titled “Parameters”nextConfig
Section titled “nextConfig”unknown
The new configuration object.
lastCommittedConfig
Section titled “lastCommittedConfig”unknown
The last known confirmed configuration from the server (useful for PATCH/Diffing).
metadata
Section titled “metadata”The versioning metadata.
signal?
Section titled “signal?”AbortSignal
An AbortSignal (if concurrency is set to ‘abort’).
Returns
Section titled “Returns”Promise<void | AdapterEnvelope<unknown> | null | undefined>
Should return AdapterEnvelope if the backend responds with updated data.
Otherwise, may return null or undefined.