@aleclarson/deep

deep

Woah. That's deep.

import deep from '@aleclarson/deep'
// or
import { get, set, unset } from '@aleclarson/deep'

let val
val = deep.get(obj, 'a.b.c') // dot-notation
val = deep.get(obj, ['a', 'b', 'c']) // key path
val = deep.get(obj, 'a', 0) // default value
val = deep.set(obj, 'a', 1) // type-safe shallow keys
val = deep.unset(obj, 'a') // delete an optional property
val = deep.delete(obj, 'a') // "delete" is an alias for "unset"
val = deep.delete(obj, 'a', 0) // default value

The get function returns either the default value or undefined when a property cannot be resolved.

The set function returns the new value. When a parent is nullish, an object is created on-the-fly. When a parent is a non-nullish non-object, an error is thrown.

The unset function returns the old value. When a property cannot be resolved, this function is a no-op.

 

Inspiration

• dlv: https://github.com/developit/dlv
• dset: https://github.com/lukeed/dset

 

License

MIT