Class Combineable`Abstract`

Index

Constructors

Methods

[_with] [concat] [zip]

Constructors

constructor

new Combineable(): Combineable
Returns Combineable

Methods

[_with]

"[_with]"<A>(
    this: Iterable<A>,
    i: number,
    value: A,
): Generator<A, void, unknown>
Return a new iterable with the element at index i replaced with value.
Type Parameters
- A
Parameters
- this: Iterable<A>
- i: number
- value: A
Returns Generator<A, void, unknown>
Throws
RangeError if i is out of range.

See
https://tc39.es/proposal-change-array-by-copy/#sec-array.prototype.with
- Defined in packages/iterable/src/Combineable.ts:43

[concat]

"[concat]"<A>(
this: Iterable<A>,
...iterables: Iterable<A, any, any>[],
): Generator<A, void, any>
Concatenate the given iterables to the end of this iterable.
Type Parameters
- A
Parameters
- this: Iterable<A>
- ...iterables: Iterable<A, any, any>[]
Returns Generator<A, void, any>
- Defined in packages/iterable/src/Combineable.ts:11

[zip]

"[zip]"<A, B extends unknown[]>(
    this: Iterable<A>,
    ...sources: {
        [K in string | number | symbol]: Iterable<B[K<K>], any, any>
    },
): Iterable<[A, ...B[]]>
Zip the given iterables with this iterable.
Type Parameters
- A
- B extends unknown[]
Parameters
- this: Iterable<A>
- ...sources: { [K in string | number | symbol]: Iterable<B[K<K>], any, any> }
Returns Iterable<[A, ...B[]]>
- Defined in packages/iterable/src/Combineable.ts:21