Edit File - File Manager

Edit File: system.html

<!DOCTYPE html> <html> <head> <title>system.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> system.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>/*
 * system.js: Simple memory-based store for process environment variables and
 * command-line arguments.
 *
 * (C) 2011, Charlie Robbins
 *
 */
 
var util = require(&#39;util&#39;),
 Memory = require(&#39;./memory&#39;).Memory;
 </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 System (options)</h3>

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

Constructor function for the System nconf store, a simple abstraction
around the Memory store that can read process environment variables
and command-line arguments. </td> <td class="code"> <div class="highlight"><pre>var System = exports.System = function (options) {
 options = options || {};
 Memory.call(this, options);

this.type = &#39;system&#39;;
 this.overrides = options.overrides || null;
 this.env = options.env || false;
 this.argv = options.argv || false;
};</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">&#182;</a> </div> Inherit from the Memory store </td> <td class="code"> <div class="highlight"><pre>util.inherits(System, Memory);</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">&#182;</a> </div> <h3>function loadSync ()</h3>

Loads the data passed in from <code>process.env</code> into this instance. </td> <td class="code"> <div class="highlight"><pre>System.prototype.loadSync = function () {
 if (this.env) {
 this.loadEnv();
 }
 
 if (this.argv) {
 this.loadArgv();
 }
 
 if (this.overrides) {
 this.loadOverrides();
 }
 
 return this.store;
};</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 loadOverrides ()</h3>

Loads any overrides set on this instance into
the underlying managed <code>Memory</code> store. </td> <td class="code"> <div class="highlight"><pre>System.prototype.loadOverrides = function () {
 if (!this.overrides) {
 return;
 }
 
 var self = this,
 keys = Object.keys(this.overrides);
 
 keys.forEach(function (key) {
 self.set(key, self.overrides[key]);
 });
 
 return this.store;
};</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">&#182;</a> </div> <h3>function loadArgv ()</h3>

Loads the data passed in from the command-line arguments 
into this instance. </td> <td class="code"> <div class="highlight"><pre>System.prototype.loadArgv = function () {
 var self = this, 
 argv;
 
 if (typeof this.argv === &#39;object&#39;) {
 argv = require(&#39;optimist&#39;).options(this.argv).argv;
 }
 else if (this.argv) {
 argv = require(&#39;optimist&#39;).argv;
 }
 
 if (!argv) {
 return;
 }
 
 Object.keys(argv).forEach(function (key) {
 self.set(key, argv[key]);
 });
 
 return this.store;
};</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">&#182;</a> </div> <h3>function loadEnv ()</h3>

Loads the data passed in from <code>process.env</code> into this instance. </td> <td class="code"> <div class="highlight"><pre>System.prototype.loadEnv = function () {
 var self = this;
 
 if (!this.env) {
 return;
 }
 
 Object.keys(process.env).filter(function (key) {
 return !self.env.length || self.env.indexOf(key) !== -1;
 }).forEach(function (key) {
 self.set(key, process.env[key]);
 });
 
 return this.store;
};

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

Back to File Manager