dot-prop
Get, set, or delete a property from a nested object using a dot path
Install
$ npm install dot-prop
Usage
const dotProp = require('dot-prop');
dotProp.get({foo: {bar: 'unicorn'}}, 'foo.bar');
dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep');
dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep', 'default value');
dotProp.get({foo: {'dot.dot': 'unicorn'}}, 'foo.dot\\.dot');
const object = {foo: {bar: 'a'}};
dotProp.set(object, 'foo.bar', 'b');
console.log(object);
const foo = dotProp.set({}, 'foo.bar', 'c');
console.log(foo);
dotProp.set(object, 'foo.baz', 'x');
console.log(object);
dotProp.has({foo: {bar: 'unicorn'}}, 'foo.bar');
const object = {foo: {bar: 'a'}};
dotProp.delete(object, 'foo.bar');
console.log(object);
object.foo.bar = {x: 'y', y: 'x'};
dotProp.delete(object, 'foo.bar.x');
console.log(object);
API
get(object, path, defaultValue?)
Get the value of the property at the given path.
Returns the value if any.
set(object, path, value)
Set the property at the given path to the given value.
Returns the object.
has(object, path)
Check whether the property at the given path exists.
Returns a boolean.
delete(object, path)
Delete the property at the given path.
Returns a boolean of whether the property existed before being deleted.
object
Type: object
Object to get, set, or delete the path
value.
You are allowed to pass in undefined
as the object to the get
and has
functions.
path
Type: string
Path of the property in the object, using .
to separate each nested key.
Use \\.
if you have a .
in the key.
The following path components are invalid and results in undefined
being returned: __proto__
, prototype
, constructor
.
value
Type: unknown
Value to set at path
.
defaultValue
Type: unknown
Default value.