forked from mirror/Riven
1
0
Fork 0
Riven/riven/srcgen/node_modules/sentence-case/README.md

1.6 KiB
Raw Blame History

Sentence Case

NPM version NPM downloads Build status Test coverage

Sentence case a string. Explicitly adds a single underscore between groups of numbers to maintain readability and reversibility (E.g. 1.20.5 becomes 1_20_5, not 1205), by default.

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

Node

npm install sentence-case --save

Usage

var sentenceCase = require('sentence-case')

sentenceCase('string')         //=> "String"
sentenceCase('dot.case')       //=> "Dot case"
sentenceCase('PascalCase')     //=> "Pascal case"
sentenceCase('version 1.2.10') //=> "Version 1 2 10"

sentenceCase('STRING 1.2', 'tr') //=> "Strıng 1 2"

Typings

Includes a TypeScript definition.

License

MIT