Edit File - File Manager

Edit File: provider.html

<!DOCTYPE html> <html> <head> <title>provider.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> provider.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>/*
 * provider.js: Abstraction providing an interface into pluggable configuration storage.
 *
 * (C) 2011, Charlie Robbins
 *
 */

var async = require(&#39;async&#39;),
 common = require(&#39;./common&#39;),
 stores = require(&#39;./stores&#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 Provider (options)</h3>

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

Constructor function for the Provider object responsible
for exposing the pluggable storage features of <code>nconf</code>. </td> <td class="code"> <div class="highlight"><pre>var Provider = exports.Provider = function (options) {
 var self = this; 
 </pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">&#182;</a> </div> Setup default options for working with <code>stores</code>,
<code>overrides</code>, <code>process.env</code> and <code>process.argv</code>. </td> <td class="code"> <div class="highlight"><pre> options = options || {};
 this._overrides = options.overrides || null;
 this._argv = options.argv || false;
 this._env  = options.env || false;
 this._reserved = Object.keys(Provider.prototype);
 this._stores = [];
 </pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">&#182;</a> </div> Add the default <code>system</code> store for working with
<code>overrides</code>, <code>process.env</code>, <code>process.argv</code> and
a simple in-memory objects. </td> <td class="code"> <div class="highlight"><pre> this.add(&#39;system&#39;, options);
 
 if (options.type) {
 this.add(options.type, options);
 }
 else if (options.store) {
 this.add(options.store.name || options.store.type, options.store);
 }
 else if (options.stores) {
 Object.keys(options.stores).forEach(function (store) {
 self.add(store.name || store.type, 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 use (name, options)</h3>

<h4>@type {string} Type of the nconf store to use.</h4>

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

Adds (or replaces) a new store with the specified <code>name</code> 
and <code>options</code>. If <code>options.type</code> is not set, then <code>name</code> 
will be used instead:

provider.use('file');
 provider.use('file', { type: 'file', filename: '/path/to/userconf' }) </td> <td class="code"> <div class="highlight"><pre>Provider.prototype.use = function (name, options) {
 if (name === &#39;system&#39;) {
 return;
 }
 else if (this._reserved.indexOf(name) !== -1) {
 throw new Error(&#39;Cannot use reserved name: &#39; + name);
 }
 
 options = options || {};
 var type = options.type || name;

<h4>@name {string} Name of the store to add to this instance</h4>

<h4>@options {Object} Options for the store to create</h4>

Adds a new store with the specified <code>name</code> and <code>options</code>. If <code>options.type</code>
is not set, then <code>name</code> will be used instead:

provider.add('memory');
 provider.add('userconf', { type: 'file', filename: '/path/to/userconf' }) </td> <td class="code"> <div class="highlight"><pre>Provider.prototype.add = function (name, options) {
 if (this._reserved.indexOf(name) !== -1) {
 throw new Error(&#39;Cannot use reserved name: &#39; + name);
 }
 
 options = options || {};
 var type = options.type || name;
 
 if (Object.keys(stores).indexOf(common.capitalize(type)) === -1) {
 throw new Error(&#39;Cannot add store with unknown type: &#39; + type);
 }
 
 this[name] = this.create(type, options);
 this._stores.push(name);
 
 if (this[name].loadSync) {
 this[name].loadSync();
 }
};</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 remove (name)</h3>

<h4>@name {string} Name of the store to remove from this instance</h4>

Removes a store with the specified <code>name</code> from this instance. Users
are allowed to pass in a type argument (e.g. <code>memory</code>) as name if
this was used in the call to <code>.add()</code>. </td> <td class="code"> <div class="highlight"><pre>Provider.prototype.remove = function (name) {
 if (this._reserved.indexOf(name) !== -1) {
 throw new Error(&#39;Cannot use reserved name: &#39; + name);
 }
 else if (!this[name]) {
 throw new Error(&#39;Cannot remove store that does not exist: &#39; + name);
 }
 
 delete this[name];
 this._stores.splice(this._stores.indexOf(name), 1);
};</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">&#182;</a> </div> <h3>function create (type, options)</h3>

<h4>@type {string} Type of the nconf store to use.</h4>

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

Creates a store of the specified <code>type</code> using the 
specified <code>options</code>. </td> <td class="code"> <div class="highlight"><pre>Provider.prototype.create = function (type, options) {
 return new stores[common.capitalize(type.toLowerCase())](options);
};</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 get (key, callback)</h3>

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