Function flatten

flatten<T extends IteratorOrIterable<any>>(
arg: T,
): IterableIterator<FlattenDeep<T>>
Flattens an iterator or iterable.
Type Parameters
- T extends IteratorOrIterable<any>
Parameters
- arg: T
  The iterator or iterable to flatten.
Returns IterableIterator<FlattenDeep<T>>
- Defined in src/flatten.ts:19
flatten<T extends IteratorOrIterable<any>>(
arg: T,
depth: 1,
): IterableIterator<FlattenDepth1<T>>
Flattens an iterator or iterable.
Type Parameters
- T extends IteratorOrIterable<any>
Parameters
- arg: T
  The iterator or iterable to flatten.
- depth: 1
  The number of levels to flatten (default: Infinity, i.e. deeply).
Returns IterableIterator<FlattenDepth1<T>>
- Defined in src/flatten.ts:20
flatten<T extends IteratorOrIterable<any>>(
depth: 1,
): (arg: T) => IterableIterator<FlattenDepth1<T>>
Flattens an iterator or iterable.
Type Parameters
- T extends IteratorOrIterable<any>
Parameters
- depth: 1
  The number of levels to flatten (default: Infinity, i.e. deeply).
Returns (arg: T) => IterableIterator<FlattenDepth1<T>>
- Defined in src/flatten.ts:21
flatten<T extends IteratorOrIterable<any>>(
arg: T,
depth: 2,
): IterableIterator<FlattenDepth2<T>>
Flattens an iterator or iterable.
Type Parameters
- T extends IteratorOrIterable<any>
Parameters
- arg: T
  The iterator or iterable to flatten.
- depth: 2
  The number of levels to flatten (default: Infinity, i.e. deeply).
Returns IterableIterator<FlattenDepth2<T>>
- Defined in src/flatten.ts:22
flatten<T extends IteratorOrIterable<any>>(
depth: 2,
): (arg: T) => IterableIterator<FlattenDepth2<T>>
Flattens an iterator or iterable.
Type Parameters
- T extends IteratorOrIterable<any>
Parameters
- depth: 2
  The number of levels to flatten (default: Infinity, i.e. deeply).
Returns (arg: T) => IterableIterator<FlattenDepth2<T>>
- Defined in src/flatten.ts:23
flatten<T extends IteratorOrIterable<any>>(
arg: T,
depth: 3,
): IterableIterator<FlattenDepth3<T>>
Flattens an iterator or iterable.
Type Parameters
- T extends IteratorOrIterable<any>
Parameters
- arg: T
  The iterator or iterable to flatten.
- depth: 3
  The number of levels to flatten (default: Infinity, i.e. deeply).
Returns IterableIterator<FlattenDepth3<T>>
- Defined in src/flatten.ts:24
flatten<T extends IteratorOrIterable<any>>(
depth: 3,
): (arg: T) => IterableIterator<FlattenDepth3<T>>
Flattens an iterator or iterable.
Type Parameters
- T extends IteratorOrIterable<any>
Parameters
- depth: 3
  The number of levels to flatten (default: Infinity, i.e. deeply).
Returns (arg: T) => IterableIterator<FlattenDepth3<T>>
- Defined in src/flatten.ts:25
flatten<T extends IteratorOrIterable<any>>(
arg: T,
depth: 4,
): IterableIterator<FlattenDepth4<T>>
Flattens an iterator or iterable.
Type Parameters
- T extends IteratorOrIterable<any>
Parameters
- arg: T
  The iterator or iterable to flatten.
- depth: 4
  The number of levels to flatten (default: Infinity, i.e. deeply).
Returns IterableIterator<FlattenDepth4<T>>
- Defined in src/flatten.ts:26
flatten<T extends IteratorOrIterable<any>>(
depth: 4,
): (arg: T) => IterableIterator<FlattenDepth4<T>>
Flattens an iterator or iterable.
Type Parameters
- T extends IteratorOrIterable<any>
Parameters
- depth: 4
  The number of levels to flatten (default: Infinity, i.e. deeply).
Returns (arg: T) => IterableIterator<FlattenDepth4<T>>
- Defined in src/flatten.ts:27
flatten<T extends IteratorOrIterable<any>>(
arg: T,
depth: 5,
): IterableIterator<FlattenDepth5<T>>
Flattens an iterator or iterable.
Type Parameters
- T extends IteratorOrIterable<any>
Parameters
- arg: T
  The iterator or iterable to flatten.
- depth: 5
  The number of levels to flatten (default: Infinity, i.e. deeply).
Returns IterableIterator<FlattenDepth5<T>>
- Defined in src/flatten.ts:28
flatten<T extends IteratorOrIterable<any>>(
depth: 5,
): (arg: T) => IterableIterator<FlattenDepth5<T>>
Flattens an iterator or iterable.
Type Parameters
- T extends IteratorOrIterable<any>
Parameters
- depth: 5
  The number of levels to flatten (default: Infinity, i.e. deeply).
Returns (arg: T) => IterableIterator<FlattenDepth5<T>>
- Defined in src/flatten.ts:29
flatten<T extends IteratorOrIterable<any>>(
arg: T,
depth: number,
): IterableIterator<unknown>
Flattens an iterator or iterable.
Type Parameters
- T extends IteratorOrIterable<any>
Parameters
- arg: T
  The iterator or iterable to flatten.
- depth: number
  The number of levels to flatten (default: Infinity, i.e. deeply).
Returns IterableIterator<unknown>
- Defined in src/flatten.ts:30

Function flatten

Type Parameters

Parameters

Returns IterableIterator<FlattenDeep<T>>

Type Parameters

Parameters

Returns IterableIterator<FlattenDepth1<T>>

Type Parameters

Parameters

Returns (arg: T) => IterableIterator<FlattenDepth1<T>>

Type Parameters

Parameters

Returns IterableIterator<FlattenDepth2<T>>

Type Parameters

Parameters

Returns (arg: T) => IterableIterator<FlattenDepth2<T>>

Type Parameters

Parameters

Returns IterableIterator<FlattenDepth3<T>>

Type Parameters

Parameters

Returns (arg: T) => IterableIterator<FlattenDepth3<T>>

Type Parameters

Parameters

Returns IterableIterator<FlattenDepth4<T>>

Type Parameters

Parameters

Returns (arg: T) => IterableIterator<FlattenDepth4<T>>

Type Parameters

Parameters

Returns IterableIterator<FlattenDepth5<T>>

Type Parameters

Parameters

Returns (arg: T) => IterableIterator<FlattenDepth5<T>>

Type Parameters

Parameters

Returns IterableIterator<unknown>

Settings