cryptedforage1.7.3 • Public • Published
improves the offline experience of your web app by using asynchronous storage
(IndexedDB or WebSQL) with a simple,
cryptedForage uses localStorage in browsers with no IndexedDB or WebSQL support. See the wiki for detailed compatibility info.
Try the live example.
npm install cryptedforage
cryptedForage is compatible with browserify.
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
channel to ask questions about cryptedForage.
You can ask tofumatt about cryptedForage in IRC, who is usually online from 10am-8pm GMT.
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:
And the Promise form:
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
JSON.stringify() when getting/setting
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.
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 cryptedForage that point to different stores
createInstance. All the configuration options used by
config are supported.
var store = cryptedforage;var otherStore = cryptedforage;// Setting the key on one of these doesn't affect the other.store;otherStore;
You can use cryptedForage with RequireJS:
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.
cryptedforage from being parsed by webpack using the following conf :
module:noParse: /node_modules\/cryptedforage\/dist\/cryptedforage.js/loaders: ...
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 cryptedForage;
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:
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 cryptedForage
To work on cryptedForage, 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 firstname.lastname@example.org:USERNAME/cryptedForage.gitcd cryptedForagenpm 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
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.
This program is free software; it is distributed under an Apache License.