Change Case
![Test coverage](https://img.shields.io/coveralls/blakeembrey/change-case.svg?style=flat)
Convert strings between camelCase
, PascalCase
, Title Case
, snake_case
, lowercase
, UPPERCASE
, CONSTANT_CASE
and more.
All methods support 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.
Methods are also available on npm as an individual packages.
Installation
npm install change-case --save
Usage
var changeCase = require('change-case')
Available methods (short-hand shown below, long-hand available in examples):
All methods accept two arguments, the string to change case and an optional locale.
![Test coverage](https://img.shields.io/coveralls/blakeembrey/camel-case.svg?style=flat)
Return as a string with the separators denoted by having the next letter capitalized.
changeCase.camelCase('test string')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/constant-case.svg?style=flat)
Return as an upper case, underscore separated string.
changeCase.constantCase('test string')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/dot-case.svg?style=flat)
Return as a lower case, period separated string.
changeCase.dotCase('test string')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/header-case.svg?style=flat)
Return as a title cased, dash separated string.
changeCase.headerCase('test string')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/is-lower-case.svg?style=flat)
Return a boolean indicating whether the string is lower cased.
changeCase.isLowerCase('test string')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/is-upper-case.svg?style=flat)
Return a boolean indicating whether the string is upper cased.
changeCase.isUpperCase('test string')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/lower-case.svg?style=flat)
Return the string in lower case.
changeCase.lowerCase('TEST STRING')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/lower-case-first.svg?style=flat)
Return the string with the first character lower cased.
changeCase.lowerCaseFirst('TEST')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/no-case.svg?style=flat)
Return the string without any casing (lower case, space separated).
changeCase.noCase('test string')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/param-case.svg?style=flat)
Return as a lower case, dash separated string.
changeCase.paramCase('test string')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/pascal-case.svg?style=flat)
Return as a string denoted in the same fashion as camelCase
, but with the first letter also capitalized.
changeCase.pascalCase('test string')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/path-case.svg?style=flat)
Return as a lower case, slash separated string.
changeCase.pathCase('test string')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/sentence-case.svg?style=flat)
Return as a lower case, space separated string with the first letter upper case.
changeCase.sentenceCase('testString')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/snake-case.svg?style=flat)
Return as a lower case, underscore separated string.
changeCase.snakeCase('test string')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/swap-case.svg?style=flat)
Return as a string with every character case reversed.
changeCase.swapCase('Test String')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/title-case.svg?style=flat)
Return as a space separated string with the first character of every word upper cased.
changeCase.titleCase('a simple test')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/upper-case.svg?style=flat)
Return the string in upper case.
changeCase.upperCase('test string')
![Test coverage](https://img.shields.io/coveralls/blakeembrey/upper-case-first.svg?style=flat)
Return the string with the first character upper cased.
changeCase.upperCaseFirst('test')
Related
TypeScript
Includes a TypeScript definition.
License
MIT