StorageAdapter

^{ref / core / StorageAdapter}

A storage adapter is an abstraction that provides read, write, and delete access to a storage solution of any kind. Storage adapters are used to keep session middleware independent of your database provider, and they allow you to pass your own storage solution.

^Source

Properties

read

read: (key: string) => MaybePromise<T | undefined>;

Reads a value for the given key from the storage. May return the value or undefined, or a promise of either.

^Source

write

write: (key: string, value: T) => MaybePromise<void>;

Writes a value for the given key to the storage.

^Source

delete

delete: (key: string) => MaybePromise<void>;

Deletes a value for the given key from the storage.

^Source

has

has?: (key: string) => MaybePromise<boolean>;

Checks whether a key exists in the storage.

^Source

readAllKeys

readAllKeys?: () => Iterable<string> | AsyncIterable<string>;

Lists all keys.

^Source

readAllValues

readAllValues?: () => Iterable<T> | AsyncIterable<T>;

Lists all values.

^Source

readAllEntries

readAllEntries?: () => Iterable<[string, T]> | AsyncIterable<[string, T]>;

Lists all keys with their values.

^Source