Interface AsyncCacheProvider<K, V>

async cache provider

interface AsyncCacheProvider<K, V> {
    "[toStringTag]": string;
    size: number;
    "[iterator]"(): MapIterator<[K, Promise<V>]>;
    clear(): void;
    delete(key: K): boolean;
    entries(): MapIterator<[K, Promise<V>]>;
    forEach(
        callbackfn: (
            value: Promise<V>,
            key: K,
            map: Map<K, Promise<V>>,
        ) => void,
        thisArg?: any,
    ): void;
    get(key: K): Promise<V>;
    getOrCreate<R>(key: K, producer: GeneralFunction<any[], R>): R;
    has(key: K): boolean;
    keys(): MapIterator<K>;
    set(key: K, value: Promise<V>): this;
    values(): MapIterator<Promise<V>>;
}

Type Parameters

  • K
  • V

Hierarchy (View Summary)

Properties

[toStringTag] size

Methods

[iterator] clear delete entries forEach get getOrCreate has keys set values

Properties

Readonly[toStringTag]

"[toStringTag]": string

Readonlysize

size: number

Returns

the number of elements in the Map.

Methods

[iterator]

  • "[iterator]"(): MapIterator<[K, Promise<V>]>

  • Returns an iterable of entries in the map.

    Returns MapIterator<[K, Promise<V>]>

clear

  • clear(): void

  • Returns void

delete

  • delete(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

    true if an element in the Map existed and has been removed, or false if the element does not exist.

entries

  • entries(): MapIterator<[K, Promise<V>]>

  • Returns an iterable of key, value pairs for every entry in the map.

    Returns MapIterator<[K, Promise<V>]>

forEach

  • forEach(
        callbackfn: (value: Promise<V>, key: K, map: Map<K, Promise<V>>) => void,
        thisArg?: any,
    ): void

  • Executes a provided function once per each key/value pair in the Map, in insertion order.

    Parameters

    • callbackfn: (value: Promise<V>, key: K, map: Map<K, Promise<V>>) => void
    • OptionalthisArg: any

    Returns void

get

  • get(key: K): Promise<V>

  • Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

    Parameters

    • key: K

    Returns Promise<V>

    Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

getOrCreate

has

  • has(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

    boolean indicating whether an element with the specified key exists or not.

keys

  • keys(): MapIterator<K>

  • Returns an iterable of keys in the map

    Returns MapIterator<K>

set

  • set(key: K, value: Promise<V>): this

  • Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

    Parameters

    • key: K
    • value: Promise<V>

    Returns this

values

  • values(): MapIterator<Promise<V>>

  • Returns an iterable of values in the map

    Returns MapIterator<Promise<V>>

Settings

Member Visibility

On This Page

Properties
Methods