Function findKey

  • findKey<V>(object: Record<string, V>, predicate?: Predicate<V>): string

  • This method is like find except that it returns the key of the first element predicate returns truthy for instead of the element itself.

    Type Parameters

    • V

    Parameters

    • object: Record<string, V>

      The object to inspect.

    • Optionalpredicate: Predicate<V>

      The function invoked per iteration.

    Returns string

    Returns the key of the matched element, else undefined.

    Since

    5.2.0

    See

    [[find]], [[findIndex]], [[findLast]], [[findLastIndex]], [[findLastKey]]

    Example

    const users = {
      'barney':  { 'age': 36, 'active': true },
      'fred':    { 'age': 40, 'active': false },
      'pebbles': { 'age': 1,  'active': true }
    }

    findKey(users, ({ age }) => age < 40)
    // => 'barney' (iteration order is not guaranteed)
  • findKey(object: any, predicate?: any[]): string

  • This method is like find except that it returns the key of the first element predicate returns truthy for instead of the element itself.

    Parameters

    • object: any

      The object to inspect.

    • Optionalpredicate: any[]

      The function invoked per iteration.

    Returns string

    Returns the key of the matched element, else undefined.

    Since

    5.2.0

    See

    [[find]], [[findIndex]], [[findLast]], [[findLastIndex]], [[findLastKey]]

    Example

    const users = {
      'barney':  { 'age': 36, 'active': true },
      'fred':    { 'age': 40, 'active': false },
      'pebbles': { 'age': 1,  'active': true }
    }

    findKey(users, ({ age }) => age < 40)
    // => 'barney' (iteration order is not guaranteed)
  • findKey(object: any, predicate?: string): string

  • This method is like find except that it returns the key of the first element predicate returns truthy for instead of the element itself.

    Parameters

    • object: any

      The object to inspect.

    • Optionalpredicate: string

      The function invoked per iteration.

    Returns string

    Returns the key of the matched element, else undefined.

    Since

    5.2.0

    See

    [[find]], [[findIndex]], [[findLast]], [[findLastIndex]], [[findLastKey]]

    Example

    const users = {
      'barney':  { 'age': 36, 'active': true },
      'fred':    { 'age': 40, 'active': false },
      'pebbles': { 'age': 1,  'active': true }
    }

    findKey(users, ({ age }) => age < 40)
    // => 'barney' (iteration order is not guaranteed)

Settings

Member Visibility