Blame view

node_modules/to-object-path/README.md 2.32 KB
aaac7fed   liuqimichale   add
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
  # to-object-path [![NPM version](https://badge.fury.io/js/to-object-path.svg)](http://badge.fury.io/js/to-object-path)
  
  > Create an object path from a list or array of strings.
  
  ## Install
  
  Install with [npm](https://www.npmjs.com/)
  
  ```sh
  $ npm i to-object-path --save
  ```
  
  ## Usage
  
  ```js
  var toPath = require('to-object-path');
  
  toPath('foo', 'bar', 'baz');
  toPath('foo', ['bar', 'baz']);
  //=> 'foo.bar.baz'
  ```
  
  Also supports passing an arguments object (without having to slice args):
  
  ```js
  function foo()
    return toPath(arguments);
  }
  
  foo('foo', 'bar', 'baz');
  foo('foo', ['bar', 'baz']);
  //=> 'foo.bar.baz'
  ```
  
  Visit the [example](./example.js) to see how this could be used in an application.
  
  ## Related projects
  
  * [get-value](https://www.npmjs.com/package/get-value): Use property paths (`  a.b.c`) to get a nested value from an object. | [homepage](https://github.com/jonschlinkert/get-value)
  * [has-value](https://www.npmjs.com/package/has-value): Returns true if a value exists, false if empty. Works with deeply nested values using… [more](https://www.npmjs.com/package/has-value) | [homepage](https://github.com/jonschlinkert/has-value)
  * [omit-value](https://www.npmjs.com/package/omit-value): Omit properties from an object or deeply nested property of an object using object path… [more](https://www.npmjs.com/package/omit-value) | [homepage](https://github.com/jonschlinkert/omit-value)
  * [set-value](https://www.npmjs.com/package/set-value): Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths. | [homepage](https://github.com/jonschlinkert/set-value)
  * [unset-value](https://www.npmjs.com/package/unset-value): Delete nested properties from an object using dot notation. | [homepage](https://github.com/jonschlinkert/unset-value)
  
  ## Running tests
  
  Install dev dependencies:
  
  ```sh
  $ npm i -d && npm test
  ```
  
  ## Contributing
  
  Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/to-object-path/issues/new).
  
  ## Author
  
  **Jon Schlinkert**
  
  + [github/jonschlinkert](https://github.com/jonschlinkert)
  + [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
  
  ## License
  
  Copyright © 2015 Jon Schlinkert
  Released under the MIT license.
  
  ***
  
  _This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on October 28, 2015._