Function get

  • get<TObject, TKey>(object, path): TObject[TKey]

  • Gets the property value at path of object. If the resolved value is undefined the defaultValue is used in its place.

    Type Parameters

    • TObject extends object

    • TKey extends string | number | symbol

    Parameters

    • object: TObject

      The object to query.

    • path: TKey | [TKey]

      The path of the property to get.

    Returns TObject[TKey]

    Returns the resolved value.

  • get<TObject, TKey>(object, path): undefined | TObject[TKey]

  • Type Parameters

    • TObject extends object

    • TKey extends string | number | symbol

    Parameters

    • object: undefined | null | TObject
    • path: TKey | [TKey]

    Returns undefined | TObject[TKey]

    See

    _.get

  • get<TObject, TKey, TDefault>(object, path, defaultValue): TDefault | Exclude<TObject[TKey], undefined>

  • Type Parameters

    • TObject extends object

    • TKey extends string | number | symbol

    • TDefault

    Parameters

    • object: undefined | null | TObject
    • path: TKey | [TKey]
    • defaultValue: TDefault

    Returns TDefault | Exclude<TObject[TKey], undefined>

    See

    _.get

  • get<TObject, TKey1, TKey2>(object, path): TObject[TKey1][TKey2]

  • Type Parameters

    • TObject extends object

    • TKey1 extends string | number | symbol

    • TKey2 extends string | number | symbol

    Parameters

    • object: TObject
    • path: [TKey1, TKey2]

    Returns TObject[TKey1][TKey2]

    See

    _.get

  • get<TObject, TKey1, TKey2>(object, path): undefined | TObject[TKey1][TKey2]

  • Type Parameters

    • TObject extends object

    • TKey1 extends string | number | symbol

    • TKey2 extends string | number | symbol

    Parameters

    • object: undefined | null | TObject
    • path: [TKey1, TKey2]

    Returns undefined | TObject[TKey1][TKey2]

    See

    _.get

  • get<TObject, TKey1, TKey2, TDefault>(object, path, defaultValue): TDefault | Exclude<TObject[TKey1][TKey2], undefined>

  • Type Parameters

    • TObject extends object

    • TKey1 extends string | number | symbol

    • TKey2 extends string | number | symbol

    • TDefault

    Parameters

    • object: undefined | null | TObject
    • path: [TKey1, TKey2]
    • defaultValue: TDefault

    Returns TDefault | Exclude<TObject[TKey1][TKey2], undefined>

    See

    _.get

  • get<TObject, TKey1, TKey2, TKey3>(object, path): TObject[TKey1][TKey2][TKey3]

  • Type Parameters

    • TObject extends object

    • TKey1 extends string | number | symbol

    • TKey2 extends string | number | symbol

    • TKey3 extends string | number | symbol

    Parameters

    • object: TObject
    • path: [TKey1, TKey2, TKey3]

    Returns TObject[TKey1][TKey2][TKey3]

    See

    _.get

  • get<TObject, TKey1, TKey2, TKey3>(object, path): undefined | TObject[TKey1][TKey2][TKey3]

  • Type Parameters

    • TObject extends object

    • TKey1 extends string | number | symbol

    • TKey2 extends string | number | symbol

    • TKey3 extends string | number | symbol

    Parameters

    • object: undefined | null | TObject
    • path: [TKey1, TKey2, TKey3]

    Returns undefined | TObject[TKey1][TKey2][TKey3]

    See

    _.get

  • get<TObject, TKey1, TKey2, TKey3, TDefault>(object, path, defaultValue): TDefault | Exclude<TObject[TKey1][TKey2][TKey3], undefined>

  • Type Parameters

    • TObject extends object

    • TKey1 extends string | number | symbol

    • TKey2 extends string | number | symbol

    • TKey3 extends string | number | symbol

    • TDefault

    Parameters

    • object: undefined | null | TObject
    • path: [TKey1, TKey2, TKey3]
    • defaultValue: TDefault

    Returns TDefault | Exclude<TObject[TKey1][TKey2][TKey3], undefined>

    See

    _.get

  • get<TObject, TKey1, TKey2, TKey3, TKey4>(object, path): TObject[TKey1][TKey2][TKey3][TKey4]

  • Type Parameters

    • TObject extends object

    • TKey1 extends string | number | symbol

    • TKey2 extends string | number | symbol

    • TKey3 extends string | number | symbol

    • TKey4 extends string | number | symbol

    Parameters

    • object: TObject
    • path: [TKey1, TKey2, TKey3, TKey4]

    Returns TObject[TKey1][TKey2][TKey3][TKey4]

    See

    _.get

  • get<TObject, TKey1, TKey2, TKey3, TKey4>(object, path): undefined | TObject[TKey1][TKey2][TKey3][TKey4]

  • Type Parameters

    • TObject extends object

    • TKey1 extends string | number | symbol

    • TKey2 extends string | number | symbol

    • TKey3 extends string | number | symbol

    • TKey4 extends string | number | symbol

    Parameters

    • object: undefined | null | TObject
    • path: [TKey1, TKey2, TKey3, TKey4]

    Returns undefined | TObject[TKey1][TKey2][TKey3][TKey4]

    See

    _.get

  • get<TObject, TKey1, TKey2, TKey3, TKey4, TDefault>(object, path, defaultValue): TDefault | Exclude<TObject[TKey1][TKey2][TKey3][TKey4], undefined>

  • Type Parameters

    • TObject extends object

    • TKey1 extends string | number | symbol

    • TKey2 extends string | number | symbol

    • TKey3 extends string | number | symbol

    • TKey4 extends string | number | symbol

    • TDefault

    Parameters

    • object: undefined | null | TObject
    • path: [TKey1, TKey2, TKey3, TKey4]
    • defaultValue: TDefault

    Returns TDefault | Exclude<TObject[TKey1][TKey2][TKey3][TKey4], undefined>

    See

    _.get

  • get<T>(object, path): T

  • Type Parameters

    • T

    Parameters

    • object: NumericDictionary<T>
    • path: number

    Returns T

    See

    _.get

  • get<T>(object, path): undefined | T

  • Type Parameters

    • T

    Parameters

    • object: undefined | null | NumericDictionary<T>
    • path: number

    Returns undefined | T

    See

    _.get

  • get<T, TDefault>(object, path, defaultValue): T | TDefault

  • Type Parameters

    • T

    • TDefault

    Parameters

    • object: undefined | null | NumericDictionary<T>
    • path: number
    • defaultValue: TDefault

    Returns T | TDefault

    See

    _.get

  • get<TDefault>(object, path, defaultValue): TDefault

  • Type Parameters

    • TDefault

    Parameters

    • object: undefined | null
    • path: PropertyPath
    • defaultValue: TDefault

    Returns TDefault

    See

    _.get

  • get(object, path): undefined

  • Parameters

    • object: undefined | null
    • path: PropertyPath

    Returns undefined

    See

    _.get

  • get(object, path, defaultValue?): any

  • Parameters

    • object: any
    • path: PropertyPath
    • Optional defaultValue: any

    Returns any

    See

    _.get

Settings

Member Visibility

Theme

Generated using TypeDoc