30eef7d036 | ||
---|---|---|
.. | ||
LICENSE | ||
README.md | ||
change-case.d.ts | ||
change-case.js | ||
package.json |
README.md
Change Case
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.
Every method is also available on npm as an individual package.
Installation
npm install change-case --save
Usage
var changeCase = require('change-case')
//=> { isUpperCase: [Function], camelCase: [Function], ... }
Available methods (short-hand shown below, long-hand available in examples):
isUpper
isLower
upper
ucFirst
lcFirst
lower
sentence
title
camel
pascal
snake
param
dot
path
constant
swap
All methods accept two arguments, the string to change case and an optional locale.
isUpperCase
Return a boolean indicating whether the string is upper cased.
changeCase.isUpperCase('test string')
//=> false
isLowerCase
Return a boolean indicating whether the string is lower cased.
changeCase.isLowerCase('test string')
//=> true
upperCase
Return the string in upper case.
changeCase.upperCase('test string')
//=> "TEST STRING"
upperCaseFirst
Return the string with the first character upper cased.
changeCase.upperCaseFirst('test')
//=> "Test"
lowerCaseFirst
Return the string with the first character lower cased.
changeCase.lowerCaseFirst('TEST')
//=> "tEST"
lowerCase
Return the string in lower case.
changeCase.lowerCase('TEST STRING')
//=> "test string"
sentenceCase
Return as a lower case, space separated string.
changeCase.sentenceCase('testString')
//=> "test string"
titleCase
Return as a space separated string with the first character of every word upper cased.
changeCase.titleCase('a simple test')
//=> "A Simple Test"
camelCase
Return as a string with the separators denoted by having the next letter capitalized.
changeCase.camelCase('test string')
//=> "testString"
pascalCase
Return as a string denoted in the same fashion as camelCase
, but with the first letter also capitalized.
changeCase.pascalCase('test string')
//=> "TestString"
snakeCase
Return as a lower case, underscore separated string.
changeCase.snakeCase('test string')
//=> "test_string"
paramCase
Return as a lower case, dash separated string.
changeCase.paramCase('test string')
//=> "test-string"
dotCase
Return as a lower case, period separated string.
changeCase.dotCase('test string')
//=> "test.string"
pathCase
Return as a lower case, slash separated string.
changeCase.pathCase('test string')
//=> "test/string"
constantCase
Return as an upper case, underscore separated string.
changeCase.constantCase('test string')
//=> "TEST_STRING"
swapCase
Return as a string with every character case reversed.
changeCase.swapCase('Test String')
//=> "tEST sTRING"
Typings
Includes a TypeScript definition.
Related
License
MIT