improves the offline experience of your web app by using asynchronous storage
(IndexedDB or WebSQL) with a simple,
localForage uses localStorage in browsers with no IndexedDB or WebSQL support. See the wiki for detailed compatibility info.
Try the live example.
npm install localforage
If you're having trouble using the library, running the tests, or want to contribute to localForage, please look through the existing issues for your problem first before creating a new one. If you still need help, feel free to file an issue.
How to use localForage
Callbacks vs Promises
Because localForage uses async storage, it has an async API. It's otherwise exactly the same as the localStorage API.
localForage has a dual API that allows you to either use Node-style callbacks or Promises. If you are unsure which one is right for you, it's recommended to use Promises.
Here's an example of the Node-style callback form:
And the Promise form:
tryconst value = await localforage;// This code runs once the value has been loaded// from the offline store.console;catch err// This code runs if there were any errors.console;
For more examples, please visit the API docs.
Storing Blobs, TypedArrays, and other JS objects
You can store any type in localForage; you aren't limited to strings like in
localStorage. Even if localStorage is your storage backend, localForage
JSON.stringify() when getting/setting
localForage supports storing all native JS objects that can be serialized to JSON, as well as ArrayBuffers, Blobs, and TypedArrays. Check the API docs for a full list of types supported by localForage.
All types are supported in every storage backend, though storage limits in localStorage make storing many large Blobs impossible.
You can set database information with the
Available options are
Note: you must call
config() before you interact with your data. This
config() before using
You can create multiple instances of localForage that point to different stores
createInstance. All the configuration options used by
config are supported.
var store = localforage;var otherStore = localforage;// Setting the key on one of these doesn't affect the other.store;otherStore;
You can use localForage with RequireJS:
Otherwise you should use one of the following:
;// or, in case that the typescript version that you are using// doesn't support ES6 style imports for UMD modules like localForage;
If you use a framework listed, there's a localForage storage driver for the models in your framework so you can store data offline with localForage. We have drivers for the following frameworks:
If you have a driver you'd like listed, please open an issue to have it added to this list.
You can create your own driver if you want; see the
defineDriver API docs.
There is a list of custom drivers on the wiki.
Working on localForage
To work on localForage, you should start by
forking it and installing its
USERNAME with your GitHub username and run the
# Install bower globally if you don't have it:npm install -g bower# Replace USERNAME with your GitHub username:git clone email@example.com:USERNAME/localForage.gitcd localForagenpm installbower install
Omitting the bower dependencies will cause the tests to fail!
You need PhantomJS installed to run local tests. Run
npm test (or,
grunt test). Your code must also pass the
localForage is designed to run in the browser, so the tests explicitly require a browser environment. Local tests are run on a headless WebKit (using PhantomJS).
When you submit a pull request, tests will be run against all browsers that localForage supports on Travis CI using Sauce Labs.
As of version 1.7.3 the payload added to your app is rather small. Served using gzip compression, localForage will add less than 10k to your total bundle size:
This program is free software; it is distributed under an Apache License.