# decamelize-keys

> Convert object keys from camel case

Latest version **2.0.1** (published 2022-10-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install decamelize-keys
pnpm add decamelize-keys
yarn add decamelize-keys
bun add decamelize-keys
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2022-10-30 |
| First published | 2015-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=14.16 |
| Dependencies | 4 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 57 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | map, object, key, keys, decamelize, decamelcase, uncamelcase, camelcase, camel-case, camel, case, separator, string, text, convert, deep, recurse, recursive |

## Links

- npm: https://www.npmjs.com/package/decamelize-keys
- Repository: https://github.com/sindresorhus/decamelize-keys
- Homepage: https://github.com/sindresorhus/decamelize-keys#readme
- Issues: https://github.com/sindresorhus/decamelize-keys/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/decamelize-keys

## Dependencies (4)

- [map-obj](https://npm.io/package/map-obj.md) ^4.3.0
- [quick-lru](https://npm.io/package/quick-lru.md) ^6.1.1
- [type-fest](https://npm.io/package/type-fest.md) ^3.1.0
- [decamelize](https://npm.io/package/decamelize.md) ^6.0.0

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 2.0.1 (latest) — 2022-10-30
- 2.0.0 — 2022-10-30
- 1.1.1 — 2022-10-30
- 1.1.0 — 2016-03-16
- 1.0.0 — 2015-10-27

## README

# decamelize-keys

> Convert object keys from camel case using [`decamelize`](https://github.com/sindresorhus/decamelize)

## Install

```sh
npm install decamelize-keys
```

## Usage

```js
import decamelizeKeys from 'decamelize-keys';

// Convert an object
decamelizeKeys({fooBar: true});
//=> {foo_bar: true}

// Convert an array of objects
decamelizeKeys([{fooBar: true}, {barFoo: false}]);
//=> [{foo_bar: true}, {bar_foo: false}]
```

## API

### decamelizeKeys(input, options?)

#### input

Type: `object | object[]`

An object or array of objects to decamelize.

#### options

Type: `object`

##### separator

Type: `string`\
Default: `'_'`

The character or string used to separate words.

```js
import decamelizeKeys from 'decamelize-keys';

decamelizeKeys({fooBar: true});
//=> {foo_bar: true}

decamelizeKeys({fooBar: true}, {separator: '-'});
//=> {'foo-bar': true}
```

##### exclude

Type: `Array<string | RegExp>`\
Default: `[]`

Exclude keys from being decamelized.

##### deep

Type: `boolean`\
Default: `false`

Recurse nested objects and objects in arrays.

```js
import decamelizeKeys from 'decamelize-keys';

decamelizeKeys({fooBar: true, nested: {unicornRainbow: true}}, {deep: true});
//=> {foo_bar: true, nested: {unicorn_rainbow: true}}
```

## Related

- [camelcase-keys](https://github.com/sindresorhus/camelcase-keys) - The inverse of this package.

---
_Source: https://npm.io/package/decamelize-keys · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._