Module object/path

Index

References

default

Interfaces

Path

Functions

path

References

default

Renames and re-exports path

Functions

path

path<K, O>(path: [K], obj: O): O[K]
path<K>(path: [K]): <O>(obj: O) => O[K]
path<T>(path: Paths, obj: any): T
path<T>(path: Paths): (obj: any) => T

- Defined in object/path.ts:25
Retrieve the value at a given path.
example
```
 path(['a', 'b'], {a: {b: 2}}); //=> 2
 path(['a', 'b'], {c: {b: 2}}); //=> undefined
```
Type parameters
- K: string | number | symbol
- O: Record<K, any>
Parameters
- path: [K]
- obj: O
  
  The object to retrieve the nested property from.
Returns O[K]
The data at path.
- Defined in object/path.ts:25
Retrieve the value at a given path.
example
```
 path(['a', 'b'], {a: {b: 2}}); //=> 2
 path(['a', 'b'], {c: {b: 2}}); //=> undefined
```
Type parameters
- K: string | number | symbol
Parameters
- path: [K]
Returns <O>(obj: O) => O[K]
The data at path.
- - <O>(obj: O): O[K]
  - Type parameters
    - O: Record<K, any>
    Parameters
    - obj: O
    Returns O[K]
- Defined in object/path.ts:25
Retrieve the value at a given path.
example
```
 path(['a', 'b'], {a: {b: 2}}); //=> 2
 path(['a', 'b'], {c: {b: 2}}); //=> undefined
```
Type parameters
- T
Parameters
- path: Paths
- obj: any
  
  The object to retrieve the nested property from.
Returns T
The data at path.
- Defined in object/path.ts:25
Retrieve the value at a given path.
example
```
 path(['a', 'b'], {a: {b: 2}}); //=> 2
 path(['a', 'b'], {c: {b: 2}}); //=> undefined
```
Type parameters
- T
Parameters
- path: Paths
Returns (obj: any) => T
The data at path.
- - (obj: any): T
  - Parameters
    - obj: any
    Returns T

Generated using TypeDoc