Giter VIP home page Giter VIP logo

i18next-localforage-backend's Introduction

Introduction

This is a i18next cache layer to be used in the browser using localforage as storage layer. It will load and cache resources from IndexedDB, webSQL or localStorage and can be used in combination with the chained backend.

Getting started

Source can be loaded via npm or downloaded from this repo.

  • If you don't use a module loader it will be added to window.i18nextLocalForageBackend
# npm package
$ npm install i18next-localforage-backend

Wiring up with the chained backend:

import i18next from 'i18next';
import Backend from 'i18next-chained-backend';
import LocalforageBackend from 'i18next-localforage-backend'; // primary use cache
import XHR from 'i18next-xhr-backend'; // fallback xhr load

i18next
  .use(Backend)
  .init({
    backend: {
      backends: [
        LocalforageBackend,  // primary
        XHR                   // fallback
      ],
      backendOptions: [{
        /* below options */
      }, {
        loadPath: '/locales/{{lng}}/{{ns}}.json' // xhr load path for my own fallback
      }]
    }
  });

Cache Backend Options

var options = {
  // expiration
  expirationTime: 7*24*60*60*1000,

  // language versions
  versions: {},

  /**
  * Localforage specific options
  */
  
  // database name (prefix is using localStorage as storage driver)
  name: 'i18next_res',

  // The driver(s) to use, if multiple are provided, the first available is used
  driver: [localforage.INDEXEDDB, localforage.WEBSQL, localforage.LOCALSTORAGE],
  
  // when using IndexedDb is the dataStore name, when using WebSQL is the table name
  storeName: 'keyvaluepair',
  
  // DB schema version, used only in IndexedDB and WebSQL
  version: 1.0,

  // WebSQL only, database size in bytes
  size: 4980736,

  // description of the database, for developer usage
  description: '',
};
  • Contrary to cookies behavior, the cache will respect updates to expirationTime. If you set 7 days and later update to 10 days, the cache will persist for 10 days

  • Passing in a versions object (ex.: versions: { en: 'v1.2', fr: 'v1.1' }) will give you control over the cache based on translations version. This setting works along expirationTime, so a cached translation will still expire even though the version did not change. You can still set expirationTime far into the future to avoid this

i18next-localforage-backend's People

Contributors

davide-gheri avatar dependabot[bot] avatar

Watchers

 avatar

i18next-localforage-backend's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.