Function filterObject

  • Iterates over properties of object, returning an array of all elements predicate returns truthy for. The predicate is invoked with three arguments: (value, key, object).

    If you want an object in return, consider pickBy.

    Type Parameters

    • T

    Parameters

    • object: Record<string, T>

      The object to iterate over.

    • Optional predicate: Predicate<string, T, Record<string, T>>

      The function invoked per iteration.

      Optional

    Returns T[]

    Returns the new filtered array.

    Since

    5.3.0

    See

    [[pickBy]],[[pull]],[[pullAll]],[[pullAllBy]],[[pullAllWith]],[[pullAt]],[[remove]],[[reject]]

    Example

    const object = { 'a': 5, 'b': 8, 'c': 10 }

    filterObject(object, (n) => !(n % 5))
    // => [5, 10]
  • Type Parameters

    • T

    Parameters

    • object: T[]
    • Optional predicate: Predicate<string, T, T[]>
      Optional

    Returns T[]

  • Parameters

    • object: any
    • Optional predicate: Predicate<any, any, any>
      Optional

    Returns any[]