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.
Documentation
See documentation
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()*/));
Internal API
Not Applicable
Dependencies
this.header.getLocale(locale:String)
fromHeader
- Should return a string of the current locale.
this.header.setLocale(locale:String)
fromHeader
- Should set the locale.
this.header.detectLocale(locale:String)
fromHeader
(optional)- Should detect the current locale by parsing the Accept-Language, domains, sub-domains, queries, URLs, and cookies.
this.header.options.supported:Array
fromHeader
options- Should be an array of supported locales.
this.backend.catalog(locale:String)
fromBackend
- Should return an object containing the dictionaries for each locale.
Options
{
"global":"__",
"localize":"__l"
}
Debug
Unix:
DEBUG=gengo.api
Windows:
SET DEBUG=gengo.api
See gengojs-debug for usage.
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
.