@divkitframework/divkit/typings/store.d.ts

DivKit for the web

export type StoreTypes = 'string' | 'number' | 'boolean';
export type StoreAllTypes = 'string' | 'integer' | 'number' | 'boolean' | 'color' | 'url' | 'dict' | 'array';
export type StoreScope = 'global' | 'card';

export interface Store {
    /**
     * Fetches primitive from the store
     * @param name
     * @param type Expected value tpye
     * @deprecated Provide get() instead
     */
    getValue?(
        name: string,
        type: StoreTypes
    ): string | number | boolean | undefined;

    /**
     * Save primitive into the store
     * @param name
     * @param type Value type (for example, can be url)
     * @param value
     * @param lifetime Value lifetime in seconds
     * @deprecated Provide set() instead
     */
    setValue?(
        name: string,
        type: StoreTypes,
        value: string | number | boolean,
        lifetime: number
    ): void;

    /**
     * Fetches primitive from the store
     * @param name
     * @param type Expected value tpye
     * @param scope Value scope
     */
    get?(
        name: string,
        type: StoreAllTypes,
        scope?: StoreScope
    ): object | string | bigint | number | boolean | undefined;

    /**
     * Save primitive into the store
     * @param name
     * @param type Value type (for example, can be url)
     * @param value
     * @param lifetime Value lifetime in seconds
     * @param scope Value scope
     */
    set?(
        name: string,
        type: StoreAllTypes,
        value: object | string | bigint | number | boolean,
        lifetime: number,
        scope?: StoreScope
    ): void;
}