@promptbook/remote-server/esm/src/storage/_common/PromptbookStorage.d.ts

Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action

import type { Promisable } from 'type-fest';
/**
 * Storage of objects with asynchronous API
 *
 * Note: Naming `PromptbookStorage` not `Storage` to avoid name collision with global `Storage` interface.
 * Note: This is similar to Web Storage API interface but everything is asynchronous and can store JSON objects.
 */
export type PromptbookStorage<TItem> = {
    /**
     * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object
     */
    getItem(key: string): Promisable<TItem | null>;
    /**
     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously
     */
    setItem(key: string, value: TItem): Promisable<void>;
    /**
     * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists
     */
    removeItem(key: string): Promisable<void>;
};