Edit File - File Manager

Edit File: memory.html

<!DOCTYPE html> <html> <head> <title>memory.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="../../docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To &hellip; <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="../..//nconf/common.html"> nconf/common.html </a> <a class="source" href="../..//nconf/formats.html"> nconf/formats.html </a> <a class="source" href="../..//nconf/provider.html"> nconf/provider.html </a> <a class="source" href="../..//nconf/stores/file.html"> nconf/stores/file.html </a> <a class="source" href="../..//nconf/stores/memory.html"> nconf/stores/memory.html </a> <a class="source" href="../..//nconf/stores/system.html"> nconf/stores/system.html </a> <a class="source" href="../..//nconf/stores.html"> nconf/stores.html </a> <a class="source" href="../..//nconf.html"> nconf.html </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> memory.js </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">&#182;</a> </div> </td> <td class="code"> <div class="highlight"><pre>/*
 * memory.js: Simple memory storage engine for nconf configuration(s)
 *
 * (C) 2011, Charlie Robbins
 *
 */

var common = require(&#39;../common&#39;);</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <h3>function Memory (options)</h3>

<h4>@options {Object} Options for this instance</h4>

Constructor function for the Memory nconf store which maintains
a nested json structure based on key delimiters <code>:</code>.

e.g. <code>my:nested:key</code> ==> <code>{ my: { nested: { key: } } }</code> </td> <td class="code"> <div class="highlight"><pre>var Memory = exports.Memory = function (options) {
 options = options || {};
 this.type = &#39;memory&#39;;
 this.store = {};
 this.mtimes = {};
 this.readOnly = false;
 this.loadFrom = options.loadFrom || null;
 
 if (this.loadFrom) {
 this.store = common.loadFilesSync(this.loadFrom);
 }
};</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">&#182;</a> </div> <h3>function get (key)</h3>

<h4>@key {string} Key to retrieve for this instance.</h4>

Retrieves the value for the specified key (if any). </td> <td class="code"> <div class="highlight"><pre>Memory.prototype.get = function (key) {
 var target = this.store, 
 path = common.path(key);</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">&#182;</a> </div> Scope into the object to get the appropriate nested context </td> <td class="code"> <div class="highlight"><pre> while (path.length &gt; 0) {
 key = path.shift();
 if (!(target &amp;&amp; key in target)) {
 return;
 }
 
 target = target[key];
 if (path.length === 0) {
 return target;
 }
 }
};</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">&#182;</a> </div> <h3>function set (key, value)</h3>

<h4>@key {string} Key to set in this instance</h4>

<h4>@value {literal|Object} Value for the specified key</h4>

Sets the <code>value</code> for the specified <code>key</code> in this instance. </td> <td class="code"> <div class="highlight"><pre>Memory.prototype.set = function (key, value) {
 if (this.readOnly) {
 return false;
 }
 
 var target = this.store, 
 path = common.path(key);
 </pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">&#182;</a> </div> Update the <code>mtime</code> (modified time) of the key </td> <td class="code"> <div class="highlight"><pre> this.mtimes[key] = Date.now();
 </pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">&#182;</a> </div> Scope into the object to get the appropriate nested context </td> <td class="code"> <div class="highlight"><pre> while (path.length &gt; 1) {
 key = path.shift();
 if (!target[key] || typeof target[key] !== &#39;object&#39;) {
 target[key] = {};
 }
 
 target = target[key];
 }
 </pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">&#182;</a> </div> Set the specified value in the nested JSON structure </td> <td class="code"> <div class="highlight"><pre> key = path.shift();
 target[key] = value;
 return true;
};</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">&#182;</a> </div> <h3>function clear (key)</h3>

<h4>@key {string} Key to remove from this instance</h4>

Removes the value for the specified <code>key</code> from this instance. </td> <td class="code"> <div class="highlight"><pre>Memory.prototype.clear = function (key) {
 if (this.readOnly) {
 return false;
 }
 
 var target = this.store, 
 path = common.path(key);
 </pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">&#182;</a> </div> Remove the key from the set of <code>mtimes</code> (modified times) </td> <td class="code"> <div class="highlight"><pre> delete this.mtimes[key];
 </pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">&#182;</a> </div> Scope into the object to get the appropriate nested context </td> <td class="code"> <div class="highlight"><pre> while (path.length &gt; 1) {
 key = path.shift();
 if (!target[key]) {
 return;
 }
 
 target = target[key];
 }
 </pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">&#182;</a> </div> Delete the key from the nested JSON structure </td> <td class="code"> <div class="highlight"><pre> key = path.shift();
 delete target[key];
 return true;
};</pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">&#182;</a> </div> <h3>function merge (key, value)</h3>

<h4>@key {string} Key to merge the value into</h4>

<h4>@value {literal|Object} Value to merge into the key</h4>

Merges the properties in <code>value</code> into the existing object value
at <code>key</code>. If the existing value <code>key</code> is not an Object, it will be
completely overwritten. </td> <td class="code"> <div class="highlight"><pre>Memory.prototype.merge = function (key, value) {
 if (this.readOnly) {
 return false;
 }
 </pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">&#182;</a> </div> If the key is not an <code>Object</code> or is an <code>Array</code>,
then simply set it. Merging is for Objects. </td> <td class="code"> <div class="highlight"><pre> if (typeof value !== &#39;object&#39; || Array.isArray(value)) {
 return this.set(key, value);
 }
 
 var self = this,
 target = this.store, 
 path = common.path(key),
 fullKey = key;
 </pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">&#182;</a> </div> Update the <code>mtime</code> (modified time) of the key </td> <td class="code"> <div class="highlight"><pre> this.mtimes[key] = Date.now();
 </pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-16">&#182;</a> </div> Scope into the object to get the appropriate nested context </td> <td class="code"> <div class="highlight"><pre> while (path.length &gt; 1) {
 key = path.shift();
 if (!target[key]) {
 target[key] = {};
 }
 
 target = target[key];
 }</pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-17">&#182;</a> </div> Set the specified value in the nested JSON structure </td> <td class="code"> <div class="highlight"><pre> key = path.shift();
 </pre></div> </td> </tr> <tr id="section-18"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-18">&#182;</a> </div> If the current value at the key target is not an <code>Object</code>,
or is an <code>Array</code> then simply override it because the new value
is an Object. </td> <td class="code"> <div class="highlight"><pre> if (typeof target[key] !== &#39;object&#39; || Array.isArray(target[key])) {
 target[key] = value;
 return true;
 }
 
 return Object.keys(value).every(function (nested) {
 return self.merge(fullKey + &#39;:&#39; + nested, value[nested]);
 });
};</pre></div> </td> </tr> <tr id="section-19"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-19">&#182;</a> </div> <h3>function reset (callback)</h3>

Clears all keys associated with this instance. </td> <td class="code"> <div class="highlight"><pre>Memory.prototype.reset = function () {
 if (this.readOnly) {
 return false;
 }
 
 this.mtimes = {};
 this.store = {};
 return true;
};

</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>

Back to File Manager