Skip to content

Commit 70dc0a5

Browse files
authoredOct 12, 2016
Merge pull request #45 from lucasfcosta/update-docs-for-set
docs: explicitly mention that setPathValue returns the target object
2 parents fd11b26 + 69b05d9 commit 70dc0a5

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed
 

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ The primary export of `pathval` is an object which has the following methods:
100100
* `hasProperty(object, name)` - Checks whether an `object` has `name`d property or numeric array index.
101101
* `getPathInfo(object, path)` - Returns an object with info indicating the value of the `parent` of that path, the `name ` of the property we're retrieving and its `value`.
102102
* `getPathValue(object, path)` - Retrieves the value of a property at a given `path` inside an `object`'.
103-
* `setPathValue(object, path, value)` - Sets the `value` of a property at a given `path` inside an `object`'.
103+
* `setPathValue(object, path, value)` - Sets the `value` of a property at a given `path` inside an `object` and returns the object in which the property has been set.
104104

105105
```js
106106
var pathval = require('pathval');

0 commit comments

Comments
 (0)
Please sign in to comment.