Edit File - File Manager

Edit File: file.html

<!DOCTYPE html> <html> <head> <title>file.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> file.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>/*
 * file.js: Simple file storage engine for nconf files
 *
 * (C) 2011, Charlie Robbins
 *
 */

var fs = require(&#39;fs&#39;),
 path = require(&#39;path&#39;),
 util = require(&#39;util&#39;),
 formats = require(&#39;../formats&#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 File (options)</h3>

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

Constructor function for the File nconf store, a simple abstraction
around the Memory store that can persist configuration to disk. </td> <td class="code"> <div class="highlight"><pre>var File = exports.File = function (options) {
 if (!options || !options.file) {
 throw new Error (&#39;Missing required option `files`&#39;);
 }

Memory.call(this, options);

this.type = &#39;file&#39;;
 this.file = options.file;
 this.dir = options.dir || process.cwd();
 this.format = options.format || formats.json;
};</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(File, 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 save (value, callback)</h3>

<h4>@value {Object} Ignored Left here for consistency</h4>

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

Saves the current configuration object to disk at <code>this.file</code> 
using the format specified by <code>this.format</code>. </td> <td class="code"> <div class="highlight"><pre>File.prototype.save = function (value, callback) {
 if (!callback) {
 callback = value;
 value = null;
 }
 
 fs.writeFile(this.file, this.format.stringify(this.store), function (err) {
 return err ? callback(err) : callback();
 });
};</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 saveSync (value, callback)</h3>

<h4>@value {Object} Ignored Left here for consistency</h4>

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

Saves the current configuration object to disk at <code>this.file</code> 
using the format specified by <code>this.format</code> synchronously. </td> <td class="code"> <div class="highlight"><pre>File.prototype.saveSync = function (value) {
 try {
 fs.writeFileSync(this.file, this.format.stringify(this.store));
 }
 catch (ex) {
 throw(ex);
 }
};</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 load (callback)</h3>

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

Responds with an Object representing all keys associated in this instance. </td> <td class="code"> <div class="highlight"><pre>File.prototype.load = function (callback) {
 var self = this;

path.exists(self.file, function (exists) {
 if (!exists) {</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">&#182;</a> </div> If the path we are attempting to load doesn't exist, create it </td> <td class="code"> <div class="highlight"><pre> self.save({}, function (err) {
 self.store = {};
 return callback(err, self.store);
 });
 }
 else {</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">&#182;</a> </div> Else, the path exists, read it from disk </td> <td class="code"> <div class="highlight"><pre> fs.readFile(self.file, function (err, data) {
 if (err) {
 return callback(err);
 }
 
 try {
 self.store = self.format.parse(data.toString());
 }
 catch (ex) {
 return callback(new Error(&quot;Error parsing your JSON configuration file.&quot;));
 }
 
 callback(null, self.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 load (callback)</h3>

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

Attempts to load the data stored in <code>this.file</code> synchronously and responds appropriately. </td> <td class="code"> <div class="highlight"><pre>File.prototype.loadSync = function () {
 var data, self = this;

if (!path.existsSync(self.file)) {</pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">&#182;</a> </div> If the path we are attempting to load doesn't exist, create it </td> <td class="code"> <div class="highlight"><pre> self.saveSync({});
 self.store = {};
 data = {};
 }
 else {</pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">&#182;</a> </div> Else, the path exists, read it from disk </td> <td class="code"> <div class="highlight"><pre> try {
 data = this.format.parse(fs.readFileSync(this.file, &#39;utf8&#39;));
 this.store = data;
 }
 catch (ex) {
 throw new Error(&quot;Error parsing your JSON configuration file.&quot;)
 }
 }

return data;
};</pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">&#182;</a> </div> <h3>function search (base)</h3>

<h4>@base {string} Base directory (or file) to begin searching for the target file.</h4>

Attempts to find <code>this.file</code> by iteratively searching up the 
directory structure </td> <td class="code"> <div class="highlight"><pre>File.prototype.search = function (base) {
 var looking = true,
 fullpath,
 previous,
 stats;

base = base || process.cwd();

if (this.file[0] === &#39;/&#39;) {</pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">&#182;</a> </div> If filename for this instance is a fully qualified path
(i.e. it starts with a <code>'/'</code>) then check if it exists </td> <td class="code"> <div class="highlight"><pre> try {
 stats = fs.statSync(fs.realpathSync(this.file));
 if (stats.isFile()) {
 fullpath = this.file;
 looking = false;
 }
 }
 catch (ex) {</pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">&#182;</a> </div> Ignore errors </td> <td class="code"> <div class="highlight"><pre> }
 }

if (looking &amp;&amp; base) {</pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">&#182;</a> </div> Attempt to stat the realpath located at <code>base</code>
if the directory does not exist then return false. </td> <td class="code"> <div class="highlight"><pre> try {
 var stat = fs.statSync(fs.realpathSync(base));
 looking = stat.isDirectory();
 }
 catch (ex) {
 return false;
 }
 }
 
 while (looking) {</pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-16">&#182;</a> </div> Iteratively look up the directory structure from <code>base</code> </td> <td class="code"> <div class="highlight"><pre> try {
 stats = fs.statSync(fs.realpathSync(fullpath = path.join(base, this.file)));
 looking = stats.isDirectory();
 }
 catch (ex) {
 previous = base;
 base = path.dirname(base);

if (previous === base) {</pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-17">&#182;</a> </div> If we've reached the top of the directory structure then simply use
the default file path. </td> <td class="code"> <div class="highlight"><pre> try {
 stats = fs.statSync(fs.realpathSync(fullpath = path.join(this.dir, this.file)));
 if (stats.isDirectory()) {
 fullpath = undefined;
 }
 }
 catch (ex) {</pre></div> </td> </tr> <tr id="section-18"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-18">&#182;</a> </div> Ignore errors </td> <td class="code"> <div class="highlight"><pre> }
 
 looking = false;
 }
 }
 }</pre></div> </td> </tr> <tr id="section-19"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-19">&#182;</a> </div> Set the file for this instance to the fullpath
that we have found during the search. In the event that
the search was unsuccessful use the original value for <code>this.file</code>. </td> <td class="code"> <div class="highlight"><pre> this.file = fullpath || this.file;
 
 return fullpath;
};

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

Back to File Manager