cryptedForage

cryptedForage is a fast and simple storage library for JavaScript. cryptedForage improves the offline experience of your web app by using asynchronous storage (IndexedDB or WebSQL) with a simple, localStorage-like API.

cryptedForage uses localStorage in browsers with no IndexedDB or WebSQL support. See the wiki for detailed compatibility info.

To use cryptedForage, just drop a single JavaScript file into your page:

<script src="cryptedforage/dist/cryptedforage.js"></script>
<script>cryptedforage.getItem('something', myCallback);</script>

Try the live example.

Download the latest cryptedForage from GitHub, or install with npm:

npm install cryptedforage

cryptedForage is compatible with browserify.

Support

Lost? Need help? Try the cryptedForage API documentation. cryptedForage API 文档也有中文版。

If you're having trouble using the library, running the tests, or want to contribute to cryptedForage, you can visit irc.freenode.net and head to the #cryptedforage channel to ask questions about cryptedForage.

You can ask tofumatt about cryptedForage in IRC, who is usually online from 10am-8pm GMT.

Safari 10.1+

Since Safari 10.1 we default to IndexedDB; see the CHANGELOG for more info.

How to use cryptedForage

Callbacks vs Promises

Because cryptedForage uses async storage, it has an async API. It's otherwise exactly the same as the localStorage API.

cryptedForage 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:

cryptedforage.setItem('key', 'value', function(err) {
    // if err is non-null, we got an error
    cryptedforage.getItem('key', function(err, value) {
        // if err is non-null, we got an error. otherwise, value is the value
    });
});

And the Promise form:

cryptedforage
    .setItem('key', 'value')
    .then(function() {
        return cryptedforage.getItem('key');
    })
    .then(function(value) {
        // we got our value
    })
    .catch(function(err) {
        // we got an error
    });

For more examples, please visit the API docs.

Storing Blobs, TypedArrays, and other JS objects

You can store any type in cryptedForage; you aren't limited to strings like in localStorage. Even if localStorage is your storage backend, cryptedForage automatically does JSON.parse() and JSON.stringify() when getting/setting values.

cryptedForage 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 cryptedForage.

All types are supported in every storage backend, though storage limits in localStorage make storing many large Blobs impossible.

Configuration

You can set database information with the config() method. Available options are driver, name, storeName, version, size, and description.

Example:

cryptedforage.config({
    driver: cryptedforage.WEBSQL, // Force WebSQL; same as using setDriver()
    name: 'myApp',
    version: 1.0,
    size: 4980736, // Size of database, in bytes. WebSQL-only for now.
    storeName: 'keyvaluepairs', // Should be alphanumeric, with underscores.
    description: 'some description',
    secret: 'YOUR_SECRET' // will be generated automatically if not specified
});

Note: you must call config() before you interact with your data. This means calling config() before using getItem(), setItem(), removeItem(), clear(), key(), keys() or length().

Multiple instances

You can create multiple instances of cryptedForage that point to different stores using createInstance. All the configuration options used by config are supported.

var store = cryptedforage.createInstance({
    name: 'nameHere'
});

var otherStore = cryptedforage.createInstance({
    name: 'otherName'
});

// Setting the key on one of these doesn't affect the other.
store.setItem('key', 'value');
otherStore.setItem('key', 'value2');

RequireJS

You can use cryptedForage with RequireJS:

define(['cryptedforage'], function(cryptedforage) {
    // As a callback:
    cryptedforage.setItem('mykey', 'myvalue', console.log);

    // With a Promise:
    cryptedforage.setItem('mykey', 'myvalue').then(console.log);
});

Browserify and Webpack

cryptedForage 1.3+ works with both Browserify and Webpack. If you're using an earlier version of cryptedForage and are having issues with Browserify or Webpack, please upgrade to 1.3.0 or above.

Webpack will emit a warning about using a prebuilt javascript file which is fine. If you want to remove the warning you should exclude cryptedforage from being parsed by webpack using the following conf :

module: {
  noParse: /node_modules\/cryptedforage\/dist\/cryptedforage.js/,
  loaders: [...],

TypeScript

If you have the allowSyntheticDefaultImports compiler option set to true in your tsconfig.json (supported in TypeScript v1.8+), you should use:

import cryptedForage from 'cryptedforage';

Otherwise you should use one of the following:

import * as cryptedForage from "cryptedforage";
// or, in case that the typescript version that you are using
// doesn't support ES6 style imports for UMD modules like cryptedForage
import cryptedForage = require("cryptedforage");

Framework Support

If you use a framework listed, there's a cryptedForage storage driver for the models in your framework so you can store data offline with cryptedForage. We have drivers for the following frameworks:

• AngularJS
• Angular 4 and up
• Backbone
• Ember
• Vue

If you have a driver you'd like listed, please open an issue to have it added to this list.

Custom Drivers

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 cryptedForage

You'll need node/npm and bower.

To work on cryptedForage, you should start by forking it and installing its dependencies. Replace USERNAME with your GitHub username and run the following:

# Install bower globally if you don't have it:
npm install -g bower

# Replace USERNAME with your GitHub username:
git clone [email protected]:USERNAME/cryptedForage.git
cd cryptedForage
npm install
bower install

Omitting the bower dependencies will cause the tests to fail!

Running Tests

You need PhantomJS installed to run local tests. Run npm test (or, directly: grunt test). Your code must also pass the linter.

cryptedForage 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 cryptedForage supports on Travis CI using Sauce Labs.

License

This program is free software; it is distributed under an Apache License.

Copyright (c) 2013-2016 Mozilla (Contributors).