Skip to content

Latest commit

 

History

History
80 lines (63 loc) · 2.63 KB

README.md

File metadata and controls

80 lines (63 loc) · 2.63 KB
Raw

change-case-keys

Change the case of the keys of a javascript object (from underscore to came case, for instance).

Example

var obj = {
    firstName: "paulo",
    lastName: "vieira",
    createdAt: "2015-01-05 19:27:00",
    groups: [
        {
            id: 11,
            groupName: "x"
        },
        {
            id: 11,
            groupName: "y"
        }
    ]
}

changeCaseKeys(obj, "underscored");

After the call, the keys of obj will be in underscored case (the values will be untouched):

{
    first_name: "paulo",
    last_name: "vieira",
    created_at: "2015-01-05 19:27:00",
    groups: [
        {
            id: 11,
            group_name: "x"
        },
        {
            id: 12,
            group_name: "y"
        }
    ]
}

What's the point of this module?

Useful if you're acessing a Postgres database in Node. The convention in Postgres is to use underscore case for the names of the table columns. The data from a query (using the pg module) will be an array of objects, where each object represents a row and the keys are the column names.

This function will convert the keys to camel case (and vice-versa). This way you can peacefully have columns named "first_name", "last_name", etc, and the objects with the query data will have the keys "firstName", "lastName", etc.

Install and usage

Install with npm. Depends on underscore and underscore.string.

npm install change-case-keys

The module exports a function which accepts 3 parameters:

var changeCaseKeys = require("change-case-keys");
var maxRecursionLevel = 2;

changeCaseKeys(obj, "underscored", maxRecursionLevel);

This module uses underscore.string to make the case conversion. The second argument should be a string value with the name of the method from underscore.string that will be used.

Usually it should be one of these:

The third argument is optional and can be used to control how deep you want to go to change the keys. To change the keys of only the top most properties you should use:

changeCaseKeys(obj, "underscored", 1);