Interface Store<Value>

interface Store<Value> {
    get(key: string): undefined | Value | Promise<undefined | Value>;
    set(key: string, value: Value, ttl?: number): any;
    delete(key: string): boolean | Promise<boolean>;
    clear(): void | Promise<void>;
    has?(key: string): boolean | Promise<boolean>;
    getMany?(keys: string[]): undefined | StoredData<Value>[] | Promise<StoredData<Value>[]>;
}

Type Parameters

  • Value

Methods

get set delete clear has? getMany?

Methods

get

  • get(key): undefined | Value | Promise<undefined | Value>

  • Parameters

    • key: string

    Returns undefined | Value | Promise<undefined | Value>

set

  • set(key, value, ttl?): any

  • Parameters

    • key: string
    • value: Value
    • Optionalttl: number

    Returns any

delete

  • delete(key): boolean | Promise<boolean>

  • Parameters

    • key: string

    Returns boolean | Promise<boolean>

clear

  • clear(): void | Promise<void>

  • Returns void | Promise<void>

Optionalhas

  • has(key): boolean | Promise<boolean>

  • Parameters

    • key: string

    Returns boolean | Promise<boolean>

OptionalgetMany

Settings

Member Visibility

On This Page

Methods