Function MethodIterator

MethodIterator<T extends object, K = unknown, V = unknown>(
    object: T & { size?: number },
    methodKey?: string | symbol,
): EntriesIterator<
    <T extends object, K = unknown, V = unknown>(
        object: T & { size?: number },
        methodKey?: string | symbol,
    ) => EntriesIterator<(<T extends object, K = unknown, V = unknown>(object: T & { size?: number; }, methodKey?: string | symbol) => EntriesIterator<typeof MethodIterator, T & { size?: number; }, K, V>), T & { ...; }, K, V>,
    T & { size?: number },
    K,
    V,
>
Creates an iterator that uses a method of an object for iterate over its entries.

The method must return an iterable iterator with entries in [key, value] format.
Type Parameters
- T extends object
- K = unknown
- V = unknown
Parameters
- object: T & { size?: number }
  The target object.
- methodKey: string | symbol = "entries"
  The key where is the method.
Returns EntriesIterator<
    <T extends object, K = unknown, V = unknown>(
        object: T & { size?: number },
        methodKey?: string | symbol,
    ) => EntriesIterator<(<T extends object, K = unknown, V = unknown>(object: T & { size?: number; }, methodKey?: string | symbol) => EntriesIterator<typeof MethodIterator, T & { size?: number; }, K, V>), T & { ...; }, K, V>,
    T & { size?: number },
    K,
    V,
>
An wrapped entries iterator.
Example
```
const object = new Map([[Date, "date"], [Set, "set"]]);
const iterator = MethodIterator(object);
const state = iterator.next();

console.log(state); // { done: false, value: [Date, "date", 0] }
```
Since
3.0.0-beta.0

Deprecated
It will be removed in version 3.0.0

This factory was exposed during beta and will not be part of the stable API because it is redundant.

Instead, use iterators directly from the object's methods, such as object.entries().
- Defined in iterate/iterator-factories/method-iterator.ts:35

Function MethodIterator

Type Parameters

Parameters

Example

Since

Deprecated

Settings