Function findKey

  • Finds the key of the first element in the object that satisfies the provided testing function.

    Type Parameters

    • T extends Record<any, any>

    Parameters

    • obj: T

      The object to search.

    • predicate: ((value: T[keyof T], key: keyof T, obj: T) => boolean)

      The function to execute on each value in the object. It takes three arguments:

      • value: The current value being processed in the object.
      • key: The key of the current value being processed in the object.
      • obj: The object that findKey was called upon.
        • (value, key, obj): boolean
        • Parameters

          • value: T[keyof T]
          • key: keyof T
          • obj: T

          Returns boolean

    Returns keyof T | undefined

    The key of the first element in the object that passes the test, or undefined if no element passes.

    const users = {
    'barney': { 'age': 36, 'active': true },
    'fred': { 'age': 40, 'active': false },
    'pebbles': { 'age': 1, 'active': true }
    };
    findKey(users, function(o) { return o.age < 40; }); => 'barney'