Function get

  • get<TObject extends object, TKey extends string | number | symbol>(
        object: TObject,
        path: TKey | [TKey],
    ): 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 extends object, TKey extends string | number | symbol>(
        object: undefined | null | TObject,
        path: TKey | [TKey],
    ): undefined | TObject[TKey]

  • Type Parameters

    • TObject extends object
    • TKey extends string | number | symbol

    Parameters

    Returns undefined | TObject[TKey]

    See

    _.get

  • get<TObject extends object, TKey extends string | number | symbol, TDefault>(
        object: undefined | null | TObject,
        path: TKey | [TKey],
        defaultValue: TDefault,
    ): TDefault | Exclude<TObject[TKey], undefined>

  • Type Parameters

    • TObject extends object
    • TKey extends string | number | symbol
    • TDefault

    Parameters

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

    See

    _.get

  • get<
        TObject extends object,
        TKey1 extends string | number | symbol,
        TKey2 extends string | number | symbol,
    >(
        object: TObject,
        path: [TKey1, TKey2],
    ): TObject[TKey1][TKey2]

  • Type Parameters

    • TObject extends object
    • TKey1 extends string | number | symbol
    • TKey2 extends string | number | symbol

    Parameters

    Returns TObject[TKey1][TKey2]

    See

    _.get

  • get<
        TObject extends object,
        TKey1 extends string | number | symbol,
        TKey2 extends string | number | symbol,
    >(
        object: undefined | null | TObject,
        path: [TKey1, TKey2],
    ): undefined | NonNullable<TObject[TKey1]>[TKey2]

  • Type Parameters

    • TObject extends object
    • TKey1 extends string | number | symbol
    • TKey2 extends string | number | symbol

    Parameters

    Returns undefined | NonNullable<TObject[TKey1]>[TKey2]

    See

    _.get

  • get<
        TObject extends object,
        TKey1 extends string | number | symbol,
        TKey2 extends string | number | symbol,
        TDefault,
    >(
        object: undefined | null | TObject,
        path: [TKey1, TKey2],
        defaultValue: TDefault,
    ): TDefault | Exclude<NonNullable<TObject[TKey1]>[TKey2], undefined>

  • Type Parameters

    • TObject extends object
    • TKey1 extends string | number | symbol
    • TKey2 extends string | number | symbol
    • TDefault

    Parameters

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

    See

    _.get

  • get<
        TObject extends object,
        TKey1 extends string | number | symbol,
        TKey2 extends string | number | symbol,
        TKey3 extends string | number | symbol,
    >(
        object: TObject,
        path: [TKey1, TKey2, TKey3],
    ): 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

    Returns TObject[TKey1][TKey2][TKey3]

    See

    _.get

  • get<
        TObject extends object,
        TKey1 extends string | number | symbol,
        TKey2 extends string | number | symbol,
        TKey3 extends string | number | symbol,
    >(
        object: undefined | null | TObject,
        path: [TKey1, TKey2, TKey3],
    ): undefined | NonNullable<NonNullable<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

    Returns undefined | NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3]

    See

    _.get

  • get<
        TObject extends object,
        TKey1 extends string | number | symbol,
        TKey2 extends string | number | symbol,
        TKey3 extends string | number | symbol,
        TDefault,
    >(
        object: undefined | null | TObject,
        path: [TKey1, TKey2, TKey3],
        defaultValue: TDefault,
    ):
        | TDefault
        | Exclude<
            NonNullable<NonNullable<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

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

    See

    _.get

  • get<
        TObject extends object,
        TKey1 extends string | number | symbol,
        TKey2 extends string | number | symbol,
        TKey3 extends string | number | symbol,
        TKey4 extends string | number | symbol,
    >(
        object: TObject,
        path: [TKey1, TKey2, TKey3, TKey4],
    ): 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

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

    See

    _.get

  • get<
        TObject extends object,
        TKey1 extends string | number | symbol,
        TKey2 extends string | number | symbol,
        TKey3 extends string | number | symbol,
        TKey4 extends string | number | symbol,
    >(
        object: undefined | null | TObject,
        path: [TKey1, TKey2, TKey3, TKey4],
    ):
        | undefined
        | NonNullable<NonNullable<NonNullable<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

    Returns
        | undefined
        | NonNullable<NonNullable<NonNullable<TObject[TKey1]>[TKey2]>[TKey3]>[TKey4]

    See

    _.get

  • get<
        TObject extends object,
        TKey1 extends string | number | symbol,
        TKey2 extends string | number | symbol,
        TKey3 extends string | number | symbol,
        TKey4 extends string | number | symbol,
        TDefault,
    >(
        object: undefined | null | TObject,
        path: [TKey1, TKey2, TKey3, TKey4],
        defaultValue: TDefault,
    ):
        | TDefault
        | Exclude<
            NonNullable<NonNullable<NonNullable<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

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

    See

    _.get

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

  • Type Parameters

    • T

    Parameters

    • object: NumericDictionary<T>
    • path: number

    Returns T

    See

    _.get

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

  • Type Parameters

    • T

    Parameters

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

    Returns undefined | T

    See

    _.get

  • get<T, TDefault>(
        object: undefined | null | NumericDictionary<T>,
        path: number,
        defaultValue: TDefault,
    ): T | TDefault

  • Type Parameters

    • T
    • TDefault

    Parameters

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

    Returns T | TDefault

    See

    _.get

  • get<TDefault>(
        object: undefined | null,
        path: PropertyPath,
        defaultValue: TDefault,
    ): TDefault

  • Type Parameters

    • TDefault

    Parameters

    Returns TDefault

    See

    _.get

  • get(object: undefined | null, path: PropertyPath): undefined

  • Parameters

    Returns undefined

    See

    _.get

  • get<TObject, TPath extends string>(
        data: TObject,
        path: TPath,
    ): string extends TPath ? any : GetFieldType<TObject, TPath, "Path">

  • Type Parameters

    • TObject
    • TPath extends string

    Parameters

    Returns string extends TPath ? any : GetFieldType<TObject, TPath, "Path">

    See

    _.get

  • get<
        TObject,
        TPath extends string,
        TDefault = GetFieldType<TObject, TPath, "Path">,
    >(
        data: TObject,
        path: TPath,
        defaultValue: TDefault,
    ):
        | TDefault
        | Exclude<GetFieldType<TObject, TPath, "Path">, undefined | null>

  • Type Parameters

    • TObject
    • TPath extends string
    • TDefault = GetFieldType<TObject, TPath, "Path">

    Parameters

    Returns TDefault | Exclude<GetFieldType<TObject, TPath, "Path">, undefined | null>

    See

    _.get

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

  • Parameters

    Returns any

    See

    _.get

Settings

Member Visibility