\n\n## What is pathval?\n\nPathval is a module which you can use to retrieve or set an Object's property for a given `String` path.\n\n## Installation\n\n### Node.js\n\n`pathval` is available on [npm](http://npmjs.org). To install it, type:\n\n $ npm install pathval\n\n### Browsers\n\nYou can also use it within the browser; install via npm and use the `pathval.js` file found within the download. For example:\n\n```html\n\n```\n\n## Usage\n\nThe primary export of `pathval` is an object which has the following methods:\n\n* `hasProperty(object, name)` - Checks whether an `object` has `name`d property or numeric array index.\n* `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`.\n* `getPathValue(object, path)` - Retrieves the value of a property at a given `path` inside an `object`'.\n* `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.\n\n```js\nvar pathval = require('pathval');\n```\n\n#### .hasProperty(object, name)\n\n```js\nvar pathval = require('pathval');\n\nvar obj = { prop: 'a value' };\npathval.hasProperty(obj, 'prop'); // true\n```\n\n#### .getPathInfo(object, path)\n\n```js\nvar pathval = require('pathval');\n\nvar obj = { earth: { country: 'Brazil' } };\npathval.getPathInfo(obj, 'earth.country'); // { parent: { country: 'Brazil' }, name: 'country', value: 'Brazil', exists: true }\n```\n\n#### .getPathValue(object, path)\n\n```js\nvar pathval = require('pathval');\n\nvar obj = { earth: { country: 'Brazil' } };\npathval.getPathValue(obj, 'earth.country'); // 'Brazil'\n```\n\n#### .setPathValue(object, path, value)\n\n```js\nvar pathval = require('pathval');\n\nvar obj = { earth: { country: 'Brazil' } };\npathval.setPathValue(obj, 'earth.country', 'USA');\n\nobj.earth.country; // 'USA'\n```\n",
"maintainers": [
{ "name": "chaijs", "email": "chaijs@keithcirkel.co.uk" },
{ "name": "chai", "email": "chaijs@keithcirkel.co.uk" }
],
"time": {
"modified": "2022-06-23T14:56:08.461Z",
"created": "2013-11-24T18:10:05.614Z",
"0.0.1": "2013-11-24T18:10:08.847Z",
"0.1.0": "2013-12-28T10:40:59.775Z",
"0.1.1": "2013-12-30T23:14:27.044Z",
"0.2.0": "2016-10-05T00:19:41.579Z",
"0.2.1": "2016-10-05T21:37:43.749Z",
"1.0.0": "2016-10-08T21:59:52.585Z",
"1.1.0": "2016-10-11T21:45:01.397Z",
"1.1.1": "2021-01-26T10:18:37.054Z"
},
"author": { "name": "Veselin Todorov", "email": "hi@vesln.com" },
"repository": {
"type": "git",
"url": "git+ssh://git@github.com/chaijs/pathval.git"
},
"users": { "focusaurus": true, "justjavac": true },
"homepage": "https://github.com/chaijs/pathval",
"bugs": { "url": "https://github.com/chaijs/pathval/issues" },
"license": "MIT",
"readmeFilename": "README.md",
"keywords": ["pathval", "value retrieval", "chai util"]
}
![\"ChaiJS\"](\"http://chaijs.com/img/chai-logo.png\"){kind=logo}
\n \n