www.aleph1.co.uk Git - yaffs-website/blob - node_modules/camelcase-keys/readme.md

   1 # camelcase-keys [![Build Status](https://travis-ci.org/sindresorhus/camelcase-keys.svg?branch=master)](https://travis-ci.org/sindresorhus/camelcase-keys)
   2
   3 > Convert object keys to camelCase using [`camelcase`](https://github.com/sindresorhus/camelcase)
   4
   5
   6 ## Install
   7
   8 ```
   9 $ npm install --save camelcase-keys
  10 ```
  11
  12
  13 ## Usage
  14
  15 ```js
  16 const camelcaseKeys = require('camelcase-keys');
  17
  18 camelcaseKeys({'foo-bar': true});
  19 //=> {fooBar: true}
  20
  21
  22 const argv = require('minimist')(process.argv.slice(2));
  23 //=> {_: [], 'foo-bar': true}
  24
  25 camelcaseKeys(argv);
  26 //=> {_: [], fooBar: true}
  27 ```
  28
  29
  30 ## API
  31
  32 ### camelcaseKeys(input, [options])
  33
  34 #### input
  35
  36 Type: `object`
  37
  38 Object to camelCase.
  39
  40 #### options
  41
  42 Type: `object`
  43
  44 ##### exclude
  45
  46 Type: `array`
  47 Default: `[]`
  48
  49 Exclude keys from being camelCased.
  50
  51
  52 ## License
  53
  54 MIT © [Sindre Sorhus](http://sindresorhus.com)