Interface LiveMapInstanceCollectionMethods<T>

Defines collection methods available on a LiveMapInstance.

Type Parameters

  • T extends Record<string, Value> = Record<string, Value>

Hierarchy

Methods

entries keys size values

Methods

entries

  • Returns an iterable of key-value pairs for each entry in the map. Each value is represented as an Instance corresponding to its key.

    If the underlying instance at runtime is not a map, returns an empty iterator.

    Returns IterableIterator<[keyof T, Instance<T[keyof T]>]>

keys

  • Returns an iterable of keys in the map.

    If the underlying instance at runtime is not a map, returns an empty iterator.

    Returns IterableIterator<keyof T>

size

  • Returns the number of entries in the map.

    If the underlying instance at runtime is not a map, returns undefined.

    Returns undefined | number

values

  • Returns an iterable of values in the map. Each value is represented as an Instance.

    If the underlying instance at runtime is not a map, returns an empty iterator.

    Returns IterableIterator<Instance<T[keyof T]>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc