Class DeepObject

Selective Utilities

Hierarchy

DeepObject

Index

Constructors

constructor

Properties

obj

Methods

Constructors

constructor

new DeepObject(obj?: Record<string, any>): DeepObject

- Defined in utility/deepObject.ts:12
Parameters
- Optional obj: Record<string, any>
Returns DeepObject

Properties

obj

obj: Record<string, any>

Methods

get

get(key: string): any

- Defined in utility/deepObject.ts:21
Allows for accessing nested values in an object with a single reference.

Parameters
- key: string
  
  Period separated reference to the deep value.
Returns any

keys

keys(): string[]

- Defined in utility/deepObject.ts:47
Determine all of the 'key' references for a deep object.
```
{ foo: { bar: true } } => ['foo.bar']
```
Returns string[]

set

set(key: string, value: any): void

- Defined in utility/deepObject.ts:81
Set a deep value on the object using a referenced key.

Parameters
- key: string
  
  Period separated reference to the deep value.
- value: any
  
  New value to set at the deep reference.
Returns void

update

update(value?: Record<string, any>): void

- Defined in utility/deepObject.ts:105
Updates the current object with the keys from a new value.

Parameters
- Optional value: Record<string, any>
  
  New object to be added to the existing object.
Returns void

Generated using TypeDoc