Lint files; Do not throw error on init; Use list folder for bundles

Author: georapbox

.eslintignore

@@ -0,0 +1,3 @@
+node_modules/*
+src/util/**
+dist/**

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.1.0
+- Rewrite using ES2015 syntax.
+- Do not throw error on initialization if `localStorage` or `sessionStorage` is not supported or unavailable. User can still use the `supported` method to test for.
+
 # 1.0.0
 ### Features
 - Add `quota()` public API method.

README.md

@@ -1,10 +1,23 @@
 [![Build Status](https://travis-ci.org/georapbox/webStorage.svg?branch=master)](https://travis-ci.org/georapbox/webStorage) [![Dependencies](https://david-dm.org/georapbox/webStorage.svg?theme=shields.io)](https://david-dm.org/georapbox/webStorage) [![devDependency Status](https://david-dm.org/georapbox/webStorage/dev-status.svg)](https://david-dm.org/georapbox/webStorage#info=devDependencies)
 
-*Distributable files can be found under [releases](https://github.com/georapbox/webStorage/releases).*
-
 # webStorage
 
-webStorage is a minimal Javascript library that improves the way you work with ```localStorage``` or ```sessionStorage```.
+webStorage is a minimal Javascript library that improves the way you work with `localStorage` or `sessionStorage`.
+
+
+## Install
+
+### npm
+
+```bash
+$ npm install webStorage
+```
+
+### Browser
+
+```html
+<script src="node_modules/webStorage/dist/webStorage.min.js"></script>
+```
 
 
 ## Data API
@@ -17,7 +30,7 @@ The API methods below deal with getting and setting data in an offline store.
 getItem(key)
 ```
 
-Gets an item from an offline store. If the key does not exist, ```getItem()``` will return null.
+Gets an item from an offline store. If the key does not exist, `getItem()` will return null.
 
 ### setItem
 
@@ -48,9 +61,9 @@ clear([clearAll])
 
 > Use this method with caution.
 
-If ```clearAll``` is set to ```true```, removes every key from the storage, returning it to a blank slate.
+If `clearAll` is set to `true`, removes every key from the storage, returning it to a blank slate.
 
-If ```clearAll``` is set to ```false``` or any other falsy value it will remove only the keys that belong to the specific databse.
+If `clearAll` is set to `false` or any other falsy value it will remove only the keys that belong to the specific databse.
 
 ### keys
 
@@ -76,13 +89,13 @@ iterate(iteratorCallback)
 
 Iterate over all value/key pairs in datastore.
 
-<code>iteratorCallback</code> is called once for each pair, with the following arguments:
+`iteratorCallback` is called once for each pair, with the following arguments:
 
 - key
 - value
 - iterationNumber (one-based number)
 
-You can early exit from iterator by returning ```false``` inside ```iteratorCallback```.
+You can early exit from iterator by returning `false` inside `iteratorCallback`.
 
 ### quota
 
@@ -98,7 +111,7 @@ Approximately display the size for each key in datastore and the total size of a
 supported()
 ```
 
-Checks if the driver of choice (<code>localStorage</code> or <code>sessionStorage</code>) is supported by the browser.
+Checks if the driver of choice (`localStorage` or `sessionStorage`) is supported by the browser. It will return `false` if storage is full.
 
 
 ## Settings API
@@ -123,101 +136,88 @@ Set and persist webStorage options. This must be called before any other calls t
 createInstance([options])
 ```
 
-Creates a new instance of the webStorage. The ```options``` can be the same as ```config(options)```.
+Creates a new instance of the webStorage. The `options` can be the same as `config(options)`.
 
 
 ## Usage Example
 
 ```js
-var users = [
-    {id: 1, name: 'John Doe', email: '[email protected]'},
-    {id: 2, name: 'George Cooper', email: '[email protected]'},
-    {id: 2, name: 'Tim Smith', email: '[email protected]'}
+const users = [
+  {id: 1, name: 'John Doe', email: '[email protected]'},
+  {id: 2, name: 'George Cooper', email: '[email protected]'},
+  {id: 2, name: 'Tim Smith', email: '[email protected]'}
 ];
 
-var companies = ['Google', 'Yahoo', 'Microsoft', 'Mozilla'];
+const companies = ['Google', 'Yahoo', 'Microsoft', 'Mozilla'];
 
 /* Saving some items with the default configuration */
 webStorage.setItem('user', users[0]);
 webStorage.setItem('company', companies[0]);
 
 /* Create a new instance and save some items */
-var ls = webStorage.createInstance({
-    name: 'MyApp'
+const ls = webStorage.createInstance({
+  name: 'MyApp'
 });
 
 ls.setItem('user', users[1]);
 ls.setItem('company', companies[2]);
 ls.setItem('dummyKey', 100);
 
 /* Retrieving saved items */
-webStorage.getItem('user'); // => Object { id: 1, name: "John Doe", email: "[email protected]" }
-webStorage.getItem('company'); // => "Google"
+webStorage.getItem('user'); // -> Object { id: 1, name: "John Doe", email: "[email protected]" }
+webStorage.getItem('company'); // -> "Google"
 
-ls.getItem('user'); // => Object { id: 2, name: "George Cooper", email: "[email protected]" }
-ls.getItem('company'); // => "Microsoft"
+ls.getItem('user'); // -> Object { id: 2, name: "George Cooper", email: "[email protected]" }
+ls.getItem('company'); // -> "Microsoft"
 
 /* Get length of datastores */
-webStorage.length(); // => 2
-ls.length(); // => 3
+webStorage.length(); // -> 2
+ls.length(); // -> 3
 
 /* Get datastores' keys */
-webStorage.keys(); // => Array [ "company", "user" ]
-ls.keys(); // => Array [ "dummyKey", "company", "user" ]
+webStorage.keys(); // -> Array [ "company", "user" ]
+ls.keys(); // -> Array [ "dummyKey", "company", "user" ]
 
 /* Itereate over datastores */
 ls.iterate(function (key, value, iterNum) {
-    console.log(iterNum, ':', key, ':', value);
+  console.log(iterNum, ':', key, ':', value);
 });
-// => 1 : dummyKey : 100
-// => 2 : company : Microsoft
-// => 3 : user : Object { id: 2, name: "George Cooper", email: "[email protected]" }
+// -> 1 : dummyKey : 100
+// -> 2 : company : Microsoft
+// -> 3 : user : Object { id: 2, name: "George Cooper", email: "[email protected]" }
 
 /* Quota */
 ls.quota();
-// => Object { "total": 0.0001430511474609375, "items": { "MyApp/dummyKey": 0.0000057220458984375, "MyApp/company": 0.0000209808349609375, "MyApp/user": 0.0001163482666015625 } }"
+// -> Object { "total": 0.0001430511474609375, "items": { "MyApp/dummyKey": 0.0000057220458984375, "MyApp/company": 0.0000209808349609375, "MyApp/user": 0.0001163482666015625 } }"
 
 /* Removing items */
 webStorage.removeItem('user');
-webStorage.length(); // => 1
-webStorage.keys(); // => Array [ "company" ]
-ls.length(); // => 3 (still same as before)
+webStorage.length(); // -> 1
+webStorage.keys(); // -> Array [ "company" ]
+ls.length(); // -> 3 (still same as before)
 ls.clear(); /* Clear only the "MyApp" datastore */
-ls.length(); // => 0
-ls.keys(); // => Array []
-webStorage.length(); // => 1
+ls.length(); // -> 0
+ls.keys(); // -> Array []
+webStorage.length(); // -> 1
 ls.clear(true); /* Flush away everything in localStorage */
-webStorage.length(); // => 0
+webStorage.length(); // -> 0
 ```
 
 
-## Install
-
-### npm
+## Build for development
 
-```sh
-$ npm install webStorage
+```bash
+$ npm run dev
 ```
 
-### git
-
-```sh
-$ git clone https://github.com/georapbox/webStorage.git
-```
+## Build for production
 
-## Build the project for development
-
-### 1. Install dependancies
-
-```sh
-$ cd webStorage
-$ npm install
+```bash
+$ npm run build
 ```
 
-### 2. Build
+## Test
 
-```sh
-$ npm run build
+```bash
+$ npm test
 ```
-
-The command above will create a ```dist/``` folder that contains the library to be used in production. It will also lint the code and run the tests.

TODO

@@ -1,2 +1 @@
-1. Better way to select between localStorage and sessionStorage in configuration.
-2. Write more tests.
+

lib/webStorage.js renamed to dist/webStorage.js

@@ -14,7 +14,7 @@ module.exports = function (config) {
 
     // list of files / patterns to load in the browser
     files: [
-      'lib/webStorage.js',
+      'dist/webStorage.js',
       'test/**/*.js'
     ],
 

dist/webStorage.js.map

@@ -1,25 +1,22 @@
 {
   "name": "webStorage",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A minimal Javascript wrapper to work with localStorage and sessionStorage",
-  "main": "lib/webStorage.js",
+  "main": "dist/webStorage.js",
   "scripts": {
     "build": "webpack --mode=build",
     "dev": "webpack --progress --colors --watch --mode=dev",
     "test": "karma start",
-    "ci": "npm run build; npm test"
+    "lint": "eslint src/**",
+    "ci": "npm run lint; npm test; npm run build;"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/georapbox/webStorage.git"
   },
   "keywords": [
-    "localStorage",
-    "sessionStorage",
-    "Storage",
-    "Offline Storage",
-    "Web Storage",
-    "DOM Storage"
+    "localStorage", "sessionStorage", "Storage",
+    "Offline Storage", "Web Storage", "DOM Storage"
   ],
   "author": "George Raptis <[email protected]> (georapbox.github.io)",
   "license": "MIT",

dist/webStorage.min.js

@@ -25,10 +25,6 @@ class WebStorage {
   constructor(options) {
     options = extend({}, defaultConfig, options);
 
-    if (!isStorageSupported(options.driver)) {
-      throw new Error('Web Storage is not supported by your browser.');
-    }
-
     if (options.name == null || trim(options.name) === '') {
       throw 'You must use a valid name for the database.';
     }
@@ -183,7 +179,10 @@ class WebStorage {
     const storeKeyPrefix = this.storeKeyPrefix;
 
     iterateStorage(this, function (key, value, iterationNumber) {
-      if (callback && callback(removePrefix(key, storeKeyPrefix), JSON.parse(value), iterationNumber) === false) {
+      const _key = removePrefix(key, storeKeyPrefix);
+      const _value = JSON.parse(value);
+
+      if (callback && callback(_key, _value, iterationNumber) === false) {
         return false;
       }
     });
@@ -212,10 +211,11 @@ class WebStorage {
   }
 
   /**
-   * Checks if the driver of choice (localStorage || sessionStorage) is supported.
+   * Checks if the driver of choice (localStorage or sessionStorage) is supported.
+   * It will return `false` if storage is full.
    *
    * @this {WebStorage}
-   * @return {Boolean} Returns true if Web Storage is supported else returns false.
+   * @return {Boolean} Returns true if Web Storage is supported; otherwise false.
    */
   supported() {
     return isStorageSupported(this.options.driver);

dist/webStorage.min.js.map

@@ -31,7 +31,7 @@ const config = {
   entry: `${__dirname}/src/index.js`,
   devtool: 'source-map',
   output: {
-    path: `${__dirname}/lib`,
+    path: `${__dirname}/dist`,
     filename: outputFile,
     library: libraryName,
     libraryTarget: 'umd',