dot-prop

Get, set, or delete a property from a nested object using a dot path

Install

1npm install dot-prop

Usage

1import {getProperty, setProperty, hasProperty, deleteProperty} from 'dot-prop';
2
3// Getter
4getProperty({foo: {bar: 'unicorn'}}, 'foo.bar');
5//=> 'unicorn'
6
7getProperty({foo: {bar: 'a'}}, 'foo.notDefined.deep');
8//=> undefined
9
10getProperty({foo: {bar: 'a'}}, 'foo.notDefined.deep', 'default value');
11//=> 'default value'
12
13getProperty({foo: {'dot.dot': 'unicorn'}}, 'foo.dot\\.dot');
14//=> 'unicorn'
15
16getProperty({foo: [{bar: 'unicorn'}]}, 'foo[0].bar');
17//=> 'unicorn'
18
19// Setter
20const object = {foo: {bar: 'a'}};
21setProperty(object, 'foo.bar', 'b');
22console.log(object);
23//=> {foo: {bar: 'b'}}
24
25const foo = setProperty({}, 'foo.bar', 'c');
26console.log(foo);
27//=> {foo: {bar: 'c'}}
28
29setProperty(object, 'foo.baz', 'x');
30console.log(object);
31//=> {foo: {bar: 'b', baz: 'x'}}
32
33setProperty(object, 'foo.biz[0]', 'a');
34console.log(object);
35//=> {foo: {bar: 'b', baz: 'x', biz: ['a']}}
36
37// Has
38hasProperty({foo: {bar: 'unicorn'}}, 'foo.bar');
39//=> true
40
41// Deleter
42const object = {foo: {bar: 'a'}};
43deleteProperty(object, 'foo.bar');
44console.log(object);
45//=> {foo: {}}
46
47object.foo.bar = {x: 'y', y: 'x'};
48deleteProperty(object, 'foo.bar.x');
49console.log(object);
50//=> {foo: {bar: {y: 'x'}}}

API

getProperty(object, path, defaultValue?)

Get the value of the property at the given path.

Returns the value if any.

setProperty(object, path, value)

Set the property at the given path to the given value.

Returns the object.

hasProperty(object, path)

Check whether the property at the given path exists.

Returns a boolean.

deleteProperty(object, path)

Delete the property at the given path.

Returns a boolean of whether the property existed before being deleted.

escapePath(path)

Escape special characters in a path. Useful for sanitizing user input.

1import {getProperty, escapePath} from 'dot-prop';
2
3const object = {
4	foo: {
5		bar: '👸🏻 You found me Mario!',
6	},
7	'foo.bar' : '🍄 The princess is in another castle!',
8};
9const escapedPath = escapePath('foo.bar');
10
11console.log(getProperty(object, escapedPath));
12//=> '🍄 The princess is in another castle!'

deepKeys(object)

Returns an array of every path. Non-empty plain objects and arrays are deeply recursed and are not themselves included.

This can be useful to help flatten an object for an API that only accepts key-value pairs or for a tagged template literal.

1import {getProperty, deepKeys} from 'dot-prop';
2
3const user = {
4	name: {
5		first: 'Richie',
6		last: 'Bendall',
7	},
8	activeTasks: [],
9	currentProject: null
10};
11
12for (const property of deepKeys(user)) {
13	console.log(`${property}: ${getProperty(user, property)}`);
14	//=> name.first: Richie
15	//=> name.last: Bendall
16	//=> activeTasks: []
17	//=> currentProject: null
18}

Sparse arrays are supported. In general, avoid using sparse arrays.

object

Type: object | array

Object or array 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.