keys

<a href="http://github.com/visionmedia/keys"><img alt="Fork me on GitHub" id="ribbon" src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"></a><html> <head> <title>Keys</title> <script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js"></script> <style>body { margin: 0; padding: 0; font: 14px/1.5 'Palatino Linotype', 'Book Antiqua', Palatino, FreeSerif, serif; color: #252519; } a { color: #252519; } a:hover { text-decoration: underline; color: #19469D; } p { margin: 12px 0; } h1, h2, h3 { margin: 0; padding: 0; } table#source { width: 100%; border-collapse: collapse; } table#source td:first-child { padding: 30px 40px 30px 40px; vertical-align: top; } table#source td:first-child, table#source td:first-child pre { width: 450px; } table#source td:last-child { padding: 30px 0 30px 40px; border-left: 1px solid #E5E5EE; background: #F5F5FF; } table#source tr { border-bottom: 1px solid #E5E5EE; } table#source tr.filename { padding-top: 40px; border-top: 1px solid #E5E5EE; } table#source tr.filename td:first-child { text-transform: capitalize; } table#source tr.filename td:last-child { font-size: 12px; } table#source tr.filename h2 { margin: 0; padding: 0; cursor: pointer; } table#source tr.code h1, table#source tr.code h2, table#source tr.code h3 { margin-top: 30px; font-family: "Lucida Grande", "Helvetica Nueue", Arial, sans-serif; font-size: 18px; } table#source tr.code h2 { font-size: 16px; } table#source tr.code h3 { font-size: 14px; } table#source tr.code ul { margin: 15px 0 15px 35px; padding: 0; } table#source tr.code ul li { margin: 0; padding: 1px 0; } table#source tr.code ul li p { margin: 0; padding: 0; } table#source tr.code td:first-child pre { padding: 20px; } #ribbon { position: fixed; top: 0; right: 0; } code .string { color: #219161; } code .regexp { color: #219161; } code .keyword { color: #954121; } code .number { color: #19469D; } code .comment { color: #bbb; } code .this { color: #19469D; }</style> <script> $(function(){ $('tr.code').hide(); $('tr.filename').toggle(function(){ $(this).nextUntil('.filename').fadeIn(); }, function(){ $(this).nextUntil('.filename').fadeOut(); }); }); </script> </head> <body> <table id="source"><tbody><tr><td><h1>Keys</h1>Unified interface for <a href="http://nodejs.org">node</a> key/value stores.</td><td></td></tr><tr class="filename"><td><h2 id="lib/keys.js"><a href="#">keys</a></h2></td><td>lib/keys.js</td></tr><tr class="code"> <td class="docs"> Generate auto-loading getters. <h2>Example</h2> <pre><code>keys.Redis</code></pre> </td> <td class="code"> <pre><code>(function(name){ exports.__defineGetter__(name, function(){ return require('./stores/' + name.toLowerCase()); }); return arguments.callee; })('Memory')('Redis')('nStore')('Riak');</code></pre> </td> </tr><tr class="filename"><td><h2 id="lib/stores/memory.js"><a href="#">memory</a></h2></td><td>lib/stores/memory.js</td></tr><tr class="code"> <td class="docs"> Initialize memory store. <h2>Options</h2> <ul><li><code>data</code> Object containing pre-defined store data</li></ul> <h2></h2> <ul><li>param: Object options</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>var Memory = module.exports = function Memory(options) { var self = this; options = options || {}; this.data = options.data || {}; };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Set <code>key</code> to <code>val</code>, then callback <code>fn(err)</code>. <h2></h2> <ul><li>param: String key</li><li>param: String val</li><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Memory.prototype.set = function(key, val, fn){ this.data[key] = val; fn &amp;&amp; fn(); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Get <code>key</code>, then callback <code>fn(err, val)</code>. <h2></h2> <ul><li>param: String key</li><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Memory.prototype.get = function(key, fn){ fn(null, this.data[key]); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Remove <code>key</code>, then callback <code>fn(err)</code>. <h2></h2> <ul><li>param: String key</li><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Memory.prototype.remove = function(key, fn){ delete this.data[key]; fn &amp;&amp; fn(); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Check if <code>key</code> exists, callback <code>fn(err, exists)</code>. <h2></h2> <ul><li>param: String key</li><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Memory.prototype.has = function(key, fn){ fn(null, key in this.data); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Fetch number of keys, callback <code>fn(err, len)</code>. <h2></h2> <ul><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Memory.prototype.length = function(fn){ fn(null, Object.keys(this.data).length); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Clear all keys, then callback <code>fn(err)</code>. <h2></h2> <ul><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Memory.prototype.clear = function(fn){ this.data = {}; fn &amp;&amp; fn(); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Iterate with <code>fn(err, val, key)</code>, then <code>done()</code> when finished. <h2></h2> <ul><li>param: Function fn</li><li>param: Function done</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Memory.prototype.each = function(fn, done){ var keys = Object.keys(this.data); for (var i = 0, len = keys.length; i &lt; len; ++i) { fn(this.data[keys[i]], keys[i]); } done &amp;&amp; done(); }; </code></pre> </td> </tr><tr class="filename"><td><h2 id="lib/stores/nstore.js"><a href="#">nstore</a></h2></td><td>lib/stores/nstore.js</td></tr><tr class="code"> <td class="docs"> Module dependencies. </td> <td class="code"> <pre><code>var Store = require('nstore');</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Initialize nStore ... store. <h2>Options</h2> <ul><li><code>path</code> Path to database, defaults to CWD/store.db</li></ul> <h2></h2> <ul><li>param: Object options</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>var nStore = module.exports = function nStore(options) { options = options || {}; var path = options.path || process.cwd() + '/store.db'; this.client = Store(path); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Set <code>key</code> to <code>val</code>, then callback <code>fn(err)</code>. <h2></h2> <ul><li>param: String key</li><li>param: String val</li><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>nStore.prototype.get = function(key, fn){ this.client.get(key, fn); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Get <code>key</code>, then callback <code>fn(err, val)</code>. <h2></h2> <ul><li>param: String key</li><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>nStore.prototype.set = function(key, val, fn){ this.client.save(key, val, fn); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Remove <code>key</code>, then callback <code>fn(err)</code>. <h2></h2> <ul><li>param: String key</li><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>nStore.prototype.remove = function(key, fn){ this.client.remove(key, fn); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Check if <code>key</code> exists, callback <code>fn(err, exists)</code>. <h2></h2> <ul><li>param: String key</li><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>nStore.prototype.has = function(key, fn){ this.client.get(key, function(err, val){ fn(err, !!val); }); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Fetch number of keys, callback <code>fn(err, len)</code>. <h2></h2> <ul><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>nStore.prototype.length = function(fn){ fn(null, this.client.length); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Clear all keys, then callback <code>fn(err)</code>. <h2></h2> <ul><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>nStore.prototype.clear = function(fn){ this.client.clear(); fn &amp;&amp; fn(); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Iterate with <code>fn(err, val, key)</code>, then <code>done()</code> when finished. <h2></h2> <ul><li>param: Function fn</li><li>param: Function done</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>nStore.prototype.each = function(fn, done){ var stream = this.client.stream(); stream.addListener('data', function(doc, meta){ fn(doc, meta.key); }); stream.addListener('end', function(){ done &amp;&amp; done(); }); };</code></pre> </td> </tr><tr class="filename"><td><h2 id="lib/stores/redis.js"><a href="#">redis</a></h2></td><td>lib/stores/redis.js</td></tr><tr class="code"> <td class="docs"> Module dependencies. </td> <td class="code"> <pre><code>var redis = require('redis-client'), noop = function(){};</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Initialize redis store. <h2>Options</h2> <ul><li><code>port</code> Optional redis-server port</li><li><code>host</code> Optional redis-server host</li><li>... Other options passed to <code>redis.createClient()</code></li></ul> <h2></h2> <ul><li>param: Object options</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>var Redis = module.exports = function Redis(options) { options = options || {}; this.client = new redis.createClient(options.port, options.host, options); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Set <code>key</code> to <code>val</code>, then callback <code>fn(err)</code>. <h2></h2> <ul><li>param: String key</li><li>param: String val</li><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Redis.prototype.set = function(key, val, fn){ this.client.set(key, val, fn || noop); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Get <code>key</code>, then callback <code>fn(err, val)</code>. <h2></h2> <ul><li>param: String key</li><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Redis.prototype.get = function(key, fn){ this.client.get(key, function(err, buf){ fn(err, buf ? buf.toString() : buf); }); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Remove <code>key</code>, then callback <code>fn(err)</code>. <h2></h2> <ul><li>param: String key</li><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Redis.prototype.remove = function(key, fn){ this.client.del(key, fn); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Check if <code>key</code> exists, callback <code>fn(err, exists)</code>. <h2></h2> <ul><li>param: String key</li><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Redis.prototype.has = function(key, fn){ this.client.exists(key, function(err, exists){ fn(err, !!exists); }); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Fetch number of keys, callback <code>fn(err, len)</code>. <h2></h2> <ul><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Redis.prototype.length = function(fn){ this.client.dbsize(fn); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Clear all keys, then callback <code>fn(err)</code>. <h2></h2> <ul><li>param: Function fn</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Redis.prototype.clear = function(fn){ this.client.flushdb(fn || noop); };</code></pre> </td> </tr> <tr class="code"> <td class="docs"> Iterate with <code>fn(err, val, key)</code>, then <code>done()</code> when finished. <h2></h2> <ul><li>param: Function fn</li><li>param: Function done</li><li>api: public</li></ul> </td> <td class="code"> <pre><code>Redis.prototype.each = function(fn, done){ var self = this; this.client.keys('*', function(err, keys){ var keys = keys.toString().split(' '), pending = keys.length; for (var i = 0, len = keys.length; i &lt; len; ++i) { (function(key){ self.get(key, function(err, val){ fn(val, key); --pending || (done &amp;&amp; done()); }); })(keys[i]); } }); }; </code></pre> </td> </tr> </body> </html></tbody></table>