Skip to content

Commit c2a3e1d

Browse files
author
Mark Lagendijk
committed
Added examples
1 parent b4f0f4d commit c2a3e1d

File tree

2 files changed

+101
-2
lines changed

2 files changed

+101
-2
lines changed

README.md

Lines changed: 100 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,26 @@ The dot separated propertyPath.
2323
#### returns
2424
Type: `boolean`
2525

26+
``` javascript
27+
var object = {
28+
level1: {
29+
level2: Object.create({
30+
level3: {
31+
value: 'value 3'
32+
}
33+
})
34+
}
35+
};
36+
_.deepIn(object, 'level1');
37+
// -> true
38+
_.deepIn(object, 'level1.level2');
39+
// -> true
40+
_.deepIn(object, 'level1.level2.level3');
41+
// -> true
42+
_.deepIn(object, 'level1.level2.level3.value');
43+
// -> true
44+
```
45+
2646
### _.deepHas(object, propertyPath)
2747
Executes a deep check for the existence of a *own* property in an object tree.
2848

@@ -39,6 +59,26 @@ The dot separated propertyPath.
3959
#### returns
4060
Type: `boolean`
4161

62+
``` javascript
63+
var object = {
64+
level1: {
65+
level2: Object.create({
66+
level3: {
67+
value: 'value 3'
68+
}
69+
})
70+
}
71+
};
72+
_.deepHas(object, 'level1');
73+
// -> true
74+
_.deepHas(object, 'level1.level2');
75+
// -> true
76+
_.deepHas(object, 'level1.level2.level3');
77+
// -> false
78+
_.deepHas(object, 'level1.level2.level3.value');
79+
// -> false
80+
```
81+
4282
### _.deepGetValue(object, propertyPath)
4383
Retreives the value of a property in an object tree.
4484

@@ -57,6 +97,25 @@ Type: `*|undefined`
5797

5898
The value, or undefined if it doesn't exists.
5999

100+
``` javascript
101+
var object = {
102+
level1: {
103+
value: 'value 1',
104+
level2: Object.create({
105+
level3: {
106+
value: 'value 3'
107+
}
108+
})
109+
}
110+
};
111+
_.deepGetValue(object, 'level1.value');
112+
// -> 'value 1'
113+
_.deepGetValue(object, 'level1.level2.level3.value');
114+
// -> 'value 3'
115+
_.deepGetValue(object, 'foo.bar.baz');
116+
// -> undefined
117+
```
118+
60119
### _.deepGetOwnValue(object, propertyPath)
61120
Retreives the value of a *own* property in an object tree.
62121

@@ -75,6 +134,25 @@ Type: `*|undefined`
75134

76135
The value, or undefined if it doesn't exists.
77136

137+
``` javascript
138+
var object = {
139+
level1: {
140+
value: 'value 1',
141+
level2: Object.create({
142+
level3: {
143+
value: 'value 3'
144+
}
145+
})
146+
}
147+
};
148+
_.deepGetOwnValue(object, 'level1.value');
149+
// -> 'value 1'
150+
_.deepGetOwnValue(object, 'level1.level2.level3.value');
151+
// -> undefined
152+
_.deepGetOwnValue(object, 'foo.bar.baz');
153+
// -> undefined
154+
```
155+
78156
### _.deepSetValue(object, propertyPath, value)
79157
Executes a deep check for the existence of a own property in an object tree.
80158

@@ -96,6 +174,14 @@ The value to set.
96174
#### returns
97175
Type: `Object`
98176

177+
``` javascript
178+
var object = {};
179+
_.deepSetValue(object, 'level1.level2.level3.value', 'value 3');
180+
// -> { level1: { level2: { level3: { value: 'value 3' }}}}
181+
_.deepSetValue(object, 'level1.level2.level3.value', 'foo');
182+
// -> { level1: { level2: { level3: { value: 'foo' }}}}
183+
```
184+
99185
### _.deepPluck(collection, propertyPath)
100186
Executes a deep pluck on an collection of object trees.
101187

@@ -110,4 +196,17 @@ Type: `string`
110196
The dot separated propertyPath.
111197

112198
#### returns
113-
Type: `Object|Array`
199+
Type: `Array`
200+
201+
``` javascript
202+
var collection = [
203+
{ level1: { level2: { level3: { value: 1 }}}},
204+
{ level1: { level2: { level3: { value: 2 }}}},
205+
{ level1: { level2: { level3: { value: 3 }}}},
206+
{ level1: { level2: { level3: { value: 4 }}}},
207+
{ level1: { level2: {} }},
208+
{}
209+
];
210+
_.deepPluck(collection, 'level1.level2.level3.value');
211+
// -> [ 1, 2, 3, 4, undefined, undefined ]
212+
```

lodash.deep.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
* Executes a deep pluck on an collection of object trees.
109109
* @param {Object|Array} collection - The collection of object trees.
110110
* @param {string} propertyPath - The dot separated propertyPath.
111-
* @returns {Object|Array}
111+
* @returns {Array}
112112
*/
113113
deepPluck: function(collection, propertyPath){
114114
return _.map(collection, function(item){

0 commit comments

Comments
 (0)