Use localforage instead of localStorage

browser-version/browser-specific/lib/storage.js

@@ -1,80 +1,72 @@
 /**
  * Way data is stored for this database
  * For a Node.js/Node Webkit database it's the file system
- * For a browser-side database it's localStorage when supported
+ * For a browser-side database it's localforage, which uses the best backend available (IndexedDB then WebSQL then localStorage)
  *
  * This version is the browser version
  */
 
+var localforage = require('localforage')
 
+// Configure localforage to display NeDB name for now. Would be a good idea to let user use his own app name
+localforage.config({
+  name: 'NeDB'
+, storeName: 'nedbdata'
+});
 
-function exists (filename, callback) {
-  // In this specific case this always answers that the file doesn't exist
-  if (typeof localStorage === 'undefined') { console.log("WARNING - This browser doesn't support localStorage, no data will be saved in NeDB!"); return callback(); }
 
-  if (localStorage.getItem(filename) !== null) {
+function exists (filename, callback) {
+  localforage.getItem(filename, function (err, value) {
+    if (value !== null) {   // Even if value is undefined, localforage returns null
       return callback(true);
     } else {
       return callback(false);
     }
+  });
 }
 
 
 function rename (filename, newFilename, callback) {
-  if (typeof localStorage === 'undefined') { console.log("WARNING - This browser doesn't support localStorage, no data will be saved in NeDB!"); return callback(); }
+  localforage.getItem(filename, function (err, value) {
-
+    if (value === null) {
-  if (localStorage.getItem(filename) === null) {
+      localforage.removeItem(newFilename, function () { return callback(); });
-    localStorage.removeItem(newFilename);
     } else {
-    localStorage.setItem(newFilename, localStorage.getItem(filename));
+      localforage.setItem(newFilename, value, function () {
-    localStorage.removeItem(filename);
+        localforage.removeItem(filename, function () { return callback(); });
+      });
     }
-
+  });
-  return callback();
 }
 
 
 function writeFile (filename, contents, options, callback) {
-  if (typeof localStorage === 'undefined') { console.log("WARNING - This browser doesn't support localStorage, no data will be saved in NeDB!"); return callback(); }
-
   // Options do not matter in browser setup
   if (typeof options === 'function') { callback = options; }
-
+  localforage.setItem(filename, contents, function () { return callback(); });
-  localStorage.setItem(filename, contents);
-  return callback();
 }
 
 
 function appendFile (filename, toAppend, options, callback) {
-  if (typeof localStorage === 'undefined') { console.log("WARNING - This browser doesn't support localStorage, no data will be saved in NeDB!"); return callback(); }
-
   // Options do not matter in browser setup
   if (typeof options === 'function') { callback = options; }
 
-  var contents = localStorage.getItem(filename) || '';
+  localforage.getItem(filename, function (err, contents) {
+    contents = contents || '';
     contents += toAppend;
-
+    localforage.setItem(filename, contents, function () { return callback(); });
-  localStorage.setItem(filename, contents);
+  });
-  return callback();
 }
 
 
 function readFile (filename, options, callback) {
-  if (typeof localStorage === 'undefined') { console.log("WARNING - This browser doesn't support localStorage, no data will be saved in NeDB!"); return callback(); }
-
   // Options do not matter in browser setup
   if (typeof options === 'function') { callback = options; }
-
+  localforage.getItem(filename, function (err, contents) { return callback(null, contents || ''); });
-  var contents = localStorage.getItem(filename) || '';
-  return callback(null, contents);
 }
 
 
 function unlink (filename, callback) {
-  if (typeof localStorage === 'undefined') { console.log("WARNING - This browser doesn't support localStorage, no data will be saved in NeDB!"); return callback(); }
+  localforage.removeItem(filename, function () { return callback(); });
-
-  localStorage.removeItem(filename);
-  return callback();
 }
 
 

browser-version/test/playground.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>Playground for NeDB</title>
+</head>
+<body>
+  <script src="../out/nedb.min.js"></script>
+</body>
+</html>
+

lib/storage.js

@@ -1,7 +1,7 @@
 /**
  * Way data is stored for this database
  * For a Node.js/Node Webkit database it's the file system
- * For a browser-side database it's localStorage when supported
+ * For a browser-side database it's localforage which chooses the best option depending on user browser (IndexedDB then WebSQL then localStorage)
  *
  * This version is the Node.js/Node Webkit version
  * It's essentially fs, mkdirp and crash safe write and read functions