/snakecase-keys

Convert an object's keys to snake case

Primary LanguageJavaScriptMIT LicenseMIT

snakecase-keys Build Status Greenkeeper badge

Convert an object's keys to snake case

Install

$ npm install --save snakecase-keys

Usage

var snakeCaseKeys = require('snakecase-keys')

snakeCaseKeys({fooBar: 'baz'})
//=> {foo_bar: 'baz'}

snakeCaseKeys({'foo-bar': true, nested: {fooBaz: 'bar'}});
//=> {foo_bar: true, nested: {foo_baz: 'bar'}}

API

snakeCaseKeys(obj, options) -> object

obj

Required
Type: object

An object to transform into snake case (keys only).

options

Optional
Type: object

deep

Type: boolean
Default: true

Enables snake-casing of keys in nested objects.

exclude

Type: array[string || regexp]
Default: []

An array of strings or regular expressions matching keys that will be excluded from snake-casing.

Related

License

MIT © Ben Drucker