Interface AnyPathObjectCollectionMethods

AnyPathObjectCollectionMethods defines all possible methods available on a PathObject for the underlying collection types.

Hierarchy

Methods

  • Returns an iterable of key-value pairs for each entry in the map, if the path resolves to a LiveMap. 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.

    Type Parameters

    • T extends Record<string, Value>

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

  • Returns an iterable of keys in the map, if the path resolves to a LiveMap.

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

    Type Parameters

    • T extends Record<string, Value>

    Returns IterableIterator<keyof T>

  • Returns the number of entries in the map, if the path resolves to a LiveMap.

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

    Returns undefined | number

  • Returns an iterable of values in the map, if the path resolves to a LiveMap. Each value is represented as a PathObject.

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

    Type Parameters

    • T extends Record<string, Value>

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

Generated using TypeDoc