Skip to content

Commit

Permalink
Merge pull request #45 from lucasfcosta/update-docs-for-set
Browse files Browse the repository at this point in the history
docs: explicitly mention that setPathValue returns the target object
  • Loading branch information
keithamus committed Oct 12, 2016
2 parents fd11b26 + 69b05d9 commit 70dc0a5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ The primary export of `pathval` is an object which has the following methods:
* `hasProperty(object, name)` - Checks whether an `object` has `name`d property or numeric array index.
* `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`.
* `getPathValue(object, path)` - Retrieves the value of a property at a given `path` inside an `object`'.
* `setPathValue(object, path, value)` - Sets the `value` of a property at a given `path` inside an `object`'.
* `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.

```js
var pathval = require('pathval');
Expand Down

0 comments on commit 70dc0a5

Please sign in to comment.