Tool for Object value retrieval given a string path for node and the browser.
Pathval is a module which you can use to retrieve or set an Object's property for a given String path.
pathval is available on npm. To install it, type:
$ npm install pathval
You can also use it within the browser; install via npm and use the pathval.js file found within the download. For example:
<script src="./node_modules/pathval/pathval.js"></script>The primary export of pathval is an object which has the following methods:
hasProperty(object, name)- Checks whether anobjecthasnamed property or numeric array index.getPathInfo(object, path)- Returns an object with info indicating the value of theparentof that path, thenameof the property we're retrieving and itsvalue.getPathValue(object, path)- Retrieves the value of a property at a givenpathinside anobject'.setPathValue(object, path, value)- Sets thevalueof a property at a givenpathinside anobjectand returns the object in which the property has been set.
var pathval = require('pathval');var pathval = require('pathval');
var obj = { prop: 'a value' };
pathval.hasProperty(obj, 'prop'); // truevar pathval = require('pathval');
var obj = { earth: { country: 'Brazil' } };
pathval.getPathInfo(obj, 'earth.country'); // { parent: { country: 'Brazil' }, name: 'country', value: 'Brazil', exists: true }var pathval = require('pathval');
var obj = { earth: { country: 'Brazil' } };
pathval.getPathValue(obj, 'earth.country'); // 'Brazil'var pathval = require('pathval');
var obj = { earth: { country: 'Brazil' } };
pathval.setPathValue(obj, 'earth.country', 'USA');
obj.earth.country; // 'USA'