StorageAdapter | /convenience/session.ts | grammy@v1.31.2

interface StorageAdapter

import { type StorageAdapter } from "https://deno.land/x/grammy@v1.31.2/convenience/session.ts";

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.

Type Parameters

Properties

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.

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

Writes a value for the given key to the storage.

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

Deletes a value for the given key from the storage.

optional

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

Checks whether a key exists in the storage.

optional

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

Lists all keys.

optional

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

Lists all values.

optional

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

Lists all keys with their values.