Function objectToEntries

  • Yields all entries of an object (including symbols).

    Example

    const entries = objectEntries({ a: 1, b: 2 });
    entries.next(); // { value: ["a", 1], done: false }
    entries.next(); // { value: ["b", 2], done: false }
    entries.next(); // { value: undefined, done: true }

    Type Parameters

    • Key extends PropertyKey

    • Value

    Parameters

    • input: ReadOnlyRecord<Key, Value>

      Object to get entries from.

    Returns {
        [iterator]() => IterableIterator<Entry<Key, Value> | Entry<Extract<keyof ReadOnly<Record<Key, Value>>, string>, Value>>;
        next(...args) => IteratorResult<Entry<Key, Value> | Entry<Extract<keyof ReadOnly<Record<Key, Value>>, string>, Value>, any>;
        return?(value?) => IteratorResult<Entry<Key, Value> | Entry<Extract<keyof ReadOnly<Record<Key, Value>>, string>, Value>, any>;
        throw?(e?) => IteratorResult<Entry<Key, Value> | Entry<Extract<keyof ReadOnly<Record<Key, Value>>, string>, Value>, any>;
    }

    Iterable with entries of the given object (including symbols).

    • [iterator]:function
      • [iterator](): IterableIterator<Entry<Key, Value> | Entry<Extract<keyof ReadOnly<Record<Key, Value>>, string>, Value>>

      • Returns IterableIterator<Entry<Key, Value> | Entry<Extract<keyof ReadOnly<Record<Key, Value>>, string>, Value>>

    • next:function
      • next(...args): IteratorResult<Entry<Key, Value> | Entry<Extract<keyof ReadOnly<Record<Key, Value>>, string>, Value>, any>

      • Parameters

        • Rest ...args: [] | [undefined]

        Returns IteratorResult<Entry<Key, Value> | Entry<Extract<keyof ReadOnly<Record<Key, Value>>, string>, Value>, any>

    • return?:function
      • return(value?): IteratorResult<Entry<Key, Value> | Entry<Extract<keyof ReadOnly<Record<Key, Value>>, string>, Value>, any>

      • Parameters

        • Optional value: any

        Returns IteratorResult<Entry<Key, Value> | Entry<Extract<keyof ReadOnly<Record<Key, Value>>, string>, Value>, any>

    • throw?:function
      • throw(e?): IteratorResult<Entry<Key, Value> | Entry<Extract<keyof ReadOnly<Record<Key, Value>>, string>, Value>, any>

      • Parameters

        • Optional e: any

        Returns IteratorResult<Entry<Key, Value> | Entry<Extract<keyof ReadOnly<Record<Key, Value>>, string>, Value>, any>

Settings

Member Visibility

Theme