Function getIn

Safely traverses object along a typed path tuple and returns the value at that location, or defaultValue if any step along the way is null or undefined.

Supports plain objects, arrays (including negative indices), and Maps.
Every position in the path tuple is autocompleted and type-checked by the language server — including positions that follow numeric array indices.
Paths up to depth 6 have fully inferred return types. Deeper paths compile without error but return unknown.

Note: passing undefined as defaultValue is indistinguishable from omitting it — the function cannot tell whether a key is missing or explicitly holds undefined.

Example: Basic property access

getIn(data, ['user', 'profile', 'name'])
// 'Alice'

Example: Through an array

getIn(data, ['user', 'profile', 'addresses', 0, 'city'])
// 'NYC'

Example: With a default value for a missing / undefined key

getIn(data, ['user', 'profile', 'age'], 25)
// 25

Example: Negative array index (Python-style)

getIn(['a', 'b', 'c'], [-1])
// 'c'

Example: With a Map

const map = new Map([['key', { value: 42 }]]);
getIn(map, ['key', 'value'])
// 42

Template: T

The root object type.

Template: D

The type of the fallback default value.

Param: object

The root value to traverse.

Param: path

Tuple of string keys or numeric indices describing the path.

Param: defaultValue

Returned when the resolved value is undefined.

Returns

The value at the given path, or defaultValue if any step is nullish.

getIn<T>(object: T, path: []): T
Type Parameters
- T
Parameters
- object: T
- path: []
Returns T
- Defined in core/get-in.ts:90
getIn<T, K0 extends string | number, D>(
    object: T,
    path: [K0],
    defaultValue: D,
): D | Exclude<Step<T, K0>, undefined>
Type Parameters
- T
- K0 extends string | number
- D
Parameters
- object: T
- path: [K0]
- defaultValue: D
Returns D | Exclude<Step<T, K0>, undefined>
- Defined in core/get-in.ts:92
getIn<T, K0 extends string | number>(object: T, path: [K0]): Step<T, K0>
Type Parameters
- T
- K0 extends string | number
Parameters
- object: T
- path: [K0]
Returns Step<T, K0>
- Defined in core/get-in.ts:97
getIn<T, K0 extends string | number, K1 extends string | number, D>(
    object: T,
    path: [K0, K1],
    defaultValue: D,
): D | Exclude<Step<Step<T, K0>, K1>, undefined>
Type Parameters
- T
- K0 extends string | number
- K1 extends string | number
- D
Parameters
- object: T
- path: [K0, K1]
- defaultValue: D
Returns D | Exclude<Step<Step<T, K0>, K1>, undefined>
- Defined in core/get-in.ts:99
getIn<T, K0 extends string | number, K1 extends string | number>(
object: T,
path: [K0, K1],
): Step<Step<T, K0>, K1>
Type Parameters
- T
- K0 extends string | number
- K1 extends string | number
Parameters
- object: T
- path: [K0, K1]
Returns Step<Step<T, K0>, K1>
- Defined in core/get-in.ts:104
getIn<
    T,
    K0 extends string | number,
    K1 extends string | number,
    K2 extends string | number,
    D,
>(
    object: T,
    path: [K0, K1, K2],
    defaultValue: D,
): D | Exclude<Step<Step<Step<T, K0>, K1>, K2>, undefined>
Type Parameters
- T
- K0 extends string | number
- K1 extends string | number
- K2 extends string | number
- D
Parameters
- object: T
- path: [K0, K1, K2]
- defaultValue: D
Returns D | Exclude<Step<Step<Step<T, K0>, K1>, K2>, undefined>
- Defined in core/get-in.ts:109
getIn<
    T,
    K0 extends string | number,
    K1 extends string | number,
    K2 extends string | number,
>(
    object: T,
    path: [K0, K1, K2],
): Step<Step<Step<T, K0>, K1>, K2>
Type Parameters
- T
- K0 extends string | number
- K1 extends string | number
- K2 extends string | number
Parameters
- object: T
- path: [K0, K1, K2]
Returns Step<Step<Step<T, K0>, K1>, K2>
- Defined in core/get-in.ts:116
getIn<
    T,
    K0 extends string | number,
    K1 extends string | number,
    K2 extends string | number,
    K3 extends string | number,
    D,
>(
    object: T,
    path: [K0, K1, K2, K3],
    defaultValue: D,
): D | Exclude<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, undefined>
Type Parameters
- T
- K0 extends string | number
- K1 extends string | number
- K2 extends string | number
- K3 extends string | number
- D
Parameters
- object: T
- path: [K0, K1, K2, K3]
- defaultValue: D
Returns D | Exclude<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, undefined>
- Defined in core/get-in.ts:123
getIn<
    T,
    K0 extends string | number,
    K1 extends string | number,
    K2 extends string | number,
    K3 extends string | number,
>(
    object: T,
    path: [K0, K1, K2, K3],
): Step<Step<Step<Step<T, K0>, K1>, K2>, K3>
Type Parameters
- T
- K0 extends string | number
- K1 extends string | number
- K2 extends string | number
- K3 extends string | number
Parameters
- object: T
- path: [K0, K1, K2, K3]
Returns Step<Step<Step<Step<T, K0>, K1>, K2>, K3>
- Defined in core/get-in.ts:131
getIn<
    T,
    K0 extends string | number,
    K1 extends string | number,
    K2 extends string | number,
    K3 extends string | number,
    K4 extends string | number,
    D,
>(
    object: T,
    path: [K0, K1, K2, K3, K4],
    defaultValue: D,
):
    | D
    | Exclude<Step<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, K4>, undefined>
Type Parameters
- T
- K0 extends string | number
- K1 extends string | number
- K2 extends string | number
- K3 extends string | number
- K4 extends string | number
- D
Parameters
- object: T
- path: [K0, K1, K2, K3, K4]
- defaultValue: D
Returns D | Exclude<Step<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, K4>, undefined>
- Defined in core/get-in.ts:139
getIn<
    T,
    K0 extends string | number,
    K1 extends string | number,
    K2 extends string | number,
    K3 extends string | number,
    K4 extends string | number,
>(
    object: T,
    path: [K0, K1, K2, K3, K4],
): Step<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, K4>
Type Parameters
- T
- K0 extends string | number
- K1 extends string | number
- K2 extends string | number
- K3 extends string | number
- K4 extends string | number
Parameters
- object: T
- path: [K0, K1, K2, K3, K4]
Returns Step<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, K4>
- Defined in core/get-in.ts:148
getIn<
    T,
    K0 extends string | number,
    K1 extends string | number,
    K2 extends string | number,
    K3 extends string | number,
    K4 extends string | number,
    K5 extends string | number,
    D,
>(
    object: T,
    path: [K0, K1, K2, K3, K4, K5],
    defaultValue: D,
):
    | D
    | Exclude<
        Step<Step<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, K4>, K5>,
        undefined,
    >
Type Parameters
- T
- K0 extends string | number
- K1 extends string | number
- K2 extends string | number
- K3 extends string | number
- K4 extends string | number
- K5 extends string | number
- D
Parameters
- object: T
- path: [K0, K1, K2, K3, K4, K5]
- defaultValue: D
Returns
    | D
    | Exclude<
        Step<Step<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, K4>, K5>,
        undefined,
    >
- Defined in core/get-in.ts:157
getIn<
    T,
    K0 extends string | number,
    K1 extends string | number,
    K2 extends string | number,
    K3 extends string | number,
    K4 extends string | number,
    K5 extends string | number,
>(
    object: T,
    path: [K0, K1, K2, K3, K4, K5],
): Step<Step<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, K4>, K5>
Type Parameters
- T
- K0 extends string | number
- K1 extends string | number
- K2 extends string | number
- K3 extends string | number
- K4 extends string | number
- K5 extends string | number
Parameters
- object: T
- path: [K0, K1, K2, K3, K4, K5]
Returns Step<Step<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, K4>, K5>
- Defined in core/get-in.ts:171
getIn(
    object: unknown,
    path: [
        string
        | number,
        string | number,
        string | number,
        string | number,
        string | number,
        string | number,
        string | number,
        ...(string | number)[],
    ],
    defaultValue?: unknown,
): unknown
Parameters
- object: unknown
- path: [
      string
      | number,
      string | number,
      string | number,
      string | number,
      string | number,
      string | number,
      string | number,
      ...(string | number)[],
  ]
- OptionaldefaultValue: unknown
Returns unknown
- Defined in core/get-in.ts:181

Function getIn

Example: Basic property access

Example: Through an array

Example: With a default value for a missing / undefined key

Example: Negative array index (Python-style)

Example: With a Map

Template: T

Template: D

Param: object

Param: path

Param: defaultValue

Returns

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns D | Exclude<Step<T, K0>, undefined>

Type Parameters

Parameters

Returns Step<T, K0>

Type Parameters

Parameters

Returns D | Exclude<Step<Step<T, K0>, K1>, undefined>

Type Parameters

Parameters

Returns Step<Step<T, K0>, K1>

Type Parameters

Parameters

Returns D | Exclude<Step<Step<Step<T, K0>, K1>, K2>, undefined>

Type Parameters

Parameters

Returns Step<Step<Step<T, K0>, K1>, K2>

Type Parameters

Parameters

Returns D | Exclude<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, undefined>

Type Parameters

Parameters

Returns Step<Step<Step<Step<T, K0>, K1>, K2>, K3>

Type Parameters

Parameters

Returns D | Exclude<Step<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, K4>, undefined>

Type Parameters

Parameters

Returns Step<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, K4>

Type Parameters

Parameters

Returns | D | Exclude< Step<Step<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, K4>, K5>, undefined, >

Type Parameters

Parameters

Returns Step<Step<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, K4>, K5>

Parameters

Returns unknown

Settings

Returns
| D
| Exclude<
Step<Step<Step<Step<Step<Step<T, K0>, K1>, K2>, K3>, K4>, K5>,
undefined,
>