README.md 1.3 KB

Snake Case

NPM version NPM downloads Build status Test coverage

Snake case a string.

Supports Unicode (non-ASCII characters) and non-string entities, such as objects with a toString property, numbers and booleans. Empty values (null and undefined) will result in an empty string.

Installation

npm install snake-case --save

Usage

var snakeCase = require('snake-case')

snakeCase('string')        //=> "string"
snakeCase('camelCase')     //=> "camel_case"
snakeCase('sentence case') //=> "sentence_case"

snakeCase('MY STRING', 'tr') //=> "my_strıng"

Typings

Includes a TypeScript definition.

License

MIT