casing's Introduction

casing

Recursively transform object key strings to and from camelCase and snake_case.

Supports objects, arrays and a combination of both in any depth.
Was originally intended for use with BookShelf and Knex.

Installation

$ npm install casing

Usage

'use strict';
var casing = require('casing');

var wasCamel = {
  objId: 123,
  myName: 'Slim Shady'
};
console.log(casing.snakeize(wasCamel));
// => { obj_id: 123, my_name: 'Slim Shady' }

var was_snake = {
  obj_id: 456,
  my_name: 'fiddycent'
};
console.log(casing.camelize(was_snake));
// => { objId: 456, myName: 'fiddycent' }

TypeScript

This package includes a definition file for TypeScript.

import { camelize, snakeize } from 'casing';

var wasCamel = { objId: 123 };
snakeize(wasCamel);

var was_snake = { obj_id: 456 };
camelize(was_snake);

License

MIT

casing's People

Stargazers

Watchers

casing's Issues

Add TypeScript definition file

You can add on your package.json

"types": "main.d.ts",

And create this file with the following contents:

/**
 * Deeply converts object keys to camelCase
 */
export declare const camelize: (obj: any) => any;

/**
 * Deeply converts object keys to snake_case
 */
export declare const snakeize: (obj: any) => any;

So when someone using TypeScript install your package they will get some type information (like auto complete to import function names without misspelling)

And then they can use it like this

import { camelize, snakeize } from 'casing';

var wasCamel = { objId: 123 };
snakeize(wasCamel);

var was_snake = { obj_id: 456 };
camelize(was_snake);

Recommend Projects