Options
All
  • Public
  • Public/Protected
  • All
Menu

Module object/findKey

Index

References

Functions

References

Renames and re-exports findKey

Functions

  • findKey<O>(fn: ObjPred<keyof O, O[keyof O]>, obj: O): void | keyof O
  • findKey<K, V>(fn: ObjPred<K, V>): <O>(obj: O) => void | keyof O
  • Returns first key in obj satisfied to fn, or undefined if there is no such keys

    example
     findKey(identity, {a: 0, b: 3}) //=> 'b'
    findKey(x => x > 3, { a: 2, b: 1 }) //=> undefined
    findKey(x => x > 3, { a: 4, b: 5 }) //=> 'a'

    Type parameters

    • O: Record<any, any>

    Parameters

    • fn: ObjPred<keyof O, O[keyof O]>

      Receives three argument, value, key, obj

    • obj: O

    Returns void | keyof O

  • Returns first key in obj satisfied to fn, or undefined if there is no such keys

    example
     findKey(identity, {a: 0, b: 3}) //=> 'b'
    findKey(x => x > 3, { a: 2, b: 1 }) //=> undefined
    findKey(x => x > 3, { a: 4, b: 5 }) //=> 'a'

    Type parameters

    • K: string

    • V

    Parameters

    • fn: ObjPred<K, V>

      Receives three argument, value, key, obj

    Returns <O>(obj: O) => void | keyof O

      • <O>(obj: O): void | keyof O
      • Type parameters

        • O: Record<K, V>

        Parameters

        • obj: O

        Returns void | keyof O

Generated using TypeDoc