Interface LiveMapPathObjectCollectionMethods<T>

Defines collection methods available on a LiveMapPathObject.

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 at this path. Each value is represented as a PathObject corresponding to its key.

    If the path does not resolve to a map object, returns an empty iterator.

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

keys

  • Returns an iterable of keys in the map at this path.

    If the path does not resolve to a map object, returns an empty iterator.

    Returns IterableIterator<keyof T>

size

  • Returns the number of entries in the map at this path.

    If the path does not resolve to a map object, returns undefined.

    Returns undefined | number

values

  • Returns an iterable of values in the map at this path. Each value is represented as a PathObject.

    If the path does not resolve to a map object, returns an empty iterator.

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc