newspeak
This package is inspired by Mozilla's L20n project. In Mozilla's words:
L20n allows localizers to put small bits of logic into localization resources to codify the grammar of the language.
This includes different forms for plurals, gender and conjugation. Supporting languages such as Polish should become much easier.
Newspeak is diferrent in that the syntax is just JavaScript. A basic understanding of JS should be sufficient to get started. Not only has this the advantage of being easy, it's also very fast.
Installation
$ npm i --save newspeak
Overview
// Initialize newspeak.var newspeak = ;var l20n = ;l20nlanguage'en_US'; // Add a language decision tree.var data = { if 0 === objcount return 'nobody'; if 1 === objcount return 'someone'; return '{{count}} people'; }l20n; // Request a string based on parameters.l20n;// => '3 people'
API
newspeak()
Initializes an instance of newspeak
. Takes an optional {Object} opts
as
an argument.
var newspeak = ;var l20n = ;
.language()
Set a {String} language
to access corresponding language strings. Emits a
change
event whenever the language changes, but not the first time it's set.
l20n; l20nlanguage'en_US';l20nlanguage'da_DK';//=> 'sp'
.configure()
Store an {Object} opts
to define configuration variables.
l20n;
.add()
Register an {Object} data
with language strings. Takes a {String} language
and {Object} data
as arguments. {Object} data
can contain both functions and
strings.
var data = { if argsmood == 'hungry' return "I'm {{mood}} and want pizza." if argsmood == 'happy' return "I'm {{mood}} and want a salad." } favorite_color: 'green' user_gender: '{{gender}}'l20n;
.remove()
Remove an {Object} data
from the store. Takes an {String} language
and
{Object} data
as arguments. .remove()
will traverse data keys 1 level deep.
l20n;
.get()
Get a parsed {String}
from the store. Takes a {String} query
and
{Object} opts
as arguments.
l20n;// => "I'm happy and want a salad." l20n;// => 'green' l20n;// => 'male'