docs/index.html

<!DOCTYPE html>

<html>
<head>
  <title>Kache</title>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
  <link rel="stylesheet" media="all" href="docco.css" />
</head>
<body>
  <div id="container">
    <div id="background"></div>
    
    <ul class="sections">
        
        
        
        <li id="section-1">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-1">&#182;</a>
              </div>
              <h1 id="kache">Kache</h1>

            </div>
            
        </li>
        
        
        <li id="section-2">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-2">&#182;</a>
              </div>
              <p><em>A very simple memory cache for node.js</em></p>
<p><strong>Version:</strong> 0.1.0</p>
<p><strong>Author:</strong> <a href="http://lemoncreative.net">James Wyse</a></p>
<p><strong>GitHub:</strong> <a href="https://github.com/lemoncreative/kache/">jameswyse/kache</a></p>
<p><strong>NPM:</strong> <a href="https://npmjs.org/package/kache">kache</a></p>

            </div>
            
        </li>
        
        
        <li id="section-3">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-3">&#182;</a>
              </div>
              <h2 id="module-dependencies">Module Dependencies</h2>

            </div>
            
            <div class="content"><div class='highlight'><pre><span class="hljs-keyword">var</span> EventEmitter = <span class="hljs-built_in">require</span>(<span class="hljs-string">'events'</span>).EventEmitter;
<span class="hljs-keyword">var</span> inherits     = <span class="hljs-built_in">require</span>(<span class="hljs-string">'inherits'</span>);
<span class="hljs-keyword">var</span> debug        = <span class="hljs-built_in">require</span>(<span class="hljs-string">'debug'</span>)(<span class="hljs-string">'cache'</span>);
<span class="hljs-keyword">var</span> _            = <span class="hljs-built_in">require</span>(<span class="hljs-string">'underscore'</span>);</pre></div></div>
            
        </li>
        
        
        <li id="section-4">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-4">&#182;</a>
              </div>
              <h2 id="kache-constructor">Kache Constructor</h2>
<p><em>Creates a new Kache Object.</em></p>
<p><strong>Arguments:</strong></p>
<ul>
<li><strong>options:</strong> <code>Object</code> Set runtime options</li>
</ul>
<p><strong>Returns:</strong> <code>Object</code> A new Kache Object</p>

            </div>
            
            <div class="content"><div class='highlight'><pre><span class="hljs-keyword">var</span> Kache = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(options)</span> {</span>
  Kache.super.apply(<span class="hljs-keyword">this</span>);

  options       = options || {};
  options.start = options.start || <span class="hljs-literal">true</span>;

  <span class="hljs-keyword">this</span>.lru      = options.lru || <span class="hljs-literal">false</span>;
  <span class="hljs-keyword">this</span>.max      = _.isNumber(options.max) ? options.max : <span class="hljs-literal">Infinity</span>;
  <span class="hljs-keyword">this</span>.interval = _.isNumber(options.interval) ? (options.interval * <span class="hljs-number">1000</span>) : <span class="hljs-number">300000</span>;

  <span class="hljs-keyword">this</span>.cache   = {};
  <span class="hljs-keyword">this</span>.length  = <span class="hljs-number">0</span>;
  <span class="hljs-keyword">this</span>.hits    = <span class="hljs-number">0</span>;
  <span class="hljs-keyword">this</span>.misses  = <span class="hljs-number">0</span>;

  <span class="hljs-keyword">if</span>(options.start) <span class="hljs-keyword">this</span>.start();
};</pre></div></div>
            
        </li>
        
        
        <li id="section-5">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-5">&#182;</a>
              </div>
              <p>Inherits from EventEmitter</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>inherits(Kache, EventEmitter);</pre></div></div>
            
        </li>
        
        
        <li id="section-6">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-6">&#182;</a>
              </div>
              <h2 id="item-constructor">Item Constructor</h2>
<p><em>Creates a new Item Object</em></p>
<p><strong>Arguments:</strong></p>
<ul>
<li><strong>value:</strong> <code>Mixed</code> Contents of cached item.</li>
<li><strong>ttl:</strong> <code>Number</code> in seconds to store this Item in the cache.</li>
</ul>
<p><strong>Returns:</strong> <code>Object</code> a new Item Object</p>

            </div>
            
            <div class="content"><div class='highlight'><pre><span class="hljs-keyword">var</span> Item = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, ttl)</span> {</span>
  <span class="hljs-keyword">var</span> now        = <span class="hljs-built_in">Date</span>.now();
  <span class="hljs-keyword">this</span>.createdAt = now;
  <span class="hljs-keyword">this</span>.lastGet   = now;
  <span class="hljs-keyword">this</span>.value     = value;
  <span class="hljs-keyword">this</span>.ttl       = _.isNumber(ttl) ? (ttl * <span class="hljs-number">1000</span>) : <span class="hljs-literal">Infinity</span>;
};</pre></div></div>
            
        </li>
        
        
        <li id="section-7">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-7">&#182;</a>
              </div>
              <h2 id="kache-set">Kache#set</h2>
<p><em>Sets (adds or replaces) an Item in the cache</em></p>
<p><strong>Arguments:</strong></p>
<ul>
<li><strong>key:</strong> <code>String</code></li>
<li><strong>value:</strong> <code>Mixed</code></li>
<li><strong>ttl:</strong> <code>Number</code> in seconds to store this Item in the cache.</li>
</ul>
<p><strong>Returns:</strong> <code>Mixed</code> The value</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.set = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">set</span><span class="hljs-params">(key, value, ttl)</span> {</span>
    debug(<span class="hljs-string">'Set: %s = %j (TTL: %s)'</span>, key, value, (_.isNumber(ttl) ? ttl : <span class="hljs-string">'None'</span>));
    <span class="hljs-keyword">if</span>(!<span class="hljs-keyword">this</span>.has(key))
      <span class="hljs-keyword">this</span>.length++;
    <span class="hljs-keyword">this</span>.cache[key] = <span class="hljs-keyword">new</span> Item(value, ttl);</pre></div></div>
            
        </li>
        
        
        <li id="section-8">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-8">&#182;</a>
              </div>
              <p>Return the value for situations like:</p>
<pre><code class="lang-javascript"><span class="hljs-keyword">var</span> name = cache.get(<span class="hljs-string">'name'</span>) || cache.set(<span class="hljs-string">'name'</span>, <span class="hljs-string">'James'</span>, <span class="hljs-number">3600</span>);
</code></pre>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">return</span> value;
};</pre></div></div>
            
        </li>
        
        
        <li id="section-9">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-9">&#182;</a>
              </div>
              <h2 id="kache-get">Kache#get</h2>
<p><em>Retrieves a value from the cache</em></p>
<p><strong>Arguments:</strong></p>
<ul>
<li><strong>key:</strong> <code>String</code></li>
<li><strong>def:</strong> <code>Mixed</code> The default value to return when the cache is missing.</li>
<li><strong>callback:</strong> <code>Function</code> Callback function <code>callback(err, value)</code></li>
</ul>
<p><strong>Returns:</strong> <code>Mixed</code> The retrieved value or default value if the Item is missing.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.get = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">get</span><span class="hljs-params">(key, def, callback)</span> {</span>
  <span class="hljs-keyword">if</span>(<span class="hljs-keyword">this</span>.valid(key)) {
    <span class="hljs-keyword">this</span>.hits++;

    <span class="hljs-keyword">if</span>(<span class="hljs-keyword">this</span>.lru) <span class="hljs-keyword">this</span>.cache[key].lastGet = <span class="hljs-built_in">Date</span>.now();

    <span class="hljs-keyword">if</span>(_.isFunction(callback)) callback(<span class="hljs-literal">null</span>, <span class="hljs-keyword">this</span>.cache[key].value);
    <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.cache[key].value;
  }

  <span class="hljs-keyword">this</span>.misses++;
  <span class="hljs-keyword">if</span>(_.isFunction(callback)) callback(<span class="hljs-literal">null</span>, def || <span class="hljs-literal">null</span>);
  <span class="hljs-keyword">return</span> def || <span class="hljs-literal">null</span>;
};</pre></div></div>
            
        </li>
        
        
        <li id="section-10">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-10">&#182;</a>
              </div>
              <h2 id="kache-del">Kache#Del</h2>
<p><em>Deletes an Item from the cache</em></p>
<p><strong>Arguments:</strong></p>
<ul>
<li><strong>key:</strong> <code>String</code></li>
</ul>
<p><strong>Returns:</strong> <code>Object</code> The Kache Object for chaining*</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.del = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">remove</span><span class="hljs-params">(key)</span> {</span>
  <span class="hljs-keyword">if</span>(!<span class="hljs-keyword">this</span>.has(key)) <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;

  debug(<span class="hljs-string">'Del: %s'</span>,key);
  <span class="hljs-keyword">delete</span> <span class="hljs-keyword">this</span>.cache[key];
  <span class="hljs-keyword">this</span>.emit(<span class="hljs-string">'remove'</span>, key);
  <span class="hljs-keyword">this</span>.length--;

  <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
};</pre></div></div>
            
        </li>
        
        
        <li id="section-11">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-11">&#182;</a>
              </div>
              <h2 id="kache-expired">Kache#Expired</h2>
<p><em>Checks if an Item has expired</em></p>
<p><strong>Arguments:</strong></p>
<ul>
<li><strong>key:</strong> <code>String</code></li>
</ul>
<p><strong>Returns:</strong> <code>Boolean</code></p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.expired = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">expired</span><span class="hljs-params">(key)</span> {</span>
  <span class="hljs-keyword">var</span> item = <span class="hljs-keyword">this</span>.cache[key];

  <span class="hljs-keyword">if</span>(!item || item.expired === <span class="hljs-literal">true</span>) <span class="hljs-keyword">return</span> <span class="hljs-literal">true</span>;

  item.expired = (<span class="hljs-built_in">Date</span>.now() - item.createdAt) &gt; item.ttl;
  <span class="hljs-keyword">return</span> item.expired;
};</pre></div></div>
            
        </li>
        
        
        <li id="section-12">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-12">&#182;</a>
              </div>
              <h2 id="kache-has">Kache#has</h2>
<p><em>Checks if an item exists in the cache</em></p>
<p><strong>Arguments:</strong></p>
<ul>
<li><strong>key:</strong> <code>String</code></li>
</ul>
<p><strong>Returns:</strong> <code>Boolean</code></p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.has = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">check</span><span class="hljs-params">(key)</span> {</span>
  <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.cache.hasOwnProperty(key);
};</pre></div></div>
            
        </li>
        
        
        <li id="section-13">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-13">&#182;</a>
              </div>
              <h2 id="kache-valid">Kache#valid</h2>
<p><em>Checks if a cached Item is valid.</em>
An Item is valid if it exists and has no Expired</p>
<p><strong>Arguments:</strong></p>
<ul>
<li><strong>key:</strong> <code>String</code></li>
</ul>
<p><strong>Returns:</strong> <code>Boolean</code></p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.valid = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">valid</span><span class="hljs-params">(key)</span> {</span>
  <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.has(key) &amp;&amp; !<span class="hljs-keyword">this</span>.expired(key);
};</pre></div></div>
            
        </li>
        
        
        <li id="section-14">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-14">&#182;</a>
              </div>
              <h2 id="kache-invalid">Kache#invalid</h2>
<p><em>Checks if a cached Item is invalid.</em>
Reversed Kache#valid</p>
<p><strong>Arguments:</strong></p>
<ul>
<li><strong>key:</strong> <code>String</code></li>
</ul>
<p><strong>Returns</strong> <code>Boolean</code></p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.invalid = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">invalid</span><span class="hljs-params">(key)</span> {</span>
  <span class="hljs-keyword">return</span> !<span class="hljs-keyword">this</span>.valid(key);
};</pre></div></div>
            
        </li>
        
        
        <li id="section-15">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-15">&#182;</a>
              </div>
              <h2 id="kache-keys">Kache#Keys</h2>
<p><strong>Returns:</strong> <code>Array</code> All keys present in the cache</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.keys = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">keys</span><span class="hljs-params">()</span> {</span>
  <span class="hljs-keyword">return</span> <span class="hljs-built_in">Object</span>.keys(<span class="hljs-keyword">this</span>.cache);
};</pre></div></div>
            
        </li>
        
        
        <li id="section-16">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-16">&#182;</a>
              </div>
              <h2 id="kache-expiredkeys">Kache#expiredKeys</h2>
<p><strong>Returns:</strong> <code>Array</code> All keys present in the cache which have expired</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.expiredKeys = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">keys</span><span class="hljs-params">()</span> {</span>
  <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.keys().filter(<span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(key)</span> {</span>
    <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.expired(key);
  }, <span class="hljs-keyword">this</span>);
};</pre></div></div>
            
        </li>
        
        
        <li id="section-17">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-17">&#182;</a>
              </div>
              <h2 id="kache-values">Kache#values</h2>
<p><strong>Returns:</strong> <code>Array</code> All values present in the cache</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.values = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">values</span><span class="hljs-params">()</span> {</span>
  <span class="hljs-keyword">return</span> _.chain(<span class="hljs-keyword">this</span>.cache)
    .values()
    .map(<span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(item)</span> {</span>
      <span class="hljs-keyword">return</span> item.value;
    })
    .value();
};</pre></div></div>
            
        </li>
        
        
        <li id="section-18">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-18">&#182;</a>
              </div>
              <h2 id="kache-each">Kache#each</h2>
<p><em>Iterates over each item in the cache excluding expired items.</em>
Same API as <code>Array.prototype.forEach</code></p>
<p><strong>Arguments:</strong></p>
<ul>
<li><strong>callback:</strong> <code>Function</code> Callback function</li>
<li><strong>thisArg:</strong> <code>Mixed</code> Sets the value of <code>this</code> on the callback function.</li>
</ul>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.each = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">each</span><span class="hljs-params">(callback, thisArg)</span> {</span>
  thisArg = thisArg || <span class="hljs-keyword">this</span>;

  <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>
    .keys()
    .forEach(<span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(key)</span> {</span>
      <span class="hljs-keyword">if</span>(<span class="hljs-keyword">this</span>.expired(key)) <span class="hljs-keyword">return</span>;
      callback.call(thisArg, key, <span class="hljs-keyword">this</span>.cache[key].value, <span class="hljs-keyword">this</span>.cache[key].ttl);
    }, <span class="hljs-keyword">this</span>);
};</pre></div></div>
            
        </li>
        
        
        <li id="section-19">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-19">&#182;</a>
              </div>
              <h2 id="kache-empty">Kache#Empty</h2>
<p><em>Empties the entire cache</em></p>
<p><strong>Returns:</strong> <code>Object</code> The Kache Object for chaining</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.empty = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">removeAll</span><span class="hljs-params">()</span> {</span>
  <span class="hljs-keyword">this</span>.cache = {};
  <span class="hljs-keyword">this</span>.length = <span class="hljs-number">0</span>;
  <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
};</pre></div></div>
            
        </li>
        
        
        <li id="section-20">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-20">&#182;</a>
              </div>
              <h2 id="kache-scan">Kache#Scan</h2>
<p><em>Scans the cache to remove old items</em></p>
<p><strong>Returns:</strong> <code>Object</code> The Kache Object for chaining</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.scan = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">scan</span><span class="hljs-params">()</span> {</span>
  debug(<span class="hljs-string">'Scanning Cache'</span>);
  <span class="hljs-keyword">this</span>.purgeExpired();
  <span class="hljs-keyword">this</span>.purgeOldest();

  <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
};</pre></div></div>
            
        </li>
        
        
        <li id="section-21">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-21">&#182;</a>
              </div>
              <h2 id="kache-purgeoldest">Kache#purgeOldest</h2>
<p><em>Reduces the size of the cache to the maximum allowed size by removing the oldest Items.</em></p>
<p><strong>Returns:</strong> <code>Object</code> The Kache Object for chaining</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.purgeOldest = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">purgeOldest</span><span class="hljs-params">()</span> {</span>
  <span class="hljs-keyword">if</span>(!<span class="hljs-keyword">this</span>.max || <span class="hljs-keyword">this</span>.length &lt; <span class="hljs-keyword">this</span>.max) <span class="hljs-keyword">return</span>;</pre></div></div>
            
        </li>
        
        
        <li id="section-22">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-22">&#182;</a>
              </div>
              <p><strong>TODO:</strong> Find and delete the oldest items from the cache</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>  <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
};</pre></div></div>
            
        </li>
        
        
        <li id="section-23">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-23">&#182;</a>
              </div>
              <h2 id="kache-purgeexpired">Kache#purgeExpired</h2>
<p><em>Checks the entire cache for expired objects</em></p>
<p><strong>Returns:</strong> <code>Object</code> The Kache Object for chaining</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.purgeExpired = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">purgeExpired</span><span class="hljs-params">()</span> {</span>
  <span class="hljs-keyword">this</span>.expiredKeys().forEach(<span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(key)</span> {</span>
    debug(<span class="hljs-string">'Expired: %s'</span>, key);
    <span class="hljs-keyword">this</span>.del(key);
  }, <span class="hljs-keyword">this</span>);
  <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
};</pre></div></div>
            
        </li>
        
        
        <li id="section-24">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-24">&#182;</a>
              </div>
              <h2 id="kache-start">Kache#start</h2>
<p><em>Starts the background worker</em></p>
<p><strong>Returns:</strong> <code>Object</code> The Kache Object for chaining</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.start = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">start</span><span class="hljs-params">()</span> {</span>
  <span class="hljs-keyword">if</span>(<span class="hljs-keyword">this</span>.worker) <span class="hljs-keyword">this</span>.stop();
  <span class="hljs-keyword">this</span>.worker = setInterval(<span class="hljs-keyword">this</span>.scan.bind(<span class="hljs-keyword">this</span>), <span class="hljs-keyword">this</span>.interval);
  <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
};</pre></div></div>
            
        </li>
        
        
        <li id="section-25">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-25">&#182;</a>
              </div>
              <h2 id="kache-stop">Kache#stop</h2>
<p><em>Stops the background worker</em></p>
<p><strong>Returns:</strong> <code>Object</code> The Kache Object for chaining</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Kache.prototype.stop = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">stop</span><span class="hljs-params">()</span> {</span>
  <span class="hljs-keyword">if</span> (<span class="hljs-keyword">this</span>.worker)
    clearInterval(<span class="hljs-keyword">this</span>.worker);
  <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
};</pre></div></div>
            
        </li>
        
        
        <li id="section-26">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-26">&#182;</a>
              </div>
              <h2 id="createcache">createCache</h2>
<p><em>Kache Factory</em></p>
<p><strong>Returns:</strong> <code>Object</code> A new Kache Object</p>

            </div>
            
            <div class="content"><div class='highlight'><pre><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">createCache</span><span class="hljs-params">(options)</span> {</span>
  <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> Kache(options);
}</pre></div></div>
            
        </li>
        
        
        <li id="section-27">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-27">&#182;</a>
              </div>
              <h2 id="export-createcache">Export createCache</h2>

            </div>
            
            <div class="content"><div class='highlight'><pre>module.exports = createCache;</pre></div></div>
            
        </li>
        
    </ul>
  </div>
</body>
</html>