File size: 4,027 Bytes
369fac9 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
<h1 align=center>
<a href="http://chaijs.com" title="Chai Documentation">
<img alt="ChaiJS" src="http://chaijs.com/img/chai-logo.png">
</a>
<br>
pathval
</h1>
<p align=center>
Tool for Object value retrieval given a string path for <a href="http://nodejs.org">node</a> and the browser.
</p>
<p align=center>
<a href="./LICENSE">
<img
alt="license:mit"
src="https://img.shields.io/badge/license-mit-green.svg?style=flat-square"
/>
</a>
<a href="https://github.com/chaijs/pathval/releases">
<img
alt="tag:?"
src="https://img.shields.io/github/tag/chaijs/pathval.svg?style=flat-square"
/>
</a>
<a href="https://travis-ci.org/chaijs/pathval">
<img
alt="build:?"
src="https://img.shields.io/travis/chaijs/pathval/master.svg?style=flat-square"
/>
</a>
<a href="https://coveralls.io/r/chaijs/pathval">
<img
alt="coverage:?"
src="https://img.shields.io/coveralls/chaijs/pathval/master.svg?style=flat-square"
/>
</a>
<a href="https://www.npmjs.com/packages/pathval">
<img
alt="npm:?"
src="https://img.shields.io/npm/v/pathval.svg?style=flat-square"
/>
</a>
<a href="https://www.npmjs.com/packages/pathval">
<img
alt="dependencies:?"
src="https://img.shields.io/npm/dm/pathval.svg?style=flat-square"
/>
</a>
<a href="">
<img
alt="devDependencies:?"
src="https://img.shields.io/david/chaijs/pathval.svg?style=flat-square"
/>
</a>
<br/>
<a href="https://saucelabs.com/u/chaijs-pathval">
<img
alt="Selenium Test Status"
src="https://saucelabs.com/browser-matrix/chaijs-pathval.svg"
/>
</a>
<br>
<a href="https://chai-slack.herokuapp.com/">
<img
alt="Join the Slack chat"
src="https://img.shields.io/badge/slack-join%20chat-E2206F.svg?style=flat-square"
/>
</a>
<a href="https://gitter.im/chaijs/chai">
<img
alt="Join the Gitter chat"
src="https://img.shields.io/badge/gitter-join%20chat-D0104D.svg?style=flat-square"
/>
</a>
</p>
## What is pathval?
Pathval is a module which you can use to retrieve or set an Object's property for a given `String` path.
## Installation
### Node.js
`pathval` is available on [npm](http://npmjs.org). To install it, type:
$ npm install pathval
### Browsers
You can also use it within the browser; install via npm and use the `pathval.js` file found within the download. For example:
```html
<script src="./node_modules/pathval/pathval.js"></script>
```
## Usage
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` and returns the object in which the property has been set.
```js
var pathval = require('pathval');
```
#### .hasProperty(object, name)
```js
var pathval = require('pathval');
var obj = { prop: 'a value' };
pathval.hasProperty(obj, 'prop'); // true
```
#### .getPathInfo(object, path)
```js
var pathval = require('pathval');
var obj = { earth: { country: 'Brazil' } };
pathval.getPathInfo(obj, 'earth.country'); // { parent: { country: 'Brazil' }, name: 'country', value: 'Brazil', exists: true }
```
#### .getPathValue(object, path)
```js
var pathval = require('pathval');
var obj = { earth: { country: 'Brazil' } };
pathval.getPathValue(obj, 'earth.country'); // 'Brazil'
```
#### .setPathValue(object, path, value)
```js
var pathval = require('pathval');
var obj = { earth: { country: 'Brazil' } };
pathval.setPathValue(obj, 'earth.country', 'USA');
obj.earth.country; // 'USA'
```
|