Function head

  • Get first element of an iterable or asynchronous iterable (undefined if it is empty).

    Example

    head([1, 2, 3]); // 1

    Returns

    First element of the iterable (undefined if empty).

    Type Parameters

    • Iterable extends AsynchronousIterable<unknown>

    Parameters

    • iterable: Iterable

      Iterable to get the first element from.

    Returns Iterable extends ReadOnlyArray<unknown> ? Head<Iterable> : GeneratorOutput<Iterable>

Settings

Member Visibility

Theme