Deleted the 'api.initialize' after being invoked

README.md

@@ -117,44 +117,41 @@ require(['proxy-storage'], function(proxyStorage) {
 });
 ```
 
-See an example with RequireJS here: http://jsfiddle.net/FdKTn/67/
+See an example with RequireJS here: http://jsfiddle.net/FdKTn/71/
 
 # API
 
-The exposed interface manages an adapter that stores the data
-as **JSON**, allowing to save `Object` and `Array<Any>` values, which
-is not the default behavior when using the native `window.localStorage`,
-`window.sessionStorage` and `document.cookie` storages. It also provides
-a new storage mechanism called **`memoryStorage`** which persists the data
-in memory (current browser tab), even if a forced refresh is done
-(similar to `sessionStorage`).
+The exposed API manages an adapter that stores the data
+as **JSON**, allowing to save and retrieve **primitive**,
+`Object` and `Array<Any>` values, thanks to `JSON.stringify`.
+
+It also provides a new storage mechanism called **`memoryStorage`**
+which persists the data in memory (current tab in the browser), even
+if a forced refresh is done (similar to `sessionStorage`).
 
 The [`WebStorage`](#webstorage) class has a static member called
 [`interceptors`](#interceptors) which lets you to register callback
-functions on the prototype methods `setItem`, `getItem`, `removeItem`,
+functions upon the prototype methods `setItem`, `getItem`, `removeItem`,
 and `clear`, giving you the ability to intercept and modify the values
-to read/write/delete.
+to read, write, or delete.
 
-This library is exported as [UMD] _(Universal Module Definition)_ and the API
-contains the following members:
+This library is exported as [UMD] _(Universal Module Definition)_ and
+the API contains the following members:
 
 ## storage (or default)
 
 **_@type_ `Object`**
 
-This is the **default** module and is an instance of
-[`WebStorage`](#webstorage). It saves and retrieves the data internally as
-**JSON**, allowing not only storing **primitive** values but also **Object**
-values.
-
-It inherits the following members from the `WebStorage` prototype:
+This is the **default** member of the library and is an instance of
+[`WebStorage`](#webstorage). It inherits the following members from
+the prototype:
 
 - **`setItem`**`(key, value [,options])`: stores a `value` given a `key` name.
-  <br>The `options` parameter is used only when you set `"cookieStorage"`.
+  <br>The `options` parameter is used only with instances of `cookieStorage`.
   Read more details [here](#handling-cookies).
 - **`getItem`**`(key)`: retrieves a value by its `key` name.
 - **`removeItem`**`(key [,options])`: deletes an item from the storage.
-  <br>The `options` parameter is used only when you set `"cookieStorage"`.
+  <br>The `options` parameter is used only with instances of `cookieStorage`.
   Read more details [here](#handling-cookies).
 - **`clear`**`()`: removes all items from the storage instance.
 - **`length`**: gets the number of items stored in the storage instance.
@@ -230,21 +227,21 @@ Where **`storageType`** is a `string` that describes the type of storage
 to manage. It can be one of the following values: `"localStorage"`,
 `"sessionStorage"`, `"cookieStorage"`, or `"memoryStorage"`.
 
-Each instance handles an adapter with the following API:
+Each instance inherits the following members:
 
 - **`setItem`**`(key, value [,options])`: stores a `value` given a `key` name.
-  <br>The `options` parameter is used only when you set `"cookieStorage"`.
+  <br>The `options` parameter is used only with instances of `cookieStorage`.
   Read more details [here](#handling-cookies).
 - **`getItem`**`(key)`: retrieves a value by its `key` name.
 - **`removeItem`**`(key [,options])`: deletes an item from the storage.
-  <br>The `options` parameter is used only when you set `"cookieStorage"`.
+  <br>The `options` parameter is used only with instances of `cookieStorage`.
   Read more details [here](#handling-cookies).
 - **`clear`**`()`: removes all items from the storage instance.
 - **`length`**: gets the number of items stored in the storage instance.
 
-You can create multiple instances of `WebStorage` to handle different storage
-mechanisms. To store data in `cookies` and also in `sessionStorage`, you can
-do as follow:
+You can create multiple instances of `WebStorage` to handle different
+storage mechanisms. For example, to store data in `cookies` and also in
+`sessionStorage`, you can do as follow:
 
 ```javascript
 import storage, { WebStorage } from 'proxy-storage';
@@ -284,7 +281,7 @@ import { WebStorage, isAvailable } from 'proxy-storage';
 
 ### Handling cookies
 
-When you create an instance of `WebStorage` for `"cookieStorage"`, the
+When you create an instance of `WebStorage` with `cookieStorage`, the
 method `setItem()` receives an optional argument as the last parameter,
 that configures the way how the cookie is stored.
 
@@ -317,7 +314,7 @@ const cookieStore = new WebStorage('cookieStorage');
 
 let data = {
   start: new Date().toISOString(),
-  sessionId: 'J34H5609-SG7BND98W3',
+  sessionId: 'J34H5609-SG7ND98W3',
   platform: 'Linux x86_64',
 };
 
@@ -373,7 +370,7 @@ cookieStore.removeItem('optimizelyEndUserId', {
 
 You can loop over the items in the storage instance, e.g.
 `localStorage`, `sessionStorage`, `cookieStorage`, or `memoryStorage`,
-but it is not a good practice, see the notes below.
+but it is not a good practice, see the Important note below.
 
 ```javascript
 const sessionStore = new WebStorage('sessionStorage');
@@ -428,10 +425,10 @@ function clearAllStorages() {
 ### Interceptors
 
 The [`WebStorage`](#webstorage) class exposes the static member `interceptors`
-which lets you to register callback functions on the prototype methods
+which lets you to register callback functions upon the prototype methods
 `setItem`, `getItem`, `removeItem`, and `clear`.
-It is very useful when you need to take actions accessing the API methods,
-giving you the ability to intercept and modify the values to read/write/delete.
+It is very useful when you need to perform an action to intercept the value
+to read, write, or delete.
 
 - **`WebStorage.interceptors`**`(command, action)`: adds an interceptor to
   the API method.

dist/proxy-storage.js

@@ -502,7 +502,9 @@ var WebStorage = function () {
   return WebStorage;
 }();
 
-// @public API
+/**
+ * @public API
+ */
 
 
 exports.default = WebStorage;
@@ -526,7 +528,7 @@ var _utils = __webpack_require__(0);
 /**
  * @private
  *
- * Proxy for the default cookie storage associated with the current document.
+ * Proxy for document.cookie
  *
  * @see
  * https://developer.mozilla.org/en-US/docs/Web/API/Document/cookie
@@ -545,14 +547,13 @@ var $cookie = {
 /**
  * @private
  *
- * Builds the expiration part for the cookie.
+ * Builds the expiration for the cookie.
  *
  * @see utils.alterDate(options)
  *
  * @param  {Date|object} date: the expiration date
  * @return {string}
  */
-/* eslint-disable no-invalid-this */
 function buildExpirationString(date) {
   var expires = date instanceof Date ? (0, _utils.alterDate)({ date: date }) : (0, _utils.alterDate)(date);
   return expires.toUTCString();
@@ -589,7 +590,7 @@ function findCookie(cookie) {
 /**
  * @public
  *
- * Create, read, and delete elements from document cookies
+ * Create, read, and delete elements from document.cookie,
  * and implements the Web Storage interface.
  *
  * @return {object}
@@ -643,18 +644,17 @@ function cookieStorage() {
         }
       });
     },
-
-
-    // this method will be removed after being invoked
-    // because is not part of the Web Storage interface
     initialize: function initialize() {
+      // copies all existing elements in the storage
       $cookie.get().split(';').forEach(function (cookie) {
         var index = cookie.indexOf('=');
         var key = cookie.substring(0, index).trim();
         var value = cookie.substring(index + 1).trim();
-        // copies all existing elements in the storage
         if (key) api[key] = decodeURIComponent(value);
       });
+      // this method is removed after being invoked
+      // because is not part of the Web Storage interface
+      delete api.initialize;
     }
   };
   return api;
@@ -707,9 +707,9 @@ function setStoreToWindow(hashtable) {
 /**
  * @public
  *
- * Create, read, and delete elements from memory store and
- * implements the Web Storage interface. It also adds a hack
- * to persist the store in session for the current browser-tab.
+ * Create, read, and delete elements from memory, and implements
+ * the Web Storage interface. It also adds a hack to persist
+ * the storage in the session for the current tab (browser).
  *
  * @return {object}
  */
@@ -734,12 +734,12 @@ function memoryStorage() {
       });
       setStoreToWindow(hashtable);
     },
-
-    // this method will be removed after being invoked
-    // because is not part of the Web Storage interface
     initialize: function initialize() {
       // copies all existing elements in the storage
       Object.assign(api, hashtable);
+      // this method is removed after being invoked
+      // because is not part of the Web Storage interface
+      delete api.initialize;
     }
   };
   return api;
@@ -772,31 +772,28 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * @private
  *
- * Adds the current elements in the storage object.
+ * Copy the current items in the storage mechanism.
  *
  * @param  {object} api: the storage mechanism to initialize
  * @return {object}
  */
 function initApi(api) {
   if (!api.initialize) return api;
-  // sets read-only and non-enumerable properties
+  // sets API members to read-only and non-enumerable
   for (var prop in api) {
     // eslint-disable-line
     if (prop !== 'initialize') {
       (0, _utils.setProperty)(api, prop);
     }
   }
   api.initialize();
-  // this method is removed after being invoked
-  // because is not part of the Web Storage interface
-  delete api.initialize;
   return api;
 }
 
 /**
  * @public
  *
- * Proxy for storage mechanisms.
+ * Proxy for the storage mechanisms.
  * All members implement the Web Storage interface.
  *
  * @see
@@ -937,7 +934,9 @@ function init() {
 
 init();
 
-// @public API
+/**
+ * @public API
+ */
 exports.default = storage;
 exports.WebStorage = _webStorage2.default;
 exports.configStorage = configStorage;

src/cookie-storage.js

@@ -1,10 +1,9 @@
-/* eslint-disable no-invalid-this */
 import {alterDate, isObject} from './utils';
 
 /**
  * @private
  *
- * Proxy for the default cookie storage associated with the current document.
+ * Proxy for document.cookie
  *
  * @see
  * https://developer.mozilla.org/en-US/docs/Web/API/Document/cookie
@@ -22,7 +21,7 @@ const $cookie = {
 /**
  * @private
  *
- * Builds the expiration part for the cookie.
+ * Builds the expiration for the cookie.
  *
  * @see utils.alterDate(options)
  *
@@ -68,13 +67,14 @@ function findCookie(cookie) {
 /**
  * @public
  *
- * Create, read, and delete elements from document cookies
+ * Create, read, and delete elements from document.cookie,
  * and implements the Web Storage interface.
  *
  * @return {object}
  */
 export default function cookieStorage() {
   const api = {
+
     setItem(key, value, options) {
       options = Object.assign({path: '/'}, options);
       // keep track of the metadata associated to the cookie
@@ -125,16 +125,17 @@ export default function cookieStorage() {
       });
     },
 
-    // this method will be removed after being invoked
-    // because is not part of the Web Storage interface
     initialize() {
+      // copies all existing elements in the storage
       $cookie.get().split(';').forEach((cookie) => {
         const index = cookie.indexOf('=');
         const key = cookie.substring(0, index).trim();
         const value = cookie.substring(index + 1).trim();
-        // copies all existing elements in the storage
         if (key) api[key] = decodeURIComponent(value);
       });
+      // this method is removed after being invoked
+      // because is not part of the Web Storage interface
+      delete api.initialize;
     },
   };
   return api;

src/memory-storage.js

@@ -30,36 +30,42 @@ function setStoreToWindow(hashtable) {
 /**
  * @public
  *
- * Create, read, and delete elements from memory store and
- * implements the Web Storage interface. It also adds a hack
- * to persist the store in session for the current browser-tab.
+ * Create, read, and delete elements from memory, and implements
+ * the Web Storage interface. It also adds a hack to persist
+ * the storage in the session for the current tab (browser).
  *
  * @return {object}
  */
 export default function memoryStorage() {
   const hashtable = getStoreFromWindow();
   const api = {
+
     setItem(key, value) {
       hashtable[key] = value;
       setStoreToWindow(hashtable);
     },
+
     getItem(key) {
       const value = hashtable[key];
       return value === undefined ? null : value;
     },
+
     removeItem(key) {
       delete hashtable[key];
       setStoreToWindow(hashtable);
     },
+
     clear() {
       Object.keys(hashtable).forEach(key => delete hashtable[key]);
       setStoreToWindow(hashtable);
     },
-    // this method will be removed after being invoked
-    // because is not part of the Web Storage interface
+
     initialize() {
       // copies all existing elements in the storage
       Object.assign(api, hashtable);
+      // this method is removed after being invoked
+      // because is not part of the Web Storage interface
+      delete api.initialize;
     },
   };
   return api;