Build an array of key paths from an object.
Please consider following this project's author, Brian Woodward, and consider starring the project to show your ❤️ and support.
Install with npm:
$ npm install --save stringify-keysvar stringify = require('stringify-keys');
var obj = { a: 'a', b: { c: { d: { e: 'f' } } } };
console.log(stringify(obj));
//=> [ 'a', 'b.c.d.e', 'b.c.d', 'b.c', 'b' ]Keys with dots are automatically escaped with backslashes (this can be customized):
var obj = { 'a.b.c': { d: 'e' } };
console.log(stringify(obj));
//=> [ 'a\\.b\\.c.d', 'a\\.b\\.c' ]Type: string
Default: .
Custom separator to use for creating object paths (a.b.c):
Example
var obj = { 'a.b.c': { d: 'e' } };
console.log(stringify(obj, { separator: '/' }));
//=> [ 'a.b.c/d', 'a.b.c' ]Type: function
Default: adds \\ before dots
Custom function to use for escaping keys.
Example
var obj = { 'a.b.c': { d: 'e' } };
var result = stringify(obj, {
escape: str => str.split('.').join('/')
});
console.log(result);
//=> [ 'a/b/c.d', 'a/b/c' ]Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm testBuilding docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verbYou might also be interested in these projects:
- expand-hash: Recursively expands property keys with dot-notation into objects. | homepage
- expand-object: Expand a string into a JavaScript object using a simple notation. Use the CLI or… more | homepage
- glob-object: Filter an object using glob patterns and dot notation. | homepage
- kind-of: Get the native type of a value. | homepage
| Commits | Contributor |
|---|---|
| 17 | jonschlinkert |
| 12 | doowb |
Brian Woodward
Copyright © 2018, Brian Woodward. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on May 15, 2018.