LocalStorageAdapter
Defined in: packages/core/src/adapters/local-storage.ts:21
A synchronous adapter for persistence to the browser’s LocalStorage.
It wraps the data in an envelope { config: ..., metadata: ... }
to support versioning and other metadata.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LocalStorageAdapter(
options?):LocalStorageAdapter
Defined in: packages/core/src/adapters/local-storage.ts:24
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”LocalStorageAdapter
Overrides
Section titled “Overrides”Properties
Section titled “Properties”key:
string='@lolmaus/config-store'
Defined in: packages/core/src/adapters/local-storage.ts:22
Methods
Section titled “Methods”read()
Section titled “read()”read():
void|AdapterEnvelope<unknown>
Defined in: packages/core/src/adapters/local-storage.ts:30
Retrieves the current settings and optional metadata from the storage medium.
Returns
Section titled “Returns”void | AdapterEnvelope<unknown>
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):void|AdapterEnvelope<unknown>
Defined in: packages/core/src/adapters/local-storage.ts:48
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>
The saved envelope (if the backend modifies it), or void/null/undefined.