Package Exports

make-plural

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (make-plural) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

make-plural.js

A JavaScript module that translates Unicode CLDR pluralization rules to executable JavaScript.

Installation

Using npm:

npm install make-plural

Usage

> plurals = require('make-plural')
{ set_rules: [Function], build: [Function] }

> console.log( plurals.build('fr') )
function(n) {
  if (n >= 0 && n < 2) return 'one';
  return 'other';
}

> console.log( plurals.build('sk') )
function(n) {
  var s = String(n).split('.'), i = s[0], v0 = !s[1];
  if (n == 1 && v0) return 'one';
  if ((i >= 2 && i <= 4) && v0) return 'few';
  if (!v0) return 'many';
  return 'other';
}

> sk = plurals.build('sk', {'return_function':1})
[Function]

> sk(1)
'one'

> sk(3.0)
'few'

> sk('1.0')
'many'

> sk('0')
'other'

Methods

build(lc, opt)

By default, returns a string representation of a function that takes a single argument n and returns its plural category for the given locale lc. The optional opt object may contain the following members:

return_function -- if true, build returns an executable function of n rather than a string
minify -- if true, the string output of build is minified

set_rules(cldr)

Sets the used CLDR rules to cldr, which may be an object or the path to a JSON file formatted like this. By default, the included rules in data/unicode-cldr-plural-rules.json are used.

Dependencies

None.