Function flatten

  • flatten<T extends IteratorOrIterable<any>>(
        arg: T,
    ): IterableIterator<FlattenDeep<T>>

    Flattens an iterator or iterable.

    Strings are not flattened. Any string encountered while flattening nested iterables is treated as a single atomic value (same as Array.prototype.flat / Lodash flatten). To split a string into characters, spread it into an array first (e.g. [...str]) or iterate the string directly as the root input.

    Type Parameters

    Parameters

    • arg: T

      The iterator or iterable to flatten.

    Returns IterableIterator<FlattenDeep<T>>

    Example

    [...flatten(['abc'])]; // ['abc']
    [...flatten('abc')]; // ['a', 'b', 'c'] — root string is iterated, not flattened as a nested value
  • flatten<T extends IteratorOrIterable<any>>(
        arg: T,
        depth: 1,
    ): IterableIterator<FlattenDepth1<T>>

    Flattens an iterator or iterable.

    Strings are not flattened. Any string encountered while flattening nested iterables is treated as a single atomic value (same as Array.prototype.flat / Lodash flatten). To split a string into characters, spread it into an array first (e.g. [...str]) or iterate the string directly as the root input.

    Type Parameters

    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>>

    Example

    [...flatten(['abc'])]; // ['abc']
    [...flatten('abc')]; // ['a', 'b', 'c'] — root string is iterated, not flattened as a nested value
  • flatten<T extends IteratorOrIterable<any>>(
        depth: 1,
    ): (arg: T) => IterableIterator<FlattenDepth1<T>>

    Flattens an iterator or iterable.

    Strings are not flattened. Any string encountered while flattening nested iterables is treated as a single atomic value (same as Array.prototype.flat / Lodash flatten). To split a string into characters, spread it into an array first (e.g. [...str]) or iterate the string directly as the root input.

    Type Parameters

    Parameters

    • depth: 1

      The number of levels to flatten (default: Infinity, i.e. deeply).

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

    Example

    [...flatten(['abc'])]; // ['abc']
    [...flatten('abc')]; // ['a', 'b', 'c'] — root string is iterated, not flattened as a nested value
  • flatten<T extends IteratorOrIterable<any>>(
        arg: T,
        depth: 2,
    ): IterableIterator<FlattenDepth2<T>>

    Flattens an iterator or iterable.

    Strings are not flattened. Any string encountered while flattening nested iterables is treated as a single atomic value (same as Array.prototype.flat / Lodash flatten). To split a string into characters, spread it into an array first (e.g. [...str]) or iterate the string directly as the root input.

    Type Parameters

    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>>

    Example

    [...flatten(['abc'])]; // ['abc']
    [...flatten('abc')]; // ['a', 'b', 'c'] — root string is iterated, not flattened as a nested value
  • flatten<T extends IteratorOrIterable<any>>(
        depth: 2,
    ): (arg: T) => IterableIterator<FlattenDepth2<T>>

    Flattens an iterator or iterable.

    Strings are not flattened. Any string encountered while flattening nested iterables is treated as a single atomic value (same as Array.prototype.flat / Lodash flatten). To split a string into characters, spread it into an array first (e.g. [...str]) or iterate the string directly as the root input.

    Type Parameters

    Parameters

    • depth: 2

      The number of levels to flatten (default: Infinity, i.e. deeply).

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

    Example

    [...flatten(['abc'])]; // ['abc']
    [...flatten('abc')]; // ['a', 'b', 'c'] — root string is iterated, not flattened as a nested value
  • flatten<T extends IteratorOrIterable<any>>(
        arg: T,
        depth: 3,
    ): IterableIterator<FlattenDepth3<T>>

    Flattens an iterator or iterable.

    Strings are not flattened. Any string encountered while flattening nested iterables is treated as a single atomic value (same as Array.prototype.flat / Lodash flatten). To split a string into characters, spread it into an array first (e.g. [...str]) or iterate the string directly as the root input.

    Type Parameters

    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>>

    Example

    [...flatten(['abc'])]; // ['abc']
    [...flatten('abc')]; // ['a', 'b', 'c'] — root string is iterated, not flattened as a nested value
  • flatten<T extends IteratorOrIterable<any>>(
        depth: 3,
    ): (arg: T) => IterableIterator<FlattenDepth3<T>>

    Flattens an iterator or iterable.

    Strings are not flattened. Any string encountered while flattening nested iterables is treated as a single atomic value (same as Array.prototype.flat / Lodash flatten). To split a string into characters, spread it into an array first (e.g. [...str]) or iterate the string directly as the root input.

    Type Parameters

    Parameters

    • depth: 3

      The number of levels to flatten (default: Infinity, i.e. deeply).

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

    Example

    [...flatten(['abc'])]; // ['abc']
    [...flatten('abc')]; // ['a', 'b', 'c'] — root string is iterated, not flattened as a nested value
  • flatten<T extends IteratorOrIterable<any>>(
        arg: T,
        depth: 4,
    ): IterableIterator<FlattenDepth4<T>>

    Flattens an iterator or iterable.

    Strings are not flattened. Any string encountered while flattening nested iterables is treated as a single atomic value (same as Array.prototype.flat / Lodash flatten). To split a string into characters, spread it into an array first (e.g. [...str]) or iterate the string directly as the root input.

    Type Parameters

    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>>

    Example

    [...flatten(['abc'])]; // ['abc']
    [...flatten('abc')]; // ['a', 'b', 'c'] — root string is iterated, not flattened as a nested value
  • flatten<T extends IteratorOrIterable<any>>(
        depth: 4,
    ): (arg: T) => IterableIterator<FlattenDepth4<T>>

    Flattens an iterator or iterable.

    Strings are not flattened. Any string encountered while flattening nested iterables is treated as a single atomic value (same as Array.prototype.flat / Lodash flatten). To split a string into characters, spread it into an array first (e.g. [...str]) or iterate the string directly as the root input.

    Type Parameters

    Parameters

    • depth: 4

      The number of levels to flatten (default: Infinity, i.e. deeply).

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

    Example

    [...flatten(['abc'])]; // ['abc']
    [...flatten('abc')]; // ['a', 'b', 'c'] — root string is iterated, not flattened as a nested value
  • flatten<T extends IteratorOrIterable<any>>(
        arg: T,
        depth: 5,
    ): IterableIterator<FlattenDepth5<T>>

    Flattens an iterator or iterable.

    Strings are not flattened. Any string encountered while flattening nested iterables is treated as a single atomic value (same as Array.prototype.flat / Lodash flatten). To split a string into characters, spread it into an array first (e.g. [...str]) or iterate the string directly as the root input.

    Type Parameters

    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>>

    Example

    [...flatten(['abc'])]; // ['abc']
    [...flatten('abc')]; // ['a', 'b', 'c'] — root string is iterated, not flattened as a nested value
  • flatten<T extends IteratorOrIterable<any>>(
        depth: 5,
    ): (arg: T) => IterableIterator<FlattenDepth5<T>>

    Flattens an iterator or iterable.

    Strings are not flattened. Any string encountered while flattening nested iterables is treated as a single atomic value (same as Array.prototype.flat / Lodash flatten). To split a string into characters, spread it into an array first (e.g. [...str]) or iterate the string directly as the root input.

    Type Parameters

    Parameters

    • depth: 5

      The number of levels to flatten (default: Infinity, i.e. deeply).

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

    Example

    [...flatten(['abc'])]; // ['abc']
    [...flatten('abc')]; // ['a', 'b', 'c'] — root string is iterated, not flattened as a nested value
  • flatten<T extends IteratorOrIterable<any>>(
        arg: T,
        depth: number,
    ): IterableIterator<unknown>

    Flattens an iterator or iterable.

    Strings are not flattened. Any string encountered while flattening nested iterables is treated as a single atomic value (same as Array.prototype.flat / Lodash flatten). To split a string into characters, spread it into an array first (e.g. [...str]) or iterate the string directly as the root input.

    Type Parameters

    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>

    Example

    [...flatten(['abc'])]; // ['abc']
    [...flatten('abc')]; // ['a', 'b', 'c'] — root string is iterated, not flattened as a nested value

Settings

Member Visibility