gengojs-default-api

gengojs-default-api

The default API plugin for gengo.js.

This module will be used for gengo.js.

Note: The API examples defined are respect to the default parser.

An example usage with options is:

var gengo = require('gengojs');
var api = require('gengojs-default-api');

/* In whatever framework you are using: */

// I'll use express for an example
// but it shouldn't matter

var app = require('express')();
app.use(gengo({
   // Specify the type
   // of option to modify
	api:{
		/* options */
	}
},/*api()*/));

The default API is already included in gengo.js so you should not have to require it.

Documentation

See documentation

Options

{
	"global":"__",
	"localize":"__l"
}

Internal API

None

Dependencies

• this.header.getLocale(locale:String) from Header class
• this.header.setLocale(locale:String) from Header class
• this.header.detectLocale(locale:String) from Header class (optional)
• supported:Array from Header options
• this.backend.catalog(locale:String) from Backend class

Debug

Unix:

DEBUG=gengo.api

Windows:

SET DEBUG=gengo.api

See gengojs-debug for usage.

Reserved words

There are a few reserved words in the API. These words are used for overriding purposes. See the example:

// Using 'phrase' keyword:
__({phrase:'Hello!'});
// Using 'parser' keyword which
// overrides the parser:
// See https://github.com/iwatakeshi/gengojs-default-parser
// for more details.
__('Hello!', {parser:'default'});
// Using 'locale' keyword which
// overrides the locale:
__('You have {n, plural, =0 {no photos.}=1 {one photo.}other {# photos.}}', {parser:'format'});

Contribute

Feel free to contribute or even fork the project. This plugin has been written in ES6 and can be seen under lib/index.js.