jack e1a2621c78 update 2 years ago
..
vendor e1a2621c78 update 2 years ago
LICENSE e1a2621c78 update 2 years ago
README.md e1a2621c78 update 2 years ago
package.json e1a2621c78 update 2 years ago
sentence-case.d.ts e1a2621c78 update 2 years ago
sentence-case.js e1a2621c78 update 2 years ago

README.md

Sentence Case

NPM version NPM downloads Build status Test coverage

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