c5fd23b54f | ||
---|---|---|
.. | ||
vendor | ||
LICENSE | ||
README.md | ||
package.json | ||
sentence-case.d.ts | ||
sentence-case.js |
README.md
Sentence Case
Transform a string to lower space cased. Optional locale and replacement character supported.
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 sentence-case --save
Usage
var sentenceCase = require('sentence-case')
sentenceCase(null) //=> ""
sentenceCase('string') //=> "string"
sentenceCase('dot.case') //=> "dot case"
sentenceCase('camelCase') //=> "camel case"
sentenceCase('Beyoncé Knowles') //=> "beyoncé knowles"
sentenceCase('A STRING', 'tr') //=> "a strıng"
sentenceCase('HELLO WORLD!', null, '_') //=> "hello_world"
Typings
Includes a TypeScript definition.
License
MIT