aboutsummaryrefslogtreecommitdiff
path: root/node_modules/decamelize-keys/readme.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/decamelize-keys/readme.md
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
Diffstat (limited to 'node_modules/decamelize-keys/readme.md')
-rw-r--r--node_modules/decamelize-keys/readme.md69
1 files changed, 69 insertions, 0 deletions
diff --git a/node_modules/decamelize-keys/readme.md b/node_modules/decamelize-keys/readme.md
new file mode 100644
index 00000000..7602a872
--- /dev/null
+++ b/node_modules/decamelize-keys/readme.md
@@ -0,0 +1,69 @@
+# decamelize-keys [![Build Status](https://travis-ci.org/dsblv/decamelize-keys.svg?branch=master)](https://travis-ci.org/dsblv/decamelize-keys)
+
+> Convert object keys from camelCase to lowercase with a custom separator using [`decamelize`](https://github.com/sindresorhus/decamelize)
+
+*This project was forked from [`camelcase-keys`](https://github.com/sindresorhus/camelcase-keys) and converted to do the opposite*
+
+
+## Install
+
+```sh
+$ npm install --save decamelize-keys
+```
+
+
+## Usage
+
+```js
+const decamelizeKeys = require('decamelize-keys');
+
+decamelizeKeys({fooBar: true}, '-');
+//=> {'foo-bar': true}
+```
+
+
+## API
+
+### decamelizeKeys(input, [separator], [options])
+
+### input
+
+Type: `object`
+*Required*
+
+Object to decamelize.
+
+### separator
+
+Type: `string`
+Default: `_`
+
+A string to insert between words.
+
+### options
+
+Type: `object`
+
+#### separator
+
+Type: `string`
+Default: `_`
+
+Alternative way to specify [separator](#separator).
+
+#### exclude
+
+Type: `array`
+Default: `[]`
+
+Exclude keys from being decamelized.
+
+
+## Related
+
+See [`camelcase-keys`](https://github.com/sindresorhus/camelcase-keys) for the inverse.
+
+
+## License
+
+MIT © [Sindre Sorhus](http://sindresorhus.com), [Dmirty Sobolev](https://github.com/dsblv)