diff options
| author | ruki <waruqi@gmail.com> | 2018-11-08 00:38:48 +0800 |
|---|---|---|
| committer | ruki <waruqi@gmail.com> | 2018-11-07 21:53:09 +0800 |
| commit | 26105034da4fcce7ac883c899d781f016559310d (patch) | |
| tree | c459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/camelcase-keys/readme.md | |
| parent | 2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff) | |
| download | xmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip | |
switch to vuepress
Diffstat (limited to 'node_modules/camelcase-keys/readme.md')
| -rw-r--r-- | node_modules/camelcase-keys/readme.md | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/node_modules/camelcase-keys/readme.md b/node_modules/camelcase-keys/readme.md new file mode 100644 index 00000000..1d7adc0c --- /dev/null +++ b/node_modules/camelcase-keys/readme.md @@ -0,0 +1,72 @@ +# camelcase-keys [](https://travis-ci.org/sindresorhus/camelcase-keys) + +> Convert object keys to camelCase using [`camelcase`](https://github.com/sindresorhus/camelcase) + + +## Install + +``` +$ npm install --save camelcase-keys +``` + + +## Usage + +```js +const camelcaseKeys = require('camelcase-keys'); + +// Convert an object +camelcaseKeys({'foo-bar': true}); +//=> {fooBar: true} + +// Convert an array of objects +camelcaseKeys([{'foo-bar': true}, {'bar-foo': false}]); +//=> [{fooBar: true}, {barFoo: false}] + +camelcaseKeys({'foo-bar': true, nested: {unicorn_rainbow: true}}, {deep: true}); +//=> {fooBar: true, nested: {unicornRainbow: true}} +``` + +```js +const camelcaseKeys = require('camelcase-keys'); + +const argv = require('minimist')(process.argv.slice(2)); +//=> {_: [], 'foo-bar': true} + +camelcaseKeys(argv); +//=> {_: [], fooBar: true} +``` + + +## API + +### camelcaseKeys(input, [options]) + +#### input + +Type: `Object` `Object[]` + +Object or array of objects to camelCase. + +#### options + +Type: `Object` + +##### exclude + +Type: `string[]` `RegExp[]`<br> +Default: `[]` + +Exclude keys from being camelCased. + +##### deep + +Type: `boolean`<br> +Default: `false` + +Recurse nested objects and objects in arrays. + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |
