Function filteredForEach

  • filteredForEach<T extends readonly unknown[], S extends unknown>(array: T, filter: ((element: T[number], index: number) => element is S), forEach: ((element: S, index: number) => void)): void

  • Applies a filter function to the elements of the given array, and then calls a forEach function with each of the filtered elements.

    Type Parameters

    • T extends readonly unknown[]

    • S extends unknown

    Parameters

    • array: T

      The array to iterate over.

    • filter: ((element: T[number], index: number) => element is S)

      A function that determines whether an element should be included.

        • (element: T[number], index: number): element is S

        • Parameters

          • element: T[number]
          • index: number

          Returns element is S

    • forEach: ((element: S, index: number) => void)

      A function to call for each included element.

        • (element: S, index: number): void

        • Parameters

          • element: S
          • index: number

          Returns void

    Returns void

    Example

    Basic Usage

    filteredForEach(
      [1, 2, 3, 4, 5],
      (value) => value > 3,
      (value) => console.log(value ** 2)
    ) // Prints: 16, 25

    Type narrowing

    import { isString } from 'uft'

    filteredForEach(
      ['foo', { a: 1 }, [], 'bar'],
      isString,
      (value) => {
        value // type: string
        console.log(value.toUpperCase())
      }
    ) // Prints: FOO, BAR
  • filteredForEach<T extends readonly unknown[], S>(array: T, filter: ((element: T[number], index: number) => element is S), forEach: ((element: AssignableTo<T[number], S>, index: number) => void)): void

  • Type Parameters

    • T extends readonly unknown[]

    • S

    Parameters

    • array: T
    • filter: ((element: T[number], index: number) => element is S)
        • (element: T[number], index: number): element is S

        • Parameters

          • element: T[number]
          • index: number

          Returns element is S

    • forEach: ((element: AssignableTo<T[number], S>, index: number) => void)
        • (element: AssignableTo<T[number], S>, index: number): void

        • Parameters

          • element: AssignableTo<T[number], S>
          • index: number

          Returns void

    Returns void

  • filteredForEach<T extends readonly unknown[]>(array: T, filter: ((element: T[number], index: number) => boolean), forEach: ((element: T[number], index: number) => void)): void

  • Type Parameters

    • T extends readonly unknown[]

    Parameters

    • array: T
    • filter: ((element: T[number], index: number) => boolean)
        • (element: T[number], index: number): boolean

        • Parameters

          • element: T[number]
          • index: number

          Returns boolean

    • forEach: ((element: T[number], index: number) => void)
        • (element: T[number], index: number): void

        • Parameters

          • element: T[number]
          • index: number

          Returns void

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc