Phials developer documentation
User guide
AI Notice: Most documentation right now was auto-generated by an LLM. Handwritten documentation will be implemented over time on the road to 1.0

PluginStorageAPI

Key/value storage API for plugin data (separate from settings)

Signature

interface PluginStorageAPI {
    get<T>(key: string): Promise<T | null>;
    set(key: string, value: unknown): Promise<void>;
    delete(key: string): Promise<void>;
    keys(): Promise<string[]>;
    clear(): Promise<void>;
}

Members

NameTypeRequiredDescription
get(key: string) => Promise<T | null>yesGet a value by key
set(key: string, value: unknown) => Promise<void>yesSet a value by key
delete(key: string) => Promise<void>yesDelete a value by key
keys() => Promise<string[]>yesGet all keys for this plugin
clear() => Promise<void>yesClear all data for this plugin