humps

What is humps?

The 'humps' npm package is a utility library for converting object keys between different naming conventions, such as camelCase, snake_case, and kebab-case. It is particularly useful for working with APIs that use different naming conventions than your JavaScript code.

What are humps's main functionalities?

camelizeKeys

Converts the keys of an object from snake_case to camelCase.

const humps = require('humps');
const input = { first_name: 'John', last_name: 'Doe' };
const output = humps.camelizeKeys(input);
console.log(output); // { firstName: 'John', lastName: 'Doe' }

decamelizeKeys

Converts the keys of an object from camelCase to snake_case.

const humps = require('humps');
const input = { firstName: 'John', lastName: 'Doe' };
const output = humps.decamelizeKeys(input);
console.log(output); // { first_name: 'John', last_name: 'Doe' }

kebabizeKeys

Converts the keys of an object from camelCase to kebab-case.

const humps = require('humps');
const input = { firstName: 'John', lastName: 'Doe' };
const output = humps.kebabizeKeys(input);
console.log(output); // { 'first-name': 'John', 'last-name': 'Doe' }

pascalizeKeys

Converts the keys of an object from snake_case to PascalCase.

const humps = require('humps');
const input = { first_name: 'John', last_name: 'Doe' };
const output = humps.pascalizeKeys(input);
console.log(output); // { FirstName: 'John', LastName: 'Doe' }

Other packages similar to humps

lodash

Lodash is a popular utility library that provides a wide range of functions for manipulating arrays, objects, and other data types. It includes methods for converting object keys between different naming conventions, similar to humps, but offers a much broader set of utilities.

change-case

The 'change-case' package provides a collection of functions for converting strings between different cases, such as camelCase, snake_case, and kebab-case. While it focuses on string manipulation rather than object keys, it can be used in conjunction with other libraries to achieve similar functionality to humps.

case-converter

The 'case-converter' package is a lightweight library specifically designed for converting object keys between different naming conventions. It offers similar functionality to humps but with a smaller footprint and fewer dependencies.

README

humps

Underscore-to-camelCase converter (and vice versa) for strings and object keys in JavaScript.

When converting object keys, it will walk the structure, converting any nested objects (or arrays of nested objects) along the way. Handy for converting JSON between JavaScript and Ruby/Rails APIs.

Takes inspiration from Ember Data and copies some utility functions from Underscore.js.

Usage

Converting strings

humps.camelize("hello_world"); // "helloWorld"
humps.decamelize("fooBar"); // "foo_bar""

Decamelizing strings with custom separator

humps.decamelize("helloWorld", "-"); // "hello-world"

Converting object keys

var object = {
  attr_one: "foo",
  attr_two: "bar"
};

object = humps.camelizeKeys(object);

object.attrOne === "foo"; // true
object.attrTwo === "bar"; // true

Arrays of objects are also converted

var array = [
  { attr_one: "foo" },
  { attr_one: "bar" }
];

array = humps.camelizeKeys(array);

array[0].attrOne === "foo"; // true
array[1].attrOne === "bar"; // true

Licence

humps is copyright © 2013 Dom Christie and released under the MIT license.