Iter

A collection of utility functions for working with iterables.

Interfaces

ResampleOptions

Properties

Property	Type	Description
`align?`	`"center"` \| `"start"` \| `"uniform"` \| `"end"`	How to align the resampled values. Default `'uniform'`
`count?`	`number`	The number of samples to generate. If this is specified, the `step` will be ignored and the number will be distributed uniformly across the range. Default `undefined`
`emitFrom?`	`boolean`	Whether to emit the `from` value. Default `true`
`emitTo?`	`boolean`	Whether to emit the `to` value. Default `true`
`step?`	`number`	The step size to use for resampling. If not provided, the step size will be calculated based on the `count` and `align` options. Default `to - from`

Functions

enumerate()

enumerate<T>(iter): Generator<[number, T]>

Defined in: Iter.ts:98

Yields tuples of values from the input generator, where its first element is the index of the value and the second one is the value itself.

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type	Description
`iter`	`Iterable`<`T`>	The input generator.

Returns

Generator<[number, T]>

range()

range(from, to, step, maxCount): Generator<number>

Defined in: Iter.ts:16

Iterates over a range between [from, to) with a given step, while avoiding infinite loops.

Parameters

Parameter	Type	Default value	Description
`from`	`number`	`undefined`	The start of the range.
`to`	`number`	`undefined`	The end of the range.
`step`	`number`	`undefined`	The step size.
`maxCount`	`number`	`1_000_000`	The maximum number of values to yield.

Returns

Generator<number>

A generator that yields values in the range.

rangeWithOffset()

rangeWithOffset(from, to, step, offset, maxCount?): Generator<number>

Defined in: Iter.ts:55

Yield from, to, and values between them with a given step and offset. It avoids infinite loops by clamping the number of iterations.

Parameters

Parameter	Type	Description
`from`	`number`	The start of the range.
`to`	`number`	The end of the range.
`step`	`number`	The step size.
`offset`	`number`	The offset to apply to the range.
`maxCount`?	`number`	The maximum number of values to yield.

Returns

Generator<number>

resample()

resample(from, to, __namedParameters): Generator<number, void, unknown>

Defined in: Iter.ts:135

Parameters

Parameter	Type
`from`	`number`
`to`	`number`
`__namedParameters`	`ResampleOptions`

Returns

Generator<number, void, unknown>

tuple()

tuple<T>(iter): Generator<[T, T]>

Defined in: Iter.ts:82

Yields tuples of values from the input generator, where each tuple contains the current and previous values.

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type	Description
`iter`	`Iterable`<`T`>	The input generator.

Returns

Generator<[T, T]>

A generator that yields tuples of values.