Type Alias ArrPredicateCallbackFn<T, E>

ArrPredicateCallbackFn<T, E>: ((value: T, index: number, array: T[]) => value is E)

The ArrPredicateCallbackFn function is used for arrEvery and arrFilter, it should return a truthy value to indicate a matching element has been found.

Type Parameters

  • T

    Identifies the type of array elements

  • E extends T

    Identifies the type of the return array elements (defaults to T)

Type declaration

    • (value, index, array): value is E

    • Parameters

      • value: T

        The cuirrent element of the array being processed.

      • index: number

        The index of the current elemety of the array being processed.

      • array: T[]

        The array being processed.

      Returns value is E

      A boolean value indicating that the value is of the type expected (the test is true)

Since

0.8.0

Settings

Member Visibility