Merge branch 'master' of https://github.com/yusufshakeel/dyCacheJS

Author: yusufshakeel

README.md

@@ -5,10 +5,11 @@ Cache data using JavaScript in the browser.
 ### Status
 
 [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/yusufshakeel/dyCacheJS)
-[![npm version](https://img.shields.io/badge/npm-1.4.0-blue.svg)](https://www.npmjs.com/package/dycachejs)
+[![npm version](https://img.shields.io/badge/npm-1.5.0-blue.svg)](https://www.npmjs.com/package/dycachejs)
 [![Build Status](https://travis-ci.org/yusufshakeel/dyCacheJS.svg?branch=master)](https://travis-ci.org/yusufshakeel/dyCacheJS)
 [![](https://data.jsdelivr.com/v1/package/npm/dycachejs/badge)](https://www.jsdelivr.com/package/npm/dycachejs)
 
+
 ### Getting Started
 * Download the [latest release](https://github.com/yusufshakeel/dyCacheJS/releases) of the project.
 * Clone the repo: `git clone https://github.com/yusufshakeel/dyCacheJS.git`
@@ -19,10 +20,21 @@ Cache data using JavaScript in the browser.
 ### Documentation
 Check the `index.html` file of this project.
 
+
 ### License
 It's free and released under [MIT License](https://github.com/yusufshakeel/dyCacheJS/blob/master/LICENSE) Copyright (c) 2018 Yusuf Shakeel
 
+
 ### Donate
 Feeling generous :-) Buy me a cup of tea.
 
-[Donate via PayPal](https://www.paypal.me/yusufshakeel)
+[Donate via PayPal](https://www.paypal.me/yusufshakeel)
+
+
+### How to setup?
+
+Run `npm install` to install all the packages.
+
+Then run `npm run all` to build and run the tests.
+
+You will get the minified file inside `dist/js` directory.

dist/js/dyCache.min.js

@@ -301,6 +301,31 @@ <h4><code>purge()</code></h4>
             <a name="array-methods"></a>
             <h4 class="text-center"><a href="#array-methods">Array Methods</a></h4>
 
+            <!-- arrInit() -->
+            <a name="arrInit"></a>
+            <h4><code>arrInit(key)</code></h4>
+
+            <p>This will create a new array referred by <code>key</code> in the cache.</p>
+
+            <p>If array referred by <code>key</code> exists in the cache then it is overwritten.</p>
+
+            <pre><code>obj.arrInit('users');    // create a new array by the name users</code></pre>
+
+            <div>
+                <a class="btn btn-primary"
+                   role="button"
+                   data-toggle="collapse"
+                   href="#collapse-arrInit"
+                   aria-expanded="false"
+                   aria-controls="collapse-arrInit">Output</a>
+            </div>
+            <div class="collapse" id="collapse-arrInit">
+            </div>
+
+            <!-- arrInit() ends here -->
+
+            <hr>
+
             <!-- arrPush() -->
             <a name="arrPush"></a>
             <h4><code>arrPush(key, value)</code></h4>
@@ -683,6 +708,31 @@ <h4><code>arrDeleteElems(key, start, [deleteCount])</code></h4>
             <a name="object-methods"></a>
             <h4 class="text-center"><a href="#object-methods">Object Methods</a></h4>
 
+            <!-- oInit() -->
+            <a name="oInit"></a>
+            <h4><code>oInit(key)</code></h4>
+
+            <p>This will create a new object in the cache by the name <code>key</code>.</p>
+
+            <p>If object referred by <code>key</code> exists in the cache then it will be overwritten.</p>
+
+            <pre><code>obj.oInit('players');    // creates a new object players</code></pre>
+
+            <div>
+                <a class="btn btn-primary"
+                   role="button"
+                   data-toggle="collapse"
+                   href="#collapse-oInit"
+                   aria-expanded="false"
+                   aria-controls="collapse-oInit">Output</a>
+            </div>
+            <div class="collapse" id="collapse-oInit">
+            </div>
+
+            <!-- oInit() ends here -->
+
+            <hr>
+
             <!-- oSet() -->
             <a name="oSet"></a>
             <h4><code>oSet(key, oKey, oValue)</code></h4>

index.html

@@ -78,6 +78,13 @@ var dyCache = /** @class */ (function () {
     dyCache.prototype.get = function (key) {
         return this._cache[key];
     };
+    /**
+     * This will initialise a new array in the cache and will refer it by key.
+     * @param {string} key
+     */
+    dyCache.prototype.arrInit = function (key) {
+        this._cache[key] = [];
+    };
     /**
      * This will push new value in an array at the right side.
      *
@@ -339,6 +346,13 @@ var dyCache = /** @class */ (function () {
             return this._cache[key].splice(start, deleteCount);
         }
     };
+    /**
+     * This will initialise a new object in the cache and will refer it by key.
+     * @param {string} key
+     */
+    dyCache.prototype.oInit = function (key) {
+        this._cache[key] = {};
+    };
     /**
      * This will create an object by the reference key in the cache.
      * Then it will add a property oKey and assign the value oValue.