Function head

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

    Example

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

    Type Parameters

    • Iterable extends IsomorphicIterable

    Parameters

    • iterable: Iterable

      Iterable to get the first element from.

    Returns Iterable extends ReadOnlyArray
        ? Head<Iterable>
        : Maybe<IsomorphicIterableItem<Iterable>>

    First element of the iterable (undefined if empty).

Settings

Member Visibility

Theme