/js-inflector

Word magic.

Primary LanguageJavaScriptMIT LicenseMIT

js-inflector

Word magic.

Quick Start

```node var inflector = require('js-inflector'); ```
var inflect = inflector.start();

Examples

```node var someValue = 'tree'; ``` Modify word state: ```node var plural = inflect(someValue, 'plural'); //--> trees ```
var capital = inflect(someValue, 'capital');  
//--> Tree

Modify multiple word states at once:

var pluralAndCapital = inflect(someValue, ['capital', 'plural']);  
//--> Trees

Set a group state:

inflector.group({
  'properPlural': ['capital', 'plural']
});

With a group state:

var pluralAndCapital = inflect(someValue, 'properPlural');  
//--> Trees

Word States

- camelcase (camelcase | camel) - capitalize (cap | caps) - decapitalize (decapitalize | decap) - lowercase (lowercase | lower) - pluralize (plural | many) - singularize (singular | single) - uppercase (uppercase | upper)