README

gengojs-default-memory

The default memory backend plugin for gengo.js.

This module will be used for gengo.js.

Documentation

Usage

An example usage with options is:


var gengo = require('gengojs');
var backend = require('gengojs-default-memory');

/* 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
    backend:{
        /* options */
    }
},/*backend()*/));

The default backend is already included in gengojs so you should not have to require it.

Options

{
  "directory": "./locales",
  "extension": "json",
  "prefix": "",
  "cache": true
}

Supported Extensions

The supported file types are:

.json
.yaml
.toml
.js

Internal API

find(locale:String)
- Should return the dictionary by locale
catalog(locale:String)
- Should return the dictionary by locale or the entire dictionary.

For more see documentation

Dependencies

Not Applicable

Debug

Unix:

DEBUG=gengo.backend

Windows:

SET DEBUG=gengo.backend

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.

Usage no npm install needed!