expand-object 
Expand a string into a JavaScript object using a simple notation. Use the CLI or as a node.js lib.
- Install
- Install
- CLI
- node.js
- Usage examples
- Related projects
- Running tests
- Contributing
- Author
- License
(TOC generated by verb using markdown-toc)
Install
Install with npm
$ npm i expand-object --saveAlso see collapse-object, for doing the reverse of this library.
Examples
//=> {a: ''} //=> {a: {b: ''}} //=> {a: '', b: ''} //=> {a: true, b: true} //=> {a: 'b'} //=> ['a', 'b']Type casting
Introduced in v0.2.2, some values are cast to their JavaScript type.
Booleans
If the value is "true" or "false" it will be coerced to a boolean value.
//=> {a: true}//=> {a: false}Numbers
If the value is an integer it will be coerced to a number.
//=> {a: 1}//=> {a: 123}Regex
If the value is a simple regular expression it will be coerced to a new RegExp().
//=> {a: /foo/}//=> {a: {b: {c: /^bar/gmi}}}Install
Install with npm
$ npm i expand-object --saveCLI
Usage with cli:
❯ expand-object --help Usage: expand-object [options] <string> Expand a string into a JavaScript object using a simple notation. Options: -h, --help output usage information -V, --version output the version number -r, --raw Output as raw javascript object - not stringified Examples: $ expand-object "a:b" $ expand-object --raw "a:b" $ echo "a:b" | expand-objectnode.js
To use as a node.js library:
var expand = ;children
Expand dots into child objects:
//=> {a: ''}//=> {a: {b: ''}}//=> {a: {b: {c: ''}}}//=> {a: {b: {c: {d: ''}}}}siblings
expand-object supports two kinds of siblings, general and adjacent. It's much easier to understand the difference in the last example.
general siblings
Use pipes (
|) to expand general siblings:
//=> {a: '', b: ''}//=> {a: '', b: '', c: ''}//=> {a: '', b: '', c: '', d: ''}//=> {a: 'b', c: 'd'}adjacent siblings
Use plus (
+) to expand adjacent siblings:
Adjacent siblings are objects that immediately follow one another.
//=> {a: 'b', c: 'd'}//=> {a: {b: 'c', d: 'e'}}difference between sibling types
In the example below:
- general:
dis a sibling toa - adjacent:
dis a sibling tob
// general siblings//=> { a: { b: 'c' }, d: 'e' } // adjacent siblings//=> { a: { b: 'c', d: 'e' } }key-value pairs
Expand colons into key-value pairs:
//=> {a: 'b'}//=> {a: {b: 'c'}}//=> {a: {b: {c: 'd'}}}arrays
Expand comma separated values into arrays:
//=> ['a', 'b']//=> ['a', 'b', 'c']//=> {a: ['b', 'c', 'd'], e: ['f', 'g', 'h']}Usage examples
Expand siblings with comma separated values into arrays:
//=> {a: ['b', 'c', 'd'], e: ['f', 'g', 'h']}Expand children with comma separated values into arrays:
//=> {a: { b: {c: ['d', 'e', 'f']}}, g: {h: ['i', 'j', 'k']}}Expand sibling objects into key-value pairs:
//=> {a: 'b', c: 'd'}//=> {a: 'b', c: 'd', e: 'f'}//=> {a: 'b', c: 'd', e: 'f', g: 'h'}Expand child objects into key-value pairs:
//=> {a: {b: 'c'}}//=> {a: {b: {c: 'd'}}}//=> {a: {b: {c: {d: 'e'}}}}Expand sibling and child objects into key-value pairs:
//=> {a: 'b', c: 'd'}//=> {a: {b: {c: ''}}, d: {e: 'f'}}//=> {a: {b: 'c'}, d: {e: 'f'}}//=> {a: {b: {c: 'd'}}, e: {f: {g: 'h'}}}Related projects
expand-args: Expand parsed command line arguments using expand-object. | homepage
Running tests
Install dev dependencies:
$ npm i -d && npm testContributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Author
Jon Schlinkert
License
Copyright © 2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb on December 23, 2015.