ts-data-forge/dist/array/impl/array-utils-iterators.d.mts

[](https://www.npmjs.com/package/ts-data-forge) [](https://www.npmjs.com/package/ts-data-forge) [![License](https://img.shields.

/**
 * Returns an iterator of `[index, value]` pairs for an array.
 *
 * @example
 *
 * ```ts
 * const tags = ['alpha', 'beta', 'gamma'] as const;
 *
 * const entryList = Array.from(
 *   Arr.entries(tags),
 *   ([index, tag]) => [Number(index), tag] as const,
 * );
 *
 * assert.deepStrictEqual(
 *   entryList,
 *   Array.from([
 *     [0, 'alpha'],
 *     [1, 'beta'],
 *     [2, 'gamma'],
 *   ]),
 * );
 * ```
 */
export declare const entries: <E>(array: readonly E[]) => ArrayIterator<readonly [SizeType.Arr, E]>;
/**
 * Returns an iterator of values for an array.
 *
 * @example
 *
 * ```ts
 * const players = ['Ada', 'Grace', 'Alan'];
 *
 * const valueList = Array.from(Arr.values(players));
 *
 * assert.deepStrictEqual(valueList, players);
 * ```
 */
export declare const values: <E>(array: readonly E[]) => ArrayIterator<E>;
/**
 * Returns an iterator of indices for an array.
 *
 * @example
 *
 * ```ts
 * const items = ['zero', 'one', 'two'] as const;
 *
 * const indexList = Array.from(Arr.indices(items));
 *
 * assert.deepStrictEqual(indexList, [0, 1, 2]);
 * ```
 */
export declare const indices: <E>(array: readonly E[]) => ArrayIterator<SizeType.Arr>;
/**
 * Alias for `indices`.
 *
 * @see {@link indices}
 */
export declare const keys: <E>(array: readonly E[]) => ArrayIterator<SizeType.Arr>;
//# sourceMappingURL=array-utils-iterators.d.mts.map