Function elementAtOrDefault

  • elementAtOrDefault<TSource>(
        src: Iterable<TSource>,
        index: number,
    ): TSource | null

  • Returns the element at a specified index in a sequence or null if the index is out of range. A negative index can be used to get element starting from the end.

    Type Parameters

    • TSource

    Parameters

    • src: Iterable<TSource>

      The source iterable.

    • index: number

      The zero-based index of the element to retrieve.

    Returns TSource | null

    The element at the specified position in the source sequence.

    Example

    const indexZero = elementAtOrDefault([1, 2, 3], 0); // Will be 1
    const willBeNull = elementAtOrDefault([1, 2, 3], 10); // Will be null.
    const last = elementAtOrDefault([1, 2, 3], -1); // 3

    Typeparam

    TSource The type of the source iterable.

Settings

Member Visibility