# i18next-localstorage-backend
**Repository Path**: mirrors_TrySound/i18next-localstorage-backend
## Basic Information
- **Project Name**: i18next-localstorage-backend
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-26
- **Last Updated**: 2025-09-21
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Introduction
This is a i18next cache layer to be used in the browser. It will load and cache resources from localStorage and can be used in combination with the [chained backend](https://github.com/i18next/i18next-chained-backend).
# Getting started
Source can be loaded via [npm](https://www.npmjs.com/package/i18next-localstorage-cache)or [downloaded](https://github.com/i18next/i18next-localStorage-cache/blob/master/i18nextLocalStorageCache.min.js) from this repo.
- If you don't use a module loader it will be added to window.i18nextLocalStorageBackend
```
# npm package
$ npm install i18next-localstorage-backend
```
Wiring up with the chained backend:
```js
import i18next from 'i18next';
import Backend from 'i18next-chained-backend';
import LocalStorageBackend from 'i18next-localstorage-backend'; // primary use cache
import XHR from 'i18next-xhr-backend'; // fallback xhr load
i18next
.use(Backend)
.init({
backend: {
backends: [
LocalStorageBackend, // primary
XHR // fallback
],
backendOptions: [{
/* below options */
}, {
loadPath: '/locales/{{lng}}/{{ns}}.json' // xhr load path for my own fallback
}]
}
});
```
## Cache Backend Options
```js
{
// prefix for stored languages
prefix: 'i18next_res_',
// expiration
expirationTime: 7*24*60*60*1000,
// language versions
versions: {},
// can be either window.localStorage or window.sessionStorage. Default: window.localStorage
store: window.localStorage
};
```
- 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
--------------
Gold Sponsors
