Interface ReactiveMap<TKey, TValue>

A reactive map inherited from Map. Changes to the map will be notified to subscribers of map.$.

interface ReactiveMap<TKey, TValue> {
    $: ReadonlyVal<ReactiveMap<TKey, TValue>>;
    [toStringTag]: string;
    size: number;
    [iterator](): IterableIterator<[TKey, TValue]>;
    batchDelete(keys): boolean;
    batchSet(entries): this;
    clear(): void;
    delete(key): boolean;
    dispose(): void;
    entries(): IterableIterator<[TKey, TValue]>;
    forEach(callbackfn, thisArg?): void;
    get(key): undefined | TValue;
    has(key): boolean;
    keys(): IterableIterator<TKey>;
    rename(oldKey, newKey): boolean;
    replace(entries): Iterable<TValue>;
    set(key, value): this;
    toJSON(): object;
    values(): IterableIterator<TValue>;
}

Type Parameters

  • TKey
  • TValue

Hierarchy

Properties

$ [toStringTag] size

Methods

[iterator] batchDelete batchSet clear delete dispose entries forEach get has keys rename replace set toJSON values

Properties

Readonly $

$: ReadonlyVal<ReactiveMap<TKey, TValue>>

A readonly val with value of this.

To update the entire reactive map in place, use map.replace().

Readonly [toStringTag]

[toStringTag]: string

Readonly size

size: number

Returns

the number of elements in the Map.

Methods

[iterator]

  • [iterator](): IterableIterator<[TKey, TValue]>

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[TKey, TValue]>

batchDelete

  • batchDelete(keys): boolean

  • Delete multiple entries from the Map.

    Parameters

    • keys: Iterable<TKey>

    Returns boolean

batchSet

clear

  • clear(): void

  • Returns void

delete

  • delete(key): boolean

  • Parameters

    Returns boolean

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

dispose

entries

  • entries(): IterableIterator<[TKey, TValue]>

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

    Returns IterableIterator<[TKey, TValue]>

forEach

  • forEach(callbackfn, thisArg?): void

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

    Parameters

    • callbackfn: ((value, key, map) => void)
    • Optional thisArg: any

    Returns void

get

  • get(key): undefined | TValue

  • 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

    Returns undefined | TValue

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

has

  • has(key): boolean

  • Parameters

    Returns boolean

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

keys

  • keys(): IterableIterator<TKey>

  • Returns an iterable of keys in the map

    Returns IterableIterator<TKey>

rename

  • rename(oldKey, newKey): boolean

  • Rename a key in the Map. Will not trigger onDeleted callback for the old key.

    If the oldKey does not exist, this method does nothing. If the newKey already exists, it will be overwritten.

    Parameters

    Returns boolean

    true if oldKey exists.

replace

  • replace(entries): Iterable<TValue>

  • Replace all entries in the Map. Will not trigger onDeleted callback for values that stay in the map.

    Parameters

    Returns Iterable<TValue>

    Deleted values.

set

  • set(key, value): 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

    Returns this

toJSON

values

  • values(): IterableIterator<TValue>

  • Returns an iterable of values in the map

    Returns IterableIterator<TValue>

Settings

Theme

On This Page

$[toStringTag]size[iterator]batchDeletebatchSetcleardeletedisposeentriesforEachgethaskeysrenamereplacesettoJSONvalues