Edit File - File Manager

Edit File: common.html

<!DOCTYPE html> <html> <head> <title>common.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> common.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>/*
 * utils.js: Utility functions for the nconf module.
 *
 * (C) 2011, Charlie Robbins
 *
 */
 
var fs = require(&#39;fs&#39;),
 async = require(&#39;async&#39;),
 formats = require(&#39;./formats&#39;),
 Memory = require(&#39;./stores/Memory&#39;).Memory;

var common = exports;</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 path (key)</h3>

<h4>@key {string} The ':' delimited key to split</h4>

Returns a fully-qualified path to a nested nconf key. </td> <td class="code"> <div class="highlight"><pre>common.path = function (key) {
 return key.split(&#39;:&#39;);
};</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 key (arguments)</h3>

Returns a <code>:</code> joined string from the <code>arguments</code>. </td> <td class="code"> <div class="highlight"><pre>common.key = function () {
 return Array.prototype.slice.call(arguments).join(&#39;:&#39;);
};</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 loadFiles (files, callback)</h3>

<h4>@files {Object|Array} List of files (or settings object) to load.</h4>

<h4>@callback {function} Continuation to respond to when complete.</h4>

Loads all the data in the specified <code>files</code>. </td> <td class="code"> <div class="highlight"><pre>common.loadFiles = function (files, callback) {
 if (!files) {
 return callback(null, {});
 }

var options = Array.isArray(files) ? { files: files } : files;</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">&#182;</a> </div> Set the default JSON format if not already
specified </td> <td class="code"> <div class="highlight"><pre> options.format = options.format || formats.json;

function parseFile (file, next) {
 fs.readFile(file, function (err, data) {
 return !err 
 ? next(null, options.format.parse(data.toString()))
 : next(err);
 });
 }

async.map(files, parseFile, function (err, objs) {
 return err ? callback(err) : callback(null, common.merge(objs));
 });
};</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 loadFilesSync (files)</h3>

<h4>@files {Object|Array} List of files (or settings object) to load.</h4>

Loads all the data in the specified <code>files</code> synchronously. </td> <td class="code"> <div class="highlight"><pre>common.loadFilesSync = function (files) {
 if (!files) {
 return;
 }</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">&#182;</a> </div> Set the default JSON format if not already
specified </td> <td class="code"> <div class="highlight"><pre> var options = Array.isArray(files) ? { files: files } : files;
 options.format = options.format || formats.json;

return common.merge(files.map(function (file) {
 return options.format.parse(fs.readFileSync(file, &#39;utf8&#39;));
 }));
};</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 merge (objs)</h3>

<h4>@objs {Array} Array of object literals to merge</h4>

Merges the specified <code>objs</code> using a temporary instance
of <code>stores.Memory</code>. </td> <td class="code"> <div class="highlight"><pre>common.merge = function (objs) {
 var store = new Memory();
 
 objs.forEach(function (obj) {
 Object.keys(obj).forEach(function (key) {
 store.merge(key, obj[key]);
 });
 });
 
 return store.store;
};</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 capitalize (str)</h3>

<h4>@str {string} String to capitalize</h4>

Capitalizes the specified <code>str</code>. </td> <td class="code"> <div class="highlight"><pre>common.capitalize = function (str) {
 return str &amp;&amp; str[0].toUpperCase() + str.slice(1);
};

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

Back to File Manager