object-path-operator

Install

npm install --save object-path-operator
# or
yarn add object-path-operator

API

getProp

function getProp(obj: object, path: PropertyKey[]): unknown

Get object property by path.

const obj = {
  key: ['value']
}

getProp(obj, []) // throw error
getProp(obj, ['key', 0]) // value
getProp(obj, ['key-does-not-exist']) // throw error

tryGetProp

function tryGetProp(obj: object, path: PropertyKey[], defaultValue?: unknown): unknown

const obj = {
  key: ['value']
}

tryGetProp(obj, []) // undefined
tryGetProp(obj, ['key', 0]) // value
tryGetProp(obj, ['key-does-not-exist']) // undefined

setProp

function setProp(obj: object, path: PropertyKey[], value: unknown): boolean

Set object property by path.

const obj = {
  key: ['value']
}

setProp(obj, [], 'new-value') // false
setProp(obj, ['key', 0], 'new-value') // true
setProp(obj, ['newKey'], 'new-value') // true
setProp(obj, ['path', 'does', 'not', 'exist'], 'new-value') // throw error

trySetProp

function trySetProp(
  obj: object
, path: [PropertyKey, ...PropertyKey[]]
, value: unknown
): boolean

const obj = {
  key: ['value']
}

trySetProp(obj, [], 'new-value') // false
trySetProp(obj, ['key', 0], 'new-value') // true
trySetProp(obj, ['newKey'], 'new-value') // true
trySetProp(obj, ['path', 'does', 'not', 'exist'], 'new-value') // false

removeProp

function removeProp(obj: object, path: PropertyKey[]): boolean

Remove object property by path.

const obj = {
  key: ['value']
}

removeProp(obj, []) // throw error
removeProp(obj, ['key', 0]) // true
removeProp(obj, ['key-does-not-exist']) // throw error

tryRemoveProp

function tryRemoveProp(obj: object, path: PropertyKey[]): boolean

const obj = {
  key: ['value']
}

tryRemoveProp(obj, []) // false
tryRemoveProp(obj, ['key', 0]) // true
tryRemoveProp(obj, ['key-does-not-exist']) // false