Function objectGetProperty

objectGetProperty<
    ObjectType extends Record<string, any>,
    KeyType extends string | number | symbol,
    DefaultType,
>(
    object: ObjectType,
    keyOrPath: string | string[] | KeyType,
    defaultValue?: DefaultType,
    valueType?:
        | "string"
        | "number"
        | "boolean"
        | "symbol"
        | "undefined"
        | "object"
        | "function"
        | "map"
        | "null"
        | "error"
        | "asyncfunction"
        | "array"
        | "date"
        | "generatorfunction"
        | "promise"
        | "proxy"
        | "regexp"
        | "set"
        | "weakmap"
        | "weakset",
): DefaultType
| ObjectType[KeyType]
Type Parameters
- ObjectType extends Record<string, any>
- KeyType extends string | number | symbol
- DefaultType
Parameters
- object: ObjectType
  Object to search in
- keyOrPath: string | string[] | KeyType
  String key or array of string to form path
- OptionaldefaultValue: DefaultType
  Default value if path is not exists. Does not replace undefined values
- OptionalvalueType:
      | "string"
      | "number"
      | "boolean"
      | "symbol"
      | "undefined"
      | "object"
      | "function"
      | "map"
      | "null"
      | "error"
      | "asyncfunction"
      | "array"
      | "date"
      | "generatorfunction"
      | "promise"
      | "proxy"
      | "regexp"
      | "set"
      | "weakmap"
      | "weakset"
Returns DefaultType | ObjectType[KeyType]
Value in path or default value
Name
objectGetProperty

Description
Gets the value at path of object.

Since
0.0.47
Deprecated
Use optional chaining instead
```
const value = object?.property?.subProperty ?? "N/A";
```
- Defined in object/get/property.ts:19

Function objectGetProperty

Type Parameters

Parameters

Returns DefaultType | ObjectType[KeyType]

Name

Description

Since

Deprecated

Settings