Skip to content

API reference > @kontsedal/olas-persist > StorageAdapter

StorageAdapter type ​

A key-value storage backend. get, set and delete may be synchronous (localStorage) or return promises (IndexedDB). Shared by createPersisted,persistQueryCache and @kontsedal/olas-mutation-queue.

Signature:

typescript
type StorageAdapter = {
  get(key: string): string | null | Promise<string | null>;
  set(key: string, value: string): void | Promise<void>;
  delete(key: string): void | Promise<void>;
  onChange?(handler: (key: string, value: string | null) => void): () => void;
  keys?(): Iterable<string> | Promise<Iterable<string>>;
};

Released under the MIT License.