localforage - npm Package Compare versions

Comparing version 0.4.3 to 0.6.0

bower.json

 {
     "name": "localforage",
-    "version": "0.4.3",
+    "version": "0.6.0",
     "main": [
-        "localforage.min.js"
+        "dist/localforage.min.js"
     ],
@@ -7,0 +7,0 @@ "ignore": [

docs/index.md

@@ -74,4 +74,6 @@ ---
 
-# API
+# Data API
 
+These APIs deal with getting and setting data in the offline store.
+
 ## getItem
@@ -99,3 +101,8 @@
 
-<aside class="notice">Even if `undefined` is saved, `null` will be returned by `getItem()`. This is due to a [limitation in localStorage](https://github.com/mozilla/localForage/pull/42), and for compatibility reasons localForage cannot store the value `undefined`.</aside>
+<aside class="notice">
+  Even if `undefined` is saved, `null` will be returned by `getItem()`. This
+  is due to a
+  [limitation in localStorage](https://github.com/mozilla/localForage/pull/42),
+  and for compatibility reasons localForage cannot store the value `undefined`.
+</aside>
 
@@ -123,3 +130,3 @@ ## setItem
     if (request.readyState === 4) { // readyState DONE
-        localforage.setItem('my photo', request.response, function(img) {
+        localforage.setItem('photo', request.response, function(img) {
             // This will be a valid blob URI for an <img> tag.
@@ -150,3 +157,3 @@ var blob = new Blob([image]);
   if request.readyState == 4 # readyState DONE
-    localforage.setItem "arrayBuffer", request.response, (img) ->
+    localforage.setItem "photo", request.response, (img) ->
       # This will be a valid blob URI for an <img> tag.
@@ -178,3 +185,7 @@ blob = new Blob [image]
 
-<aside class="notice">When using localStorage and WebSQL backends, binary data will be serialized before being saved (and retrieved). This serialization will incur a size increase when binary data is saved.</aside>
+<aside class="notice">
+  When using localStorage and WebSQL backends, binary data will be serialized
+  before being saved (and retrieved). This serialization will incur a size
+  increase when binary data is saved.
+</aside>
 
@@ -219,3 +230,6 @@ ## removeItem
 
-<aside class="warning">`localforage.clear()` will remove **every item in the offline store**. Use this method with caution.</aside>
+<aside class="warning">
+  `localforage.clear()` will remove **every item in the offline store**. Use
+  this method with caution.
+</aside>
 
@@ -260,2 +274,107 @@ ## length
 
-<aside class="notice">This method is inherited from the localStorage API, but is acknowledged to be kinda weird.</aside>
+<aside class="notice">
+  This method is inherited from the localStorage API, but is acknowledged to
+  be kinda weird.
+</aside>
+
+# Settings API
+
+These methods allow driver selection and database configuration. These methods
+should generally be called before the first _data_ API call to localForage (
+i.e. before you call `getItem()` or `length()`, etc.)
+
+## setDriver
+
+```javascript
+// Force localStorage to be the backend driver.
+localforage.setDriver('localStorageWrapper');
+```
+
+```coffeescript
+# Force localStorage to be the backend driver.
+localforage.setDriver "localStorageWrapper"
+```
+
+`setDriver(driverName)`
+
+Force usage of a particular driver, if it is available.
+
+By default, localForage selects backend drivers for the datastore in this
+order:
+
+1. IndexedDB
+2. WebSQL
+3. localStorage
+
+If you would like to force usage of a particular driver you can use
+`setDriver()`.
+
+<aside class="notice">
+  If the backend you're trying to load isn't available on the user's browser,
+  localForage will continue to use whatever backend driver it was previously
+  using. This means that if you try to force a Gecko browser to use WebSQL,
+  it will fail and continue using IndexedDB.
+</aside>
+
+## config
+
+```javascript
+// This will rename the database from "localforage"
+// to "Hipster PDA App".
+localforage.config({
+    name: 'Hipster PDA App'
+});
+```
+
+```coffeescript
+# This will rename the database from "localforage"
+# to "Hipster PDA App".
+localforage.config
+  name: "Hipster PDA App"
+```
+
+`config(options)`
+
+Set and persist localForage options. This must be called *before* any other
+calls to localForage are made, but can be called after localForage is loaded.
+If you set any config values with this method they will persist after driver
+changes, so you can call `config()` then `setDriver()`. The following config
+values can be set:
+
+<dl>
+  <dt>name</dt>
+  <dd>
+    The name of the database. May appear during storage limit prompts.
+    Useful to use the name of your app here.<br>
+    Default: <code>'localforage'</code>
+  </dd>
+  <dt>size</dt>
+  <dd>
+    The size of the database in bytes. Used only in WebSQL for now.<br>
+    Default: <code>4980736</code>
+  </dd>
+  <dt>storeName</dt>
+  <dd>
+    The name of the datastore. In IndexedDB this is the
+    <code>dataStore</code>, in WebSQL this is the name of the key/value
+    table in the database. In localStorage, this is used as a key prefix for
+    all keys stored in localStorage.<br>
+    Default: <code>'keyvaluepairs'</code>
+  </dd>
+  <dt>version</dt>
+  <dd>
+    The version of your database. May be used for upgrades in the future;
+    currently unused.<br>
+    Default: <code>1.0</code>
+  </dd>
+  <dt>description</dt>
+  <dd>
+    A description of the database, essentially for developer usage.<br>
+    Default: <code>''</code>
+  </dd>
+</dl>
+
+<aside class="notice">
+  Unlike most of the localForage API, the <code>config</code> method is
+  synchronous.
+</aside>

docs/localforage.min.js

@@ -1,1 +0,1 @@
-!function(){var a,b,c,d;!function(){var e={},f={};a=function(a,b,c){e[a]={deps:b,callback:c}},d=c=b=function(a){function c(b){if("."!==b.charAt(0))return b;for(var c=b.split("/"),d=a.split("/").slice(0,-1),e=0,f=c.length;f>e;e++){var g=c[e];if(".."===g)d.pop();else{if("."===g)continue;d.push(g)}}return d.join("/")}if(d._eak_seen=e,f[a])return f[a];if(f[a]={},!e[a])throw new Error("Could not find module "+a);for(var g,h=e[a],i=h.deps,j=h.callback,k=[],l=0,m=i.length;m>l;l++)k.push("exports"===i[l]?g={}:b(c(i[l])));var n=j.apply(this,k);return f[a]=g||n}}(),a("promise/all",["./utils","exports"],function(a,b){"use strict";function c(a){var b=this;if(!d(a))throw new TypeError("You must pass an array to all.");return new b(function(b,c){function d(a){return function(b){f(a,b)}}function f(a,c){h[a]=c,0===--i&&b(h)}var g,h=[],i=a.length;0===i&&b([]);for(var j=0;j<a.length;j++)g=a[j],g&&e(g.then)?g.then(d(j),c):f(j,g)})}var d=a.isArray,e=a.isFunction;b.all=c}),a("promise/asap",["exports"],function(a){"use strict";function b(){return function(){process.nextTick(e)}}function c(){var a=0,b=new i(e),c=document.createTextNode("");return b.observe(c,{characterData:!0}),function(){c.data=a=++a%2}}function d(){return function(){j.setTimeout(e,1)}}function e(){for(var a=0;a<k.length;a++){var b=k[a],c=b[0],d=b[1];c(d)}k=[]}function f(a,b){var c=k.push([a,b]);1===c&&g()}var g,h="undefined"!=typeof window?window:{},i=h.MutationObserver||h.WebKitMutationObserver,j="undefined"!=typeof global?global:this,k=[];g="undefined"!=typeof process&&"[object process]"==={}.toString.call(process)?b():i?c():d(),a.asap=f}),a("promise/cast",["exports"],function(a){"use strict";function b(a){if(a&&"object"==typeof a&&a.constructor===this)return a;var b=this;return new b(function(b){b(a)})}a.cast=b}),a("promise/config",["exports"],function(a){"use strict";function b(a,b){return 2!==arguments.length?c[a]:void(c[a]=b)}var c={instrument:!1};a.config=c,a.configure=b}),a("promise/polyfill",["./promise","./utils","exports"],function(a,b,c){"use strict";function d(){var a="Promise"in window&&"cast"in window.Promise&&"resolve"in window.Promise&&"reject"in window.Promise&&"all"in window.Promise&&"race"in window.Promise&&function(){var a;return new window.Promise(function(b){a=b}),f(a)}();a||(window.Promise=e)}var e=a.Promise,f=b.isFunction;c.polyfill=d}),a("promise/promise",["./config","./utils","./cast","./all","./race","./resolve","./reject","./asap","exports"],function(a,b,c,d,e,f,g,h,i){"use strict";function j(a){if(!w(a))throw new TypeError("You must pass a resolver function as the first argument to the promise constructor");if(!(this instanceof j))throw new TypeError("Failed to construct 'Promise': Please use the 'new' operator, this object constructor cannot be called as a function.");this._subscribers=[],k(a,this)}function k(a,b){function c(a){p(b,a)}function d(a){r(b,a)}try{a(c,d)}catch(e){d(e)}}function l(a,b,c,d){var e,f,g,h,i=w(c);if(i)try{e=c(d),g=!0}catch(j){h=!0,f=j}else e=d,g=!0;o(b,e)||(i&&g?p(b,e):h?r(b,f):a===F?p(b,e):a===G&&r(b,e))}function m(a,b,c,d){var e=a._subscribers,f=e.length;e[f]=b,e[f+F]=c,e[f+G]=d}function n(a,b){for(var c,d,e=a._subscribers,f=a._detail,g=0;g<e.length;g+=3)c=e[g],d=e[g+b],l(b,c,d,f);a._subscribers=null}function o(a,b){var c,d=null;try{if(a===b)throw new TypeError("A promises callback cannot return that same promise.");if(v(b)&&(d=b.then,w(d)))return d.call(b,function(d){return c?!0:(c=!0,void(b!==d?p(a,d):q(a,d)))},function(b){return c?!0:(c=!0,void r(a,b))}),!0}catch(e){return c?!0:(r(a,e),!0)}return!1}function p(a,b){a===b?q(a,b):o(a,b)||q(a,b)}function q(a,b){a._state===D&&(a._state=E,a._detail=b,u.async(s,a))}function r(a,b){a._state===D&&(a._state=E,a._detail=b,u.async(t,a))}function s(a){n(a,a._state=F)}function t(a){n(a,a._state=G)}var u=a.config,v=(a.configure,b.objectOrFunction),w=b.isFunction,x=(b.now,c.cast),y=d.all,z=e.race,A=f.resolve,B=g.reject,C=h.asap;u.async=C;var D=void 0,E=0,F=1,G=2;j.prototype={constructor:j,_state:void 0,_detail:void 0,_subscribers:void 0,then:function(a,b){var c=this,d=new this.constructor(function(){});if(this._state){var e=arguments;u.async(function(){l(c._state,d,e[c._state-1],c._detail)})}else m(this,d,a,b);return d},"catch":function(a){return this.then(null,a)}},j.all=y,j.cast=x,j.race=z,j.resolve=A,j.reject=B,i.Promise=j}),a("promise/race",["./utils","exports"],function(a,b){"use strict";function c(a){var b=this;if(!d(a))throw new TypeError("You must pass an array to race.");return new b(function(b,c){for(var d,e=0;e<a.length;e++)d=a[e],d&&"function"==typeof d.then?d.then(b,c):b(d)})}var d=a.isArray;b.race=c}),a("promise/reject",["exports"],function(a){"use strict";function b(a){var b=this;return new b(function(b,c){c(a)})}a.reject=b}),a("promise/resolve",["exports"],function(a){"use strict";function b(a){var b=this;return new b(function(b){b(a)})}a.resolve=b}),a("promise/utils",["exports"],function(a){"use strict";function b(a){return c(a)||"object"==typeof a&&null!==a}function c(a){return"function"==typeof a}function d(a){return"[object Array]"===Object.prototype.toString.call(a)}var e=Date.now||function(){return(new Date).getTime()};a.objectOrFunction=b,a.isFunction=c,a.isArray=d,a.now=e}),b("promise/polyfill").polyfill()}(),function(){"use strict";function a(a){if(a)for(var b in j)void 0!==a[b]&&(j[b]=a[b]);return new h(function(a,b){var c=k.open(j.name,j.version);c.onerror=function(){b(c.error.name)},c.onupgradeneeded=function(){c.result.createObjectStore(j.storeName)},c.onsuccess=function(){i=c.result,a()}})}function b(a,b){var c=this;return new h(function(d,e){c.ready().then(function(){var c=i.transaction(j.storeName,"readonly").objectStore(j.storeName),f=c.get(a);f.onsuccess=function(){var a=f.result;void 0===a&&(a=null),b&&b(a),d(a)},f.onerror=function(){e(f.error.name)}})})}function c(a,b,c){var d=this;return new h(function(e,f){d.ready().then(function(){var d=i.transaction(j.storeName,"readwrite").objectStore(j.storeName);void 0===b&&(b=null);var g=d.put(b,a);g.onsuccess=function(){c&&c(b),e(b)},g.onerror=function(){f(g.error.name)}})})}function d(a,b){var c=this;return new h(function(d,e){c.ready().then(function(){var c=i.transaction(j.storeName,"readwrite").objectStore(j.storeName),f=c["delete"](a);f.onsuccess=function(){b&&b(),d()},f.onerror=function(){e(f.error.name)}})})}function e(a){var b=this;return new h(function(c,d){b.ready().then(function(){var b=i.transaction(j.storeName,"readwrite").objectStore(j.storeName),e=b.clear();e.onsuccess=function(){a&&a(),c()},e.onerror=function(){d(e.error.name)}})})}function f(a){var b=this;return new h(function(c,d){b.ready().then(function(){var b=i.transaction(j.storeName,"readonly").objectStore(j.storeName),e=b.count();e.onsuccess=function(){a&&a(e.result),c(e.result)},e.onerror=function(){d(e.error.name)}})})}function g(a,b){var c=this;return new h(function(d,e){return 0>a?(b&&b(null),void d(null)):void c.ready().then(function(){var c=i.transaction(j.storeName,"readonly").objectStore(j.storeName),f=!1,g=c.openCursor();g.onsuccess=function(){var c=g.result;return c?void(0===a?(b&&b(c.key),d(c.key)):f?(b&&b(c.key),d(c.key)):(f=!0,c.advance(a))):(b&&b(null),void d(null))},g.onerror=function(){e(g.error.name)}})})}var h=this.Promise,i=null,j={name:"localforage",storeName:"keyvaluepairs",version:1},k=k||this.indexedDB||this.webkitIndexedDB||this.mozIndexedDB||this.OIndexedDB||this.msIndexedDB;if(k){var l={_driver:"asyncStorage",_initStorage:a,getItem:b,setItem:c,removeItem:d,clear:e,length:f,key:g};"function"==typeof define&&define.amd?define("asyncStorage",function(){return l}):"undefined"!=typeof module&&module.exports?module.exports=l:this.asyncStorage=l}}.call(this),function(){"use strict";function a(a){if(a)for(var b in l)void 0!==a[b]&&(l[b]=a[b]);return k=l.name+"/",m.resolve()}function b(a){var b=this;return new m(function(c){b.ready().then(function(){n.clear(),a&&a(),c()})})}function c(a,b){var c=this;return new m(function(d,e){c.ready().then(function(){try{var c=n.getItem(k+a);c&&(c=g(c)),b&&b(c),d(c)}catch(f){e(f)}})})}function d(a,b){var c=this;return new m(function(d){c.ready().then(function(){var c=n.key(a);c&&(c=c.substring(k.length)),b&&b(c),d(c)})})}function e(a){var b=this;return new m(function(c){b.ready().then(function(){var b=n.length;a&&a(b),c(b)})})}function f(a,b){var c=this;return new m(function(d){c.ready().then(function(){n.removeItem(k+a),b&&b(),d()})})}function g(a){if(a.substring(0,q)!==p)return JSON.parse(a);for(var b=a.substring(C),c=a.substring(q,C),d=new ArrayBuffer(2*b.length),e=new Uint16Array(d),f=b.length-1;f>=0;f--)e[f]=b.charCodeAt(f);switch(c){case r:return d;case s:return new Blob([d]);case t:return new Int8Array(d);case u:return new Uint8Array(d);case v:return new Uint8ClampedArray(d);case w:return new Int16Array(d);case y:return new Uint16Array(d);case x:return new Int32Array(d);case z:return new Uint32Array(d);case A:return new Float32Array(d);case B:return new Float64Array(d);default:throw new Error("Unkown type: "+c)}}function h(a){var b="",c=new Uint16Array(a);try{b=String.fromCharCode.apply(null,c)}catch(d){for(var e=0;e<c.length;e++)b+=String.fromCharCode(c[e])}return b}function i(a,b){var c="";if(a&&(c=a.toString()),a&&("[object ArrayBuffer]"===a.toString()||a.buffer&&"[object ArrayBuffer]"===a.buffer.toString())){var d,e=p;a instanceof ArrayBuffer?(d=a,e+=r):(d=a.buffer,"[object Int8Array]"===c?e+=t:"[object Uint8Array]"===c?e+=u:"[object Uint8ClampedArray]"===c?e+=v:"[object Int16Array]"===c?e+=w:"[object Uint16Array]"===c?e+=y:"[object Int32Array]"===c?e+=x:"[object Uint32Array]"===c?e+=z:"[object Float32Array]"===c?e+=A:"[object Float64Array]"===c?e+=B:b(new Error("Failed to get type for BinaryArray")));var f=h(d);b(null,e+f)}else if("[object Blob]"===c){var g=new FileReader;g.onload=function(){var a=h(this.result);b(null,p+s+a)},g.readAsArrayBuffer(a)}else try{b(null,JSON.stringify(a))}catch(i){window.console&&window.console.error&&window.console.error("Couldn't convert value into a JSON string: ",a),b(i)}}function j(a,b,c){var d=this;return new m(function(e,f){d.ready().then(function(){void 0===b&&(b=null);var d=b;i(b,function(b,g){b?f(b):(n.setItem(k+a,g),c&&c(d),e(d))})})})}var k="",l={name:"localforage"},m=this.Promise,n=null;try{n=this.localStorage}catch(o){return}var p="__lfsc__:",q=p.length,r="arbf",s="blob",t="si08",u="ui08",v="uic8",w="si16",x="si32",y="ur16",z="ui32",A="fl32",B="fl64",C=q+r.length,D={_driver:"localStorageWrapper",_initStorage:a,getItem:c,setItem:j,removeItem:f,clear:b,length:e,key:d};"function"==typeof define&&define.amd?define("localStorageWrapper",function(){return D}):"undefined"!=typeof module&&module.exports?module.exports=D:this.localStorageWrapper=D}.call(this),function(){"use strict";function a(a){if(a)for(var b in o)void 0!==a[b]&&(o[b]="string"!=typeof a[b]?a[b].toString():a[b]);return new l(function(a){n=m(o.name,o.version,o.description,o.size),n.transaction(function(b){b.executeSql("CREATE TABLE IF NOT EXISTS "+o.storeName+" (id INTEGER PRIMARY KEY, key unique, value)",[],function(){a()},null)})})}function b(a,b){var c=this;return new l(function(d){c.ready().then(function(){n.transaction(function(c){c.executeSql("SELECT * FROM "+o.storeName+" WHERE key = ? LIMIT 1",[a],function(a,c){var e=c.rows.length?c.rows.item(0).value:null;e&&(e=i(e)),b&&b(e),d(e)},null)})})})}function c(a,b,c){var d=this;return new l(function(e,f){d.ready().then(function(){void 0===b&&(b=null);var d=b;j(b,function(b,g){b?f(b):n.transaction(function(b){b.executeSql("INSERT OR REPLACE INTO "+o.storeName+" (key, value) VALUES (?, ?)",[a,g],function(){c&&c(d),e(d)},null)})})})})}function d(a,b){var c=this;return new l(function(d){c.ready().then(function(){n.transaction(function(c){c.executeSql("DELETE FROM "+o.storeName+" WHERE key = ?",[a],function(){b&&b(),d()},null)})})})}function e(a){var b=this;return new l(function(c){b.ready().then(function(){n.transaction(function(b){b.executeSql("DELETE FROM "+o.storeName,[],function(){a&&a(),c()},null)})})})}function f(a){var b=this;return new l(function(c){b.ready().then(function(){n.transaction(function(b){b.executeSql("SELECT COUNT(key) as c FROM "+o.storeName,[],function(b,d){var e=d.rows.item(0).c;a&&a(e),c(e)},null)})})})}function g(a,b){var c=this;return new l(function(d){c.ready().then(function(){n.transaction(function(c){c.executeSql("SELECT key FROM "+o.storeName+" WHERE id = ? LIMIT 1",[a+1],function(a,c){var e=c.rows.length?c.rows.item(0).key:null;b&&b(e),d(e)},null)})})})}function h(a){var b,c=new Uint8Array(a),d="";for(b=0;b<c.length;b+=3)d+=k[c[b]>>2],d+=k[(3&c[b])<<4|c[b+1]>>4],d+=k[(15&c[b+1])<<2|c[b+2]>>6],d+=k[63&c[b+2]];return c.length%3===2?d=d.substring(0,d.length-1)+"=":c.length%3===1&&(d=d.substring(0,d.length-2)+"=="),d}function i(a){if(a.substring(0,q)!==p)return JSON.parse(a);var b,c,d,e,f,g=a.substring(C),h=a.substring(q,C),i=.75*g.length,j=g.length,l=0;"="===g[g.length-1]&&(i--,"="===g[g.length-2]&&i--);var m=new ArrayBuffer(i),n=new Uint8Array(m);for(b=0;j>b;b+=4)c=k.indexOf(g[b]),d=k.indexOf(g[b+1]),e=k.indexOf(g[b+2]),f=k.indexOf(g[b+3]),n[l++]=c<<2|d>>4,n[l++]=(15&d)<<4|e>>2,n[l++]=(3&e)<<6|63&f;switch(h){case r:return m;case s:return new Blob([m]);case t:return new Int8Array(m);case u:return new Uint8Array(m);case v:return new Uint8ClampedArray(m);case w:return new Int16Array(m);case y:return new Uint16Array(m);case x:return new Int32Array(m);case z:return new Uint32Array(m);case A:return new Float32Array(m);case B:return new Float64Array(m);default:throw new Error("Unkown type: "+h)}}function j(a,b){var c="";if(a&&(c=a.toString()),a&&("[object ArrayBuffer]"===a.toString()||a.buffer&&"[object ArrayBuffer]"===a.buffer.toString())){var d,e=p;a instanceof ArrayBuffer?(d=a,e+=r):(d=a.buffer,"[object Int8Array]"===c?e+=t:"[object Uint8Array]"===c?e+=u:"[object Uint8ClampedArray]"===c?e+=v:"[object Int16Array]"===c?e+=w:"[object Uint16Array]"===c?e+=y:"[object Int32Array]"===c?e+=x:"[object Uint32Array]"===c?e+=z:"[object Float32Array]"===c?e+=A:"[object Float64Array]"===c?e+=B:b(new Error("Failed to get type for BinaryArray")));var f=h(d);b(null,e+f)}else if("[object Blob]"===c){var g=new FileReader;g.onload=function(){var a=h(this.result);b(null,p+s+a)},g.readAsArrayBuffer(a)}else try{b(null,JSON.stringify(a))}catch(i){window.console&&window.console.error&&window.console.error("Couldn't convert value into a JSON string: ",a),b(i)}}var k="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/",l=this.Promise,m=this.openDatabase,n=null,o={description:"",name:"localforage",size:4980736,storeName:"keyvaluepairs",version:"1.0"},p="__lfsc__:",q=p.length,r="arbf",s="blob",t="si08",u="ui08",v="uic8",w="si16",x="si32",y="ur16",z="ui32",A="fl32",B="fl64",C=q+r.length;if(m){var D={_driver:"webSQLStorage",_initStorage:a,getItem:b,setItem:c,removeItem:d,clear:e,length:f,key:g};"function"==typeof define&&define.amd?define("webSQLStorage",function(){return D}):"undefined"!=typeof module&&module.exports?module.exports=D:this.webSQLStorage=D}}.call(this),function(){"use strict";var a=this.Promise,b=1,c=2,d=3,e=d;"function"==typeof define&&define.amd?e=b:"undefined"!=typeof module&&module.exports&&(e=c);var f,g=g||this.indexedDB||this.webkitIndexedDB||this.mozIndexedDB||this.OIndexedDB||this.msIndexedDB,h=this.openDatabase,i=this,j={INDEXEDDB:"asyncStorage",LOCALSTORAGE:"localStorageWrapper",WEBSQL:"webSQLStorage",config:{},driver:function(){return this._driver||null},_ready:a.reject(new Error("setDriver() wasn't called")),setDriver:function(d,f){var k=new a(function(a,f){if(!g&&d===j.INDEXEDDB||!h&&d===j.WEBSQL)return void f(j);if(j._ready=null,e===b)return void require([d],function(b){j._extend(b),a(j)});if(e===c){var k;switch(d){case j.INDEXEDDB:k=require("localforage/src/drivers/indexeddb");break;case j.LOCALSTORAGE:k=require("localforage/src/drivers/localstorage");break;case j.WEBSQL:k=require("localforage/src/drivers/websql")}j._extend(k)}else j._extend(i[d]);a(j)});return k.then(f,f),k},ready:function(a){return null===this._ready&&(this._ready=this._initStorage(this.config)),this._ready.then(a,a),this._ready},_extend:function(a){for(var b in a)a.hasOwnProperty(b)&&(this[b]=a[b])}};f=g&&null===g.open("_localforage_spec_test",1).onupgradeneeded?j.INDEXEDDB:h?j.WEBSQL:j.LOCALSTORAGE,this.localForageConfig&&(j.config=this.localForageConfig),j.setDriver(f),e===b?define(function(){return j}):e===c?module.exports=j:this.localforage=j}.call(this);
+!function(){var a,b,c,d;!function(){var e={},f={};a=function(a,b,c){e[a]={deps:b,callback:c}},d=c=b=function(a){function c(b){if("."!==b.charAt(0))return b;for(var c=b.split("/"),d=a.split("/").slice(0,-1),e=0,f=c.length;f>e;e++){var g=c[e];if(".."===g)d.pop();else{if("."===g)continue;d.push(g)}}return d.join("/")}if(d._eak_seen=e,f[a])return f[a];if(f[a]={},!e[a])throw new Error("Could not find module "+a);for(var g,h=e[a],i=h.deps,j=h.callback,k=[],l=0,m=i.length;m>l;l++)k.push("exports"===i[l]?g={}:b(c(i[l])));var n=j.apply(this,k);return f[a]=g||n}}(),a("promise/all",["./utils","exports"],function(a,b){"use strict";function c(a){var b=this;if(!d(a))throw new TypeError("You must pass an array to all.");return new b(function(b,c){function d(a){return function(b){f(a,b)}}function f(a,c){h[a]=c,0===--i&&b(h)}var g,h=[],i=a.length;0===i&&b([]);for(var j=0;j<a.length;j++)g=a[j],g&&e(g.then)?g.then(d(j),c):f(j,g)})}var d=a.isArray,e=a.isFunction;b.all=c}),a("promise/asap",["exports"],function(a){"use strict";function b(){return function(){process.nextTick(e)}}function c(){var a=0,b=new i(e),c=document.createTextNode("");return b.observe(c,{characterData:!0}),function(){c.data=a=++a%2}}function d(){return function(){j.setTimeout(e,1)}}function e(){for(var a=0;a<k.length;a++){var b=k[a],c=b[0],d=b[1];c(d)}k=[]}function f(a,b){var c=k.push([a,b]);1===c&&g()}var g,h="undefined"!=typeof window?window:{},i=h.MutationObserver||h.WebKitMutationObserver,j="undefined"!=typeof global?global:this,k=[];g="undefined"!=typeof process&&"[object process]"==={}.toString.call(process)?b():i?c():d(),a.asap=f}),a("promise/cast",["exports"],function(a){"use strict";function b(a){if(a&&"object"==typeof a&&a.constructor===this)return a;var b=this;return new b(function(b){b(a)})}a.cast=b}),a("promise/config",["exports"],function(a){"use strict";function b(a,b){return 2!==arguments.length?c[a]:void(c[a]=b)}var c={instrument:!1};a.config=c,a.configure=b}),a("promise/polyfill",["./promise","./utils","exports"],function(a,b,c){"use strict";function d(){var a="Promise"in window&&"cast"in window.Promise&&"resolve"in window.Promise&&"reject"in window.Promise&&"all"in window.Promise&&"race"in window.Promise&&function(){var a;return new window.Promise(function(b){a=b}),f(a)}();a||(window.Promise=e)}var e=a.Promise,f=b.isFunction;c.polyfill=d}),a("promise/promise",["./config","./utils","./cast","./all","./race","./resolve","./reject","./asap","exports"],function(a,b,c,d,e,f,g,h,i){"use strict";function j(a){if(!w(a))throw new TypeError("You must pass a resolver function as the first argument to the promise constructor");if(!(this instanceof j))throw new TypeError("Failed to construct 'Promise': Please use the 'new' operator, this object constructor cannot be called as a function.");this._subscribers=[],k(a,this)}function k(a,b){function c(a){p(b,a)}function d(a){r(b,a)}try{a(c,d)}catch(e){d(e)}}function l(a,b,c,d){var e,f,g,h,i=w(c);if(i)try{e=c(d),g=!0}catch(j){h=!0,f=j}else e=d,g=!0;o(b,e)||(i&&g?p(b,e):h?r(b,f):a===F?p(b,e):a===G&&r(b,e))}function m(a,b,c,d){var e=a._subscribers,f=e.length;e[f]=b,e[f+F]=c,e[f+G]=d}function n(a,b){for(var c,d,e=a._subscribers,f=a._detail,g=0;g<e.length;g+=3)c=e[g],d=e[g+b],l(b,c,d,f);a._subscribers=null}function o(a,b){var c,d=null;try{if(a===b)throw new TypeError("A promises callback cannot return that same promise.");if(v(b)&&(d=b.then,w(d)))return d.call(b,function(d){return c?!0:(c=!0,void(b!==d?p(a,d):q(a,d)))},function(b){return c?!0:(c=!0,void r(a,b))}),!0}catch(e){return c?!0:(r(a,e),!0)}return!1}function p(a,b){a===b?q(a,b):o(a,b)||q(a,b)}function q(a,b){a._state===D&&(a._state=E,a._detail=b,u.async(s,a))}function r(a,b){a._state===D&&(a._state=E,a._detail=b,u.async(t,a))}function s(a){n(a,a._state=F)}function t(a){n(a,a._state=G)}var u=a.config,v=(a.configure,b.objectOrFunction),w=b.isFunction,x=(b.now,c.cast),y=d.all,z=e.race,A=f.resolve,B=g.reject,C=h.asap;u.async=C;var D=void 0,E=0,F=1,G=2;j.prototype={constructor:j,_state:void 0,_detail:void 0,_subscribers:void 0,then:function(a,b){var c=this,d=new this.constructor(function(){});if(this._state){var e=arguments;u.async(function(){l(c._state,d,e[c._state-1],c._detail)})}else m(this,d,a,b);return d},"catch":function(a){return this.then(null,a)}},j.all=y,j.cast=x,j.race=z,j.resolve=A,j.reject=B,i.Promise=j}),a("promise/race",["./utils","exports"],function(a,b){"use strict";function c(a){var b=this;if(!d(a))throw new TypeError("You must pass an array to race.");return new b(function(b,c){for(var d,e=0;e<a.length;e++)d=a[e],d&&"function"==typeof d.then?d.then(b,c):b(d)})}var d=a.isArray;b.race=c}),a("promise/reject",["exports"],function(a){"use strict";function b(a){var b=this;return new b(function(b,c){c(a)})}a.reject=b}),a("promise/resolve",["exports"],function(a){"use strict";function b(a){var b=this;return new b(function(b){b(a)})}a.resolve=b}),a("promise/utils",["exports"],function(a){"use strict";function b(a){return c(a)||"object"==typeof a&&null!==a}function c(a){return"function"==typeof a}function d(a){return"[object Array]"===Object.prototype.toString.call(a)}var e=Date.now||function(){return(new Date).getTime()};a.objectOrFunction=b,a.isFunction=c,a.isArray=d,a.now=e}),b("promise/polyfill").polyfill()}(),function(){"use strict";function a(a){if(a)for(var b in a)j[b]=a[b];return new h(function(a,b){var c=k.open(j.name,j.version);c.onerror=function(){b(c.error.name)},c.onupgradeneeded=function(){c.result.createObjectStore(j.storeName)},c.onsuccess=function(){i=c.result,a()}})}function b(a,b){var c=this;return new h(function(d,e){c.ready().then(function(){var c=i.transaction(j.storeName,"readonly").objectStore(j.storeName),f=c.get(a);f.onsuccess=function(){var a=f.result;void 0===a&&(a=null),b&&b(a),d(a)},f.onerror=function(){b&&b(null,f.error.name),e(f.error.name)}})})}function c(a,b,c){var d=this;return new h(function(e,f){d.ready().then(function(){var d=i.transaction(j.storeName,"readwrite").objectStore(j.storeName);void 0===b&&(b=null);var g=d.put(b,a);g.onsuccess=function(){c&&c(b),e(b)},g.onerror=function(){c&&c(null,g.error.name),f(g.error.name)}})})}function d(a,b){var c=this;return new h(function(d,e){c.ready().then(function(){var c=i.transaction(j.storeName,"readwrite").objectStore(j.storeName),f=c["delete"](a);f.onsuccess=function(){b&&b(),d()},f.onerror=function(){b&&b(f.error.name),e(f.error.name)},f.onabort=function(a){var c=a.target.error;"QuotaExceededError"===c.name&&(b&&b(c.name),e(c.name))}})})}function e(a){var b=this;return new h(function(c,d){b.ready().then(function(){var b=i.transaction(j.storeName,"readwrite").objectStore(j.storeName),e=b.clear();e.onsuccess=function(){a&&a(),c()},e.onerror=function(){a&&a(null,e.error.name),d(e.error.name)}})})}function f(a){var b=this;return new h(function(c,d){b.ready().then(function(){var b=i.transaction(j.storeName,"readonly").objectStore(j.storeName),e=b.count();e.onsuccess=function(){a&&a(e.result),c(e.result)},e.onerror=function(){a&&a(null,e.error.name),d(e.error.name)}})})}function g(a,b){var c=this;return new h(function(d,e){return 0>a?(b&&b(null),void d(null)):void c.ready().then(function(){var c=i.transaction(j.storeName,"readonly").objectStore(j.storeName),f=!1,g=c.openCursor();g.onsuccess=function(){var c=g.result;return c?void(0===a?(b&&b(c.key),d(c.key)):f?(b&&b(c.key),d(c.key)):(f=!0,c.advance(a))):(b&&b(null),void d(null))},g.onerror=function(){b&&b(null,g.error.name),e(g.error.name)}})})}var h=this.Promise,i=null,j={},k=k||this.indexedDB||this.webkitIndexedDB||this.mozIndexedDB||this.OIndexedDB||this.msIndexedDB;if(k){var l={_driver:"asyncStorage",_initStorage:a,getItem:b,setItem:c,removeItem:d,clear:e,length:f,key:g};"function"==typeof define&&define.amd?define("asyncStorage",function(){return l}):"undefined"!=typeof module&&module.exports?module.exports=l:this.asyncStorage=l}}.call(this),function(){"use strict";function a(a){if(a)for(var b in a)l[b]=a[b];return k=l.name+"/",m.resolve()}function b(a){var b=this;return new m(function(c){b.ready().then(function(){n.clear(),a&&a(),c()})})}function c(a,b){var c=this;return new m(function(d,e){c.ready().then(function(){try{var c=n.getItem(k+a);c&&(c=g(c)),b&&b(c,null),d(c)}catch(f){b&&b(null,f),e(f)}})})}function d(a,b){var c=this;return new m(function(d){c.ready().then(function(){var c=n.key(a);c&&(c=c.substring(k.length)),b&&b(c),d(c)})})}function e(a){var b=this;return new m(function(c){b.ready().then(function(){var b=n.length;a&&a(b),c(b)})})}function f(a,b){var c=this;return new m(function(d){c.ready().then(function(){n.removeItem(k+a),b&&b(),d()})})}function g(a){if(a.substring(0,q)!==p)return JSON.parse(a);for(var b=a.substring(C),c=a.substring(q,C),d=new ArrayBuffer(2*b.length),e=new Uint16Array(d),f=b.length-1;f>=0;f--)e[f]=b.charCodeAt(f);switch(c){case r:return d;case s:return new Blob([d]);case t:return new Int8Array(d);case u:return new Uint8Array(d);case v:return new Uint8ClampedArray(d);case w:return new Int16Array(d);case y:return new Uint16Array(d);case x:return new Int32Array(d);case z:return new Uint32Array(d);case A:return new Float32Array(d);case B:return new Float64Array(d);default:throw new Error("Unkown type: "+c)}}function h(a){var b="",c=new Uint16Array(a);try{b=String.fromCharCode.apply(null,c)}catch(d){for(var e=0;e<c.length;e++)b+=String.fromCharCode(c[e])}return b}function i(a,b){var c="";if(a&&(c=a.toString()),a&&("[object ArrayBuffer]"===a.toString()||a.buffer&&"[object ArrayBuffer]"===a.buffer.toString())){var d,e=p;a instanceof ArrayBuffer?(d=a,e+=r):(d=a.buffer,"[object Int8Array]"===c?e+=t:"[object Uint8Array]"===c?e+=u:"[object Uint8ClampedArray]"===c?e+=v:"[object Int16Array]"===c?e+=w:"[object Uint16Array]"===c?e+=y:"[object Int32Array]"===c?e+=x:"[object Uint32Array]"===c?e+=z:"[object Float32Array]"===c?e+=A:"[object Float64Array]"===c?e+=B:b(new Error("Failed to get type for BinaryArray"))),b(e+h(d))}else if("[object Blob]"===c){var f=new FileReader;f.onload=function(){var a=h(this.result);b(p+s+a)},f.readAsArrayBuffer(a)}else try{b(JSON.stringify(a))}catch(g){window.console&&window.console.error&&window.console.error("Couldn't convert value into a JSON string: ",a),b(null,g)}}function j(a,b,c){var d=this;return new m(function(e,f){d.ready().then(function(){void 0===b&&(b=null);var d=b;i(b,function(b,g){if(g)c&&c(null,g),f(g);else{try{n.setItem(k+a,b)}catch(h){("QuotaExceededError"===h.name||"NS_ERROR_DOM_QUOTA_REACHED"===h.name)&&(c&&c(null,h),f(h))}c&&c(d),e(d)}})})})}var k="",l={},m=this.Promise,n=null;try{n=this.localStorage}catch(o){return}var p="__lfsc__:",q=p.length,r="arbf",s="blob",t="si08",u="ui08",v="uic8",w="si16",x="si32",y="ur16",z="ui32",A="fl32",B="fl64",C=q+r.length,D={_driver:"localStorageWrapper",_initStorage:a,getItem:c,setItem:j,removeItem:f,clear:b,length:e,key:d};"function"==typeof define&&define.amd?define("localStorageWrapper",function(){return D}):"undefined"!=typeof module&&module.exports?module.exports=D:this.localStorageWrapper=D}.call(this),function(){"use strict";function a(a){var b=this;if(a)for(var c in o)o[c]="string"!=typeof a[c]?a[c].toString():a[c];return new l(function(a){try{n=m(o.name,o.version,o.description,o.size)}catch(c){return b.setDriver("localStorageWrapper").then(a)}n.transaction(function(b){b.executeSql("CREATE TABLE IF NOT EXISTS "+o.storeName+" (id INTEGER PRIMARY KEY, key unique, value)",[],function(){a()},null)})})}function b(a,b){var c=this;return new l(function(d,e){c.ready().then(function(){n.transaction(function(c){c.executeSql("SELECT * FROM "+o.storeName+" WHERE key = ? LIMIT 1",[a],function(a,c){var e=c.rows.length?c.rows.item(0).value:null;e&&(e=i(e)),b&&b(e),d(e)},function(a,c){b&&b(null,c),e(c)})})})})}function c(a,b,c){var d=this;return new l(function(e,f){d.ready().then(function(){void 0===b&&(b=null);var d=b;j(b,function(b,g){g?f(g):n.transaction(function(g){g.executeSql("INSERT OR REPLACE INTO "+o.storeName+" (key, value) VALUES (?, ?)",[a,b],function(){c&&c(d),e(d)},function(a,b){c&&c(null,b),f(b)})},function(a){a.code===a.QUOTA_ERR&&(c&&c(null,a),f(a))})})})})}function d(a,b){var c=this;return new l(function(d,e){c.ready().then(function(){n.transaction(function(c){c.executeSql("DELETE FROM "+o.storeName+" WHERE key = ?",[a],function(){b&&b(),d()},function(a,c){b&&b(c),e(c)})})})})}function e(a){var b=this;return new l(function(c,d){b.ready().then(function(){n.transaction(function(b){b.executeSql("DELETE FROM "+o.storeName,[],function(){a&&a(),c()},function(b,c){a&&a(c),d(c)})})})})}function f(a){var b=this;return new l(function(c,d){b.ready().then(function(){n.transaction(function(b){b.executeSql("SELECT COUNT(key) as c FROM "+o.storeName,[],function(b,d){var e=d.rows.item(0).c;a&&a(e),c(e)},function(b,c){a&&a(null,c),d(c)})})})})}function g(a,b){var c=this;return new l(function(d,e){c.ready().then(function(){n.transaction(function(c){c.executeSql("SELECT key FROM "+o.storeName+" WHERE id = ? LIMIT 1",[a+1],function(a,c){var e=c.rows.length?c.rows.item(0).key:null;b&&b(e),d(e)},function(a,c){b&&b(null,c),e(c)})})})})}function h(a){var b,c=new Uint8Array(a),d="";for(b=0;b<c.length;b+=3)d+=k[c[b]>>2],d+=k[(3&c[b])<<4|c[b+1]>>4],d+=k[(15&c[b+1])<<2|c[b+2]>>6],d+=k[63&c[b+2]];return c.length%3===2?d=d.substring(0,d.length-1)+"=":c.length%3===1&&(d=d.substring(0,d.length-2)+"=="),d}function i(a){if(a.substring(0,q)!==p)return JSON.parse(a);var b,c,d,e,f,g=a.substring(C),h=a.substring(q,C),i=.75*g.length,j=g.length,l=0;"="===g[g.length-1]&&(i--,"="===g[g.length-2]&&i--);var m=new ArrayBuffer(i),n=new Uint8Array(m);for(b=0;j>b;b+=4)c=k.indexOf(g[b]),d=k.indexOf(g[b+1]),e=k.indexOf(g[b+2]),f=k.indexOf(g[b+3]),n[l++]=c<<2|d>>4,n[l++]=(15&d)<<4|e>>2,n[l++]=(3&e)<<6|63&f;switch(h){case r:return m;case s:return new Blob([m]);case t:return new Int8Array(m);case u:return new Uint8Array(m);case v:return new Uint8ClampedArray(m);case w:return new Int16Array(m);case y:return new Uint16Array(m);case x:return new Int32Array(m);case z:return new Uint32Array(m);case A:return new Float32Array(m);case B:return new Float64Array(m);default:throw new Error("Unkown type: "+h)}}function j(a,b){var c="";if(a&&(c=a.toString()),a&&("[object ArrayBuffer]"===a.toString()||a.buffer&&"[object ArrayBuffer]"===a.buffer.toString())){var d,e=p;a instanceof ArrayBuffer?(d=a,e+=r):(d=a.buffer,"[object Int8Array]"===c?e+=t:"[object Uint8Array]"===c?e+=u:"[object Uint8ClampedArray]"===c?e+=v:"[object Int16Array]"===c?e+=w:"[object Uint16Array]"===c?e+=y:"[object Int32Array]"===c?e+=x:"[object Uint32Array]"===c?e+=z:"[object Float32Array]"===c?e+=A:"[object Float64Array]"===c?e+=B:b(new Error("Failed to get type for BinaryArray"))),b(e+h(d))}else if("[object Blob]"===c){var f=new FileReader;f.onload=function(){var a=h(this.result);b(p+s+a)},f.readAsArrayBuffer(a)}else try{b(JSON.stringify(a))}catch(g){window.console&&window.console.error&&window.console.error("Couldn't convert value into a JSON string: ",a),b(null,g)}}var k="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/",l=this.Promise,m=this.openDatabase,n=null,o={},p="__lfsc__:",q=p.length,r="arbf",s="blob",t="si08",u="ui08",v="uic8",w="si16",x="si32",y="ur16",z="ui32",A="fl32",B="fl64",C=q+r.length;if(m){var D={_driver:"webSQLStorage",_initStorage:a,getItem:b,setItem:c,removeItem:d,clear:e,length:f,key:g};"function"==typeof define&&define.amd?define("webSQLStorage",function(){return D}):"undefined"!=typeof module&&module.exports?module.exports=D:this.webSQLStorage=D}}.call(this),function(){"use strict";var a=this.Promise,b=1,c=2,d=3,e=d;"function"==typeof define&&define.amd?e=b:"undefined"!=typeof module&&module.exports&&(e=c);var f,g=g||this.indexedDB||this.webkitIndexedDB||this.mozIndexedDB||this.OIndexedDB||this.msIndexedDB,h=this.openDatabase,i=this,j={INDEXEDDB:"asyncStorage",LOCALSTORAGE:"localStorageWrapper",WEBSQL:"webSQLStorage",_config:{description:"",name:"localforage",size:4980736,storeName:"keyvaluepairs",version:1},config:function(a){if("object"==typeof a){if(this._ready)return new Error("Can't call config() after localforage has been used.");for(var b in a)this._config[b]=a[b];return!0}return"string"==typeof a?this._config[a]:this._config},driver:function(){return this._driver||null},_ready:a.reject(new Error("setDriver() wasn't called")),setDriver:function(d,f){var k=new a(function(a,f){if(!g&&d===j.INDEXEDDB||!h&&d===j.WEBSQL)return void f(j);if(j._ready=null,e===b)return void require([d],function(b){j._extend(b),a(j)});if(e===c){var k;switch(d){case j.INDEXEDDB:k=require("localforage/src/drivers/indexeddb");break;case j.LOCALSTORAGE:k=require("localforage/src/drivers/localstorage");break;case j.WEBSQL:k=require("localforage/src/drivers/websql")}j._extend(k)}else j._extend(i[d]);a(j)});return k.then(f,f),k},ready:function(a){return null===this._ready&&(this._ready=this._initStorage(this._config)),this._ready.then(a,a),this._ready},_extend:function(a){for(var b in a)a.hasOwnProperty(b)&&(this[b]=a[b])}};f=g&&null===g.open("_localforage_spec_test",1).onupgradeneeded?j.INDEXEDDB:h?j.WEBSQL:j.LOCALSTORAGE,this.localForageConfig&&(j.config=this.localForageConfig),j.setDriver(f),e===b?define(function(){return j}):e===c?module.exports=j:this.localforage=j}.call(this);

Gruntfile.js

@@ -75,3 +75,3 @@ /*global exports:true, require:true */
                         '    localForage -- Offline Storage, Improved\n' +
-                        '    Version 0.4.2\n' +
+                        '    Version 0.6.0\n' +
                         '    http://mozilla.github.io/localForage\n' +
@@ -90,3 +90,3 @@ '    (c) 2013-2014 Mozilla, Apache License 2.0\n' +
         shell: {
-            listFolders: {
+            publishDocs: {
                 options: {
@@ -96,2 +96,8 @@ stdout: true
                 command: 'rake publish ALLOW_DIRTY=true'
+            },
+            serveDocs: {
+                options: {
+                    stdout: true
+                },
+                command: 'bundle exec middleman server'
             }
@@ -124,8 +130,11 @@ },
     grunt.registerTask('build', ['concat', 'uglify']);
-    grunt.registerTask('publish', ['build', 'shell']);
+    grunt.registerTask('docs', ['shell:serveDocs']);
+    grunt.registerTask('publish', ['build', 'shell:publishDocs']);
 
     grunt.registerTask('server', function() {
-        grunt.log.writeln('Starting web server at test/server.coffee');
+        grunt.log.writeln('Starting web servers at test/server.coffee');
 
         require('./test/server.coffee').listen(8181);
+        // Used to test cross-origin iframes.
+        require('./test/server.coffee').listen(8182);
     });
@@ -132,0 +141,0 @@

package.json

@@ -11,3 +11,3 @@ {
   ],
-  "version": "0.4.3",
+  "version": "0.6.0",
   "homepage": "https://github.com/mozilla/localForage",
@@ -14,0 +14,0 @@ "repository": {

README.md

@@ -152,3 +152,3 @@ # localForage [![Build Status](https://secure.travis-ci.org/mozilla/localForage.png?branch=master)](http://travis-ci.org/mozilla/localForage)
 ```javascript
-window.localForageConfig = {
+localforage.config({
     name        : 'myApp',
@@ -159,8 +159,8 @@ version     : 1.0,
     description : 'some description'
-};
+});
 ```
 
-**Note:** you must set `window.localForageConfig` _before_ you include
-`localforage.js` in your app. This issue is being worked on and will be fixed
-soon.
+**Note:** you must call `config()` _before_ you interact with your data. This
+means calling `config()` before using `getItem()`, `setItem()`, `removeItem()`,
+`clear()`, `key()`, or `length()`.
 
@@ -167,0 +167,0 @@ ## RequireJS

src/drivers/indexeddb.js

@@ -0,13 +1,9 @@
+// Some code originally from async_storage.js in
+// [Gaia](https://github.com/mozilla-b2g/gaia).
 (function() {
     'use strict';
 
-    // Originally found in https://github.com/mozilla-b2g/gaia/blob/e8f624e4cc9ea945727278039b3bc9bcb9f8667a/shared/js/async_storage.js
-
     var Promise = this.Promise;
     var db = null;
-    var dbInfo = {
-        name: 'localforage',
-        storeName: 'keyvaluepairs',
-        version: 1
-    };
+    var dbInfo = {};
 
@@ -28,6 +24,4 @@ // Initialize IndexedDB; fall back to vendor-prefixed versions if needed.
         if (options) {
-            for (var i in dbInfo) {
-                if (options[i] !== undefined) {
-                    dbInfo[i] = options[i];
-                }
+            for (var i in options) {
+                dbInfo[i] = options[i];
             }
@@ -56,5 +50,7 @@ }
             _this.ready().then(function() {
-                var store = db.transaction(dbInfo.storeName, 'readonly').objectStore(dbInfo.storeName);
+                var store = db.transaction(dbInfo.storeName, 'readonly')
+                              .objectStore(dbInfo.storeName);
                 var req = store.get(key);
-                req.onsuccess = function getItemOnSuccess() {
+
+                req.onsuccess = function() {
                     var value = req.result;
@@ -64,2 +60,3 @@ if (value === undefined) {
                     }
+
                     if (callback) {
@@ -71,3 +68,8 @@ callback(value);
                 };
-                req.onerror = function getItemOnError() {
+
+                req.onerror = function() {
+                    if (callback) {
+                        callback(null, req.error.name);
+                    }
+
                     reject(req.error.name);
@@ -83,3 +85,4 @@ };
             _this.ready().then(function() {
-                var store = db.transaction(dbInfo.storeName, 'readwrite').objectStore(dbInfo.storeName);
+                var store = db.transaction(dbInfo.storeName, 'readwrite')
+                              .objectStore(dbInfo.storeName);
 
@@ -96,3 +99,3 @@ // Cast to undefined so the value passed to callback/promise is
                 var req = store.put(value, key);
-                req.onsuccess = function setItemOnSuccess() {
+                req.onsuccess = function() {
                     if (callback) {
@@ -104,3 +107,7 @@ callback(value);
                 };
-                req.onerror = function setItemOnError() {
+                req.onerror = function() {
+                    if (callback) {
+                        callback(null, req.error.name);
+                    }
+
                     reject(req.error.name);
@@ -116,3 +123,4 @@ };
             _this.ready().then(function() {
-                var store = db.transaction(dbInfo.storeName, 'readwrite').objectStore(dbInfo.storeName);
+                var store = db.transaction(dbInfo.storeName, 'readwrite')
+                              .objectStore(dbInfo.storeName);
 
@@ -129,11 +137,31 @@ // We use `['delete']` instead of `.delete` because IE 8 will
                 var req = store['delete'](key);
-                req.onsuccess = function removeItemOnSuccess() {
+                req.onsuccess = function() {
                     if (callback) {
                         callback();
                     }
+
                     resolve();
                 };
-                req.onerror = function removeItemOnError() {
+
+                req.onerror = function() {
+                    if (callback) {
+                        callback(req.error.name);
+                    }
+
                     reject(req.error.name);
                 };
+
+                // The request will be aborted if we've exceeded our storage
+                // space. In this case, we will reject with a specific
+                // "QuotaExceededError".
+                req.onabort = function(event) {
+                    var error = event.target.error;
+                    if (error.name === 'QuotaExceededError') {
+                        if (callback) {
+                            callback(error.name);
+                        }
+
+                        reject(error.name);
+                    }
+                };
             });
@@ -147,5 +175,7 @@ });
             _this.ready().then(function() {
-                var store = db.transaction(dbInfo.storeName, 'readwrite').objectStore(dbInfo.storeName);
+                var store = db.transaction(dbInfo.storeName, 'readwrite')
+                              .objectStore(dbInfo.storeName);
                 var req = store.clear();
-                req.onsuccess = function clearOnSuccess() {
+
+                req.onsuccess = function() {
                     if (callback) {
@@ -157,3 +187,8 @@ callback();
                 };
-                req.onerror = function clearOnError() {
+
+                req.onerror = function() {
+                    if (callback) {
+                        callback(null, req.error.name);
+                    }
+
                     reject(req.error.name);
@@ -169,5 +204,7 @@ };
             _this.ready().then(function() {
-                var store = db.transaction(dbInfo.storeName, 'readonly').objectStore(dbInfo.storeName);
+                var store = db.transaction(dbInfo.storeName, 'readonly')
+                              .objectStore(dbInfo.storeName);
                 var req = store.count();
-                req.onsuccess = function lengthOnSuccess() {
+
+                req.onsuccess = function() {
                     if (callback) {
@@ -179,3 +216,8 @@ callback(req.result);
                 };
-                req.onerror = function lengthOnError() {
+
+                req.onerror = function() {
+                    if (callback) {
+                        callback(null, req.error.name);
+                    }
+
                     reject(req.error.name);
@@ -201,7 +243,8 @@ };
             _this.ready().then(function() {
-                var store = db.transaction(dbInfo.storeName, 'readonly').objectStore(dbInfo.storeName);
+                var store = db.transaction(dbInfo.storeName, 'readonly')
+                              .objectStore(dbInfo.storeName);
 
                 var advanced = false;
                 var req = store.openCursor();
-                req.onsuccess = function keyOnSuccess() {
+                req.onsuccess = function() {
                     var cursor = req.result;
@@ -218,4 +261,6 @@ if (!cursor) {
                     }
+
                     if (n === 0) {
-                        // We have the first key, return it if that's what they wanted
+                        // We have the first key, return it if that's what they
+                        // wanted.
                         if (callback) {
@@ -228,3 +273,4 @@ callback(cursor.key);
                         if (!advanced) {
-                            // Otherwise, ask the cursor to skip ahead n records
+                            // Otherwise, ask the cursor to skip ahead n
+                            // records.
                             advanced = true;
@@ -243,3 +289,7 @@ cursor.advance(n);
 
-                req.onerror = function keyOnError() {
+                req.onerror = function() {
+                    if (callback) {
+                        callback(null, req.error.name);
+                    }
+
                     reject(req.error.name);
@@ -246,0 +296,0 @@ };

src/drivers/localstorage.js

@@ -9,5 +9,3 @@ // If IndexedDB isn't available, we'll fall back to localStorage.
     var keyPrefix = '';
-    var dbInfo = {
-        name: 'localforage'
-    };
+    var dbInfo = {};
     var Promise = this.Promise;
@@ -33,6 +31,4 @@ var localStorage = null;
         if (options) {
-            for (var i in dbInfo) {
-                if (options[i] !== undefined) {
-                    dbInfo[i] = options[i];
-                }
+            for (var i in options) {
+                dbInfo[i] = options[i];
             }
@@ -99,3 +95,3 @@ }
                     if (callback) {
-                        callback(result);
+                        callback(result, null);
                     }
@@ -105,2 +101,6 @@
                 } catch (e) {
+                    if (callback) {
+                        callback(null, e);
+                    }
+
                     reject(e);
@@ -291,5 +291,3 @@ }
 
-            var str = _bufferToString(buffer);
-
-            callback(null, marker + str);
+            callback(marker + _bufferToString(buffer));
         } else if (valueString === "[object Blob]") {
@@ -302,3 +300,3 @@ // Conver the blob to a binaryArray and then to a string.
 
-                callback(null, SERIALIZED_MARKER + TYPE_BLOB + str);
+                callback(SERIALIZED_MARKER + TYPE_BLOB + str);
             };
@@ -309,3 +307,3 @@
             try {
-                callback(null, JSON.stringify(value));
+                callback(JSON.stringify(value));
             } catch (e) {
@@ -315,3 +313,4 @@ if (window.console && window.console.error) {
                 }
-                callback(e);
+
+                callback(null, e);
             }
@@ -338,8 +337,25 @@ }
 
-                _serialize(value, function setSerialized(error, value) {
+                _serialize(value, function(value, error) {
                     if (error) {
+                        if (callback) {
+                            callback(null, error);
+                        }
+
                         reject(error);
                     } else {
-                        localStorage.setItem(keyPrefix + key, value);
+                        try {
+                            localStorage.setItem(keyPrefix + key, value);
+                        } catch (e) {
+                            // localStorage capacity exceeded.
+                            // TODO: Make this a specific error/event.
+                            if (e.name === 'QuotaExceededError' ||
+                                e.name === 'NS_ERROR_DOM_QUOTA_REACHED') {
+                                if (callback) {
+                                    callback(null, e);
+                                }
 
+                                reject(e);
+                            }
+                        }
+
                         if (callback) {
@@ -346,0 +362,0 @@ callback(originalValue);

src/drivers/websql.js

@@ -21,11 +21,3 @@ /*
     var db = null;
-    var dbInfo = {
-        description: '',
-        name: 'localforage',
-        // Default DB size is _JUST UNDER_ 5MB, as it's the highest size we can use
-        // without a prompt.
-        size: 4980736,
-        storeName: 'keyvaluepairs',
-        version: '1.0'
-    };
+    var dbInfo = {};
 
@@ -57,7 +49,7 @@ var SERIALIZED_MARKER = '__lfsc__:';
     function _initStorage(options) {
+        var _this = this;
+
         if (options) {
             for (var i in dbInfo) {
-                if (options[i] !== undefined) {
-                    dbInfo[i] = typeof(options[i]) !== 'string' ? options[i].toString() : options[i];
-                }
+                dbInfo[i] = typeof(options[i]) !== 'string' ? options[i].toString() : options[i];
             }
@@ -69,8 +61,13 @@ }
             // create it for us if it doesn't exist.
-            db = openDatabase(dbInfo.name, dbInfo.version, dbInfo.description,
-                              dbInfo.size);
+            try {
+                db = openDatabase(dbInfo.name, dbInfo.version,
+                                  dbInfo.description, dbInfo.size);
+            } catch (e) {
+                return _this.setDriver('localStorageWrapper').then(resolve);
+            }
 
             // Create our key/value table if it doesn't exist.
             db.transaction(function (t) {
-                t.executeSql('CREATE TABLE IF NOT EXISTS ' + dbInfo.storeName + ' (id INTEGER PRIMARY KEY, key unique, value)', [], function() {
+                t.executeSql('CREATE TABLE IF NOT EXISTS ' + dbInfo.storeName + 
+                             ' (id INTEGER PRIMARY KEY, key unique, value)', [], function() {
                     resolve();
@@ -84,6 +81,7 @@ }, null);
         var _this = this;
-        return new Promise(function(resolve) {
+        return new Promise(function(resolve, reject) {
             _this.ready().then(function() {
                 db.transaction(function (t) {
-                    t.executeSql('SELECT * FROM ' + dbInfo.storeName + ' WHERE key = ? LIMIT 1', [key], function (t, results) {
+                    t.executeSql('SELECT * FROM ' + dbInfo.storeName + 
+                                 ' WHERE key = ? LIMIT 1', [key], function (t, results) {
                         var result = results.rows.length ? results.rows.item(0).value : null;
@@ -102,3 +100,9 @@
                         resolve(result);
-                    }, null);
+                    }, function(t, error) {
+                        if (callback) {
+                            callback(null, error);
+                        }
+
+                        reject(error);
+                    });
                 });
@@ -123,3 +127,3 @@ });
 
-                _serialize(value, function setItemserializeValueCallback(error, value) {
+                _serialize(value, function(value, error) {
                     if (error) {
@@ -129,3 +133,4 @@ reject(error);
                         db.transaction(function (t) {
-                            t.executeSql('INSERT OR REPLACE INTO ' + dbInfo.storeName + ' (key, value) VALUES (?, ?)', [key, value], function() {
+                            t.executeSql('INSERT OR REPLACE INTO ' + dbInfo.storeName + 
+                                         ' (key, value) VALUES (?, ?)', [key, value], function() {
                                 if (callback) {
@@ -136,3 +141,25 @@ callback(originalValue);
                                 resolve(originalValue);
-                            }, null);
+                            }, function(t, error) {
+                                if (callback) {
+                                    callback(null, error);
+                                }
+
+                                reject(error);
+                            });
+                        }, function(sqlError) { // The transaction failed; check
+                                                // to see if it's a quota error.
+                            if (sqlError.code === sqlError.QUOTA_ERR) {
+                                // We reject the callback outright for now, but
+                                // it's worth trying to re-run the transaction.
+                                // Even if the user accepts the prompt to use
+                                // more storage on Safari, this error will
+                                // be called.
+                                //
+                                // TODO: Try to re-run the transaction.
+                                if (callback) {
+                                    callback(null, sqlError);
+                                }
+
+                                reject(sqlError);
+                            }
                         });
@@ -147,6 +174,7 @@ }
         var _this = this;
-        return new Promise(function(resolve) {
+        return new Promise(function(resolve, reject) {
             _this.ready().then(function() {
                 db.transaction(function (t) {
-                    t.executeSql('DELETE FROM ' + dbInfo.storeName + ' WHERE key = ?', [key], function() {
+                    t.executeSql('DELETE FROM ' + dbInfo.storeName + 
+                                 ' WHERE key = ?', [key], function() {
                         if (callback) {
@@ -157,3 +185,9 @@ callback();
                         resolve();
-                    }, null);
+                    }, function(t, error) {
+                        if (callback) {
+                            callback(error);
+                        }
+
+                        reject(error);
+                    });
                 });
@@ -168,3 +202,3 @@ });
         var _this = this;
-        return new Promise(function(resolve) {
+        return new Promise(function(resolve, reject) {
             _this.ready().then(function() {
@@ -178,3 +212,9 @@ db.transaction(function (t) {
                         resolve();
-                    }, null);
+                    }, function(t, error) {
+                        if (callback) {
+                            callback(error);
+                        }
+
+                        reject(error);
+                    });
                 });
@@ -189,7 +229,8 @@ });
         var _this = this;
-        return new Promise(function(resolve) {
+        return new Promise(function(resolve, reject) {
             _this.ready().then(function() {
                 db.transaction(function (t) {
                     // Ahhh, SQL makes this one soooooo easy.
-                    t.executeSql('SELECT COUNT(key) as c FROM ' + dbInfo.storeName, [], function (t, results) {
+                    t.executeSql('SELECT COUNT(key) as c FROM ' + 
+                                 dbInfo.storeName, [], function (t, results) {
                         var result = results.rows.item(0).c;
@@ -202,3 +243,9 @@
                         resolve(result);
-                    }, null);
+                    }, function(t, error) {
+                        if (callback) {
+                            callback(null, error);
+                        }
+
+                        reject(error);
+                    });
                 });
@@ -218,6 +265,7 @@ });
         var _this = this;
-        return new Promise(function(resolve) {
+        return new Promise(function(resolve, reject) {
             _this.ready().then(function() {
                 db.transaction(function (t) {
-                    t.executeSql('SELECT key FROM ' + dbInfo.storeName + ' WHERE id = ? LIMIT 1', [n + 1], function (t, results) {
+                    t.executeSql('SELECT key FROM ' + dbInfo.storeName +
+                                 ' WHERE id = ? LIMIT 1', [n + 1], function (t, results) {
                         var result = results.rows.length ? results.rows.item(0).key : null;
@@ -230,3 +278,9 @@
                         resolve(result);
-                    }, null);
+                    }, function(t, error) {
+                        if (callback) {
+                            callback(null, error);
+                        }
+
+                        reject(error);
+                    });
                 });
@@ -392,5 +446,3 @@ });
 
-            var str = _bufferToString(buffer);
-
-            callback(null, marker + str);
+            callback(marker + _bufferToString(buffer));
         } else if (valueString === "[object Blob]") {
@@ -403,3 +455,3 @@ // Conver the blob to a binaryArray and then to a string.
 
-                callback(null, SERIALIZED_MARKER + TYPE_BLOB + str);
+                callback(SERIALIZED_MARKER + TYPE_BLOB + str);
             };
@@ -410,3 +462,3 @@
             try {
-                callback(null, JSON.stringify(value));
+                callback(JSON.stringify(value));
             } catch (e) {
@@ -416,3 +468,4 @@ if (window.console && window.console.error) {
                 }
-                callback(e);
+
+                callback(null, e);
             }
@@ -419,0 +472,0 @@ }

src/localforage.js

@@ -40,4 +40,40 @@ (function() {
 
-        config: {},
+        _config: {
+            description: '',
+            name: 'localforage',
+            // Default DB size is _JUST UNDER_ 5MB, as it's the highest size
+            // we can use without a prompt.
+            size: 4980736,
+            storeName: 'keyvaluepairs',
+            version: 1.0
+        },
 
+        // Set any config values for localForage; can be called anytime before
+        // the first API call (e.g. `getItem`, `setItem`).
+        // We loop through options so we don't overwrite existing config
+        // values.
+        config: function(options) {
+            // If the options argument is an object, we use it to set values.
+            // Otherwise, we return either a specified config value or all
+            // config values.
+            if (typeof(options) === 'object') {
+                // If localforage is ready and fully initialized, we can't set
+                // any new configuration values. Instead, we return an error.
+                if (this._ready) {
+                    return new Error("Can't call config() after localforage " +
+                                     "has been used.");
+                }
+
+                for (var i in options) {
+                    this._config[i] = options[i];
+                }
+
+                return true;
+            } else if (typeof(options) === 'string') {
+                return this._config[options];
+            } else {
+                return this._config;
+            }
+        },
+
         driver: function() {
@@ -100,3 +136,3 @@ return this._driver || null;
             if (this._ready === null) {
-                this._ready = this._initStorage(this.config);
+                this._ready = this._initStorage(this._config);
             }
@@ -103,0 +139,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

544464

increased by22.29%

Number of package files

67

increased by8.06%

Lines of code

5933

increased by48.55%

Worsened metrics

Number of low quality alerts

3

increased by50%

Number of low supply chain risk alerts

5

increased by66.67%

No dependency changes