Interface IWappStorage<T>

interface IWappStorage<T extends Record<string, unknown>> {
    id: string;
    name: string;
    entries(): [key: string, value: unknown][];
    get<K extends string | number | symbol>(name: K | K[]): unknown;
    getSecret<K extends string | number | symbol>(name: K | K[]): unknown;
    keys(): string[];
    onChange(cb: StorageChangeHandler): Promise<boolean>;
    reload(): Promise<boolean>;
    remove(name: string | string[]): Promise<boolean>;
    removeSecret(name: string | string[]): Promise<boolean>;
    reset(): Promise<void>;
    set<K extends string | number | symbol>(
        name: T | K,
        item?: unknown,
    ): Promise<boolean>;
    setSecret<K extends string | number | symbol>(
        name: T | K,
        item?: unknown,
    ): Promise<boolean>;
    update(): Promise<boolean>;
    values(): unknown[];
}

Type Parameters

  • T extends Record<string, unknown>

Implemented by

Properties

id name

Methods

entries get getSecret keys onChange reload remove removeSecret reset set setSecret update values

Properties

id

id: string

name

name: string

Methods

entries

get

  • get<K extends string | number | symbol>(name: K | K[]): unknown

    Type Parameters

    • K extends string | number | symbol

    Parameters

    • name: K | K[]

    Returns unknown

getSecret

  • getSecret<K extends string | number | symbol>(name: K | K[]): unknown

    Type Parameters

    • K extends string | number | symbol

    Parameters

    • name: K | K[]

    Returns unknown

keys

onChange

reload

remove

removeSecret

reset

set

  • set<K extends string | number | symbol>(
        name: T | K,
        item?: unknown,
    ): Promise<boolean>

    Type Parameters

    • K extends string | number | symbol

    Parameters

    • name: T | K
    • Optionalitem: unknown

    Returns Promise<boolean>

setSecret

  • setSecret<K extends string | number | symbol>(
        name: T | K,
        item?: unknown,
    ): Promise<boolean>

    Type Parameters

    • K extends string | number | symbol

    Parameters

    • name: T | K
    • Optionalitem: unknown

    Returns Promise<boolean>

update

values

Settings

Member Visibility

On This Page

Properties
Methods