node.js backend layer for i18next using request module to load resources from external services.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 3d0822e May 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example v1.0.0 Apr 2, 2018
lib v1.0.0 Apr 2, 2018
src v1.0.0 Apr 2, 2018
.babelrc update deps and build process Nov 23, 2016
.editorconfig initial version Apr 4, 2016
.eslintignore initial version Apr 4, 2016
.eslintrc busting cache Apr 27, 2016
.gitignore initial version Apr 4, 2016
.npmignore initial version Apr 4, 2016
CHANGELOG.md fixes debounced write to send every namespace-language pair Mar 27, 2018
LICENSE initial version Apr 4, 2016
README.md v1.0.0 Apr 2, 2018
index.js export optimization Dec 1, 2016
package-lock.json Security patch. May 11, 2018
package.json Bump. May 11, 2018

README.md

Introduction

This is a i18next backend to be used with node.js for external services such as spacetranslate or locize service. It's for the node.js server what the i18next-service-backend is for the browser.

Getting started

Source can be loaded via npm.

$ npm install i18next-node-service-backend

Wiring up:

var i18next = require('i18next');
var Backend = require('i18next-node-service-backend');

i18next
  .use(Backend)
  .init(i18nextOptions);

As with all modules you can either pass the constructor function (class) to the i18next.use or a concrete instance.

Backend Options

{
  // service url to the backend service
  // i.e. https://api.spacetranslate.com or https://api.locize.io
  service: '[SERVICE_URL]',

  // the id of your project
  projectId: '[PROJECTID]',

  // add an api key if you want to send missing keys
  apiKey: '[APIKEY]',

  // the reference language of your project
  referenceLng: '[LNG]',

  // version - defaults to latest
  version: '[VERSION]'
}

Options can be passed in:

preferred - by setting options.backend in i18next.init:

var i18next = require('i18next');
var Backend = require('i18next-node-service-backend');

i18next
  .use(Backend)
  .init({
    backend: options
  });

on construction:

var Backend = require('i18next-node-service-backend');
var backend = new Backend(null, options);

by calling init:

var Backend = require('i18next-node-service-backend');
var backend = new Backend();
backend.init(null, options);