222

schangxiang@126.com

2025-06-13 6a8393408d8cefcea02b7a598967de8dc1e565c2

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# dot-prop [![Build Status](https://travis-ci.org/sindresorhus/dot-prop.svg?branch=master)](https://travis-ci.org/sindresorhus/dot-prop)
 
> Get, set, or delete a property from a nested object using a dot path
 
 
## Install
 
```
$ npm install --save dot-prop
```
 
 
## Usage
 
```js
const dotProp = require('dot-prop');
 
// getter
dotProp.get({foo: {bar: 'unicorn'}}, 'foo.bar');
//=> 'unicorn'
 
dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep');
//=> undefined
 
dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep', 'default value');
//=> 'default value'
 
dotProp.get({foo: {'dot.dot': 'unicorn'}}, 'foo.dot\\.dot');
//=> 'unicorn'
 
// setter
const obj = {foo: {bar: 'a'}};
dotProp.set(obj, 'foo.bar', 'b');
console.log(obj);
//=> {foo: {bar: 'b'}}
 
const foo = dotProp.set({}, 'foo.bar', 'c');
console.log(foo);
//=> {foo: {bar: 'c'}}
 
dotProp.set(obj, 'foo.baz', 'x');
console.log(obj);
//=> {foo: {bar: 'b', baz: 'x'}}
 
// has
dotProp.has({foo: {bar: 'unicorn'}}, 'foo.bar');
//=> true
 
// deleter
const obj = {foo: {bar: 'a'}};
dotProp.delete(obj, 'foo.bar');
console.log(obj);
//=> {foo: {}}
 
obj.foo.bar = {x: 'y', y: 'x'};
dotProp.delete(obj, 'foo.bar.x');
console.log(obj);
//=> {foo: {bar: {y: 'x'}}}
```
 
 
## API
 
### get(obj, path, [defaultValue])
 
### set(obj, path, value)
 
Returns the object.
 
### has(obj, path)
 
### delete(obj, path)
 
#### obj
 
Type: `Object`
 
Object to get, set, or delete the `path` value.
 
#### path
 
Type: `string`
 
Path of the property in the object, using `.` to separate each nested key.
 
Use `\\.` if you have a `.` in the key.
 
#### value
 
Type: `any`
 
Value to set at `path`.
 
#### defaultValue
 
Type: `any`
 
Default value.
 
 
## License
 
MIT © [Sindre Sorhus](https://sindresorhus.com)