Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Assuring runtime.json file exists before watching

  • Loading branch information...
commit d329ff6c42b411e215a76796beea1c0f20f04ed2 1 parent 213655b
Loren West authored
View
5 History.md
@@ -1,3 +1,8 @@
+0.4.13 / 2012-04-25
+===================
+
+ * Assuring the runtime.json file exists. Undocumented fs.watch() requirement.
+
0.4.12 / 2012-04-25
===================
View
10 doc/1-protected-test.js.html
@@ -4,11 +4,11 @@
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>test 1-protected-test.js </title>
- <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1329362514.09" />
- <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1329362514.09" />
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1335400935.57" />
+ <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1335400935.57" />
- <script type="text/javascript" src="assets/api-js?stamp=1329362514.09"></script>
- <script type="text/javascript" src="assets/ac-js?stamp=1329362514.09"></script>
+ <script type="text/javascript" src="assets/api-js?stamp=1335400935.57"></script>
+ <script type="text/javascript" src="assets/ac-js?stamp=1335400935.57"></script>
</head>
<body id="node-monitor">
@@ -416,7 +416,7 @@
<div id="ft">
<hr />
Released on <a href="https://github.com/lorenwest/node-config">github</a> under the <a href="https://github.com/lorenwest/node-config/blob/master/LICENSE">Apache License 2.0</a>
-<span class="subtitle">version 0.4.11</span>
+<span class="subtitle">version 0.4.13</span>
</div>
</div>
<script type="text/javascript">
View
10 doc/2-config-test.js.html
@@ -4,11 +4,11 @@
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>test 2-config-test.js </title>
- <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1329362514.09" />
- <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1329362514.09" />
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1335400935.57" />
+ <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1335400935.57" />
- <script type="text/javascript" src="assets/api-js?stamp=1329362514.09"></script>
- <script type="text/javascript" src="assets/ac-js?stamp=1329362514.09"></script>
+ <script type="text/javascript" src="assets/api-js?stamp=1335400935.57"></script>
+ <script type="text/javascript" src="assets/ac-js?stamp=1335400935.57"></script>
</head>
<body id="node-monitor">
@@ -302,7 +302,7 @@
<div id="ft">
<hr />
Released on <a href="https://github.com/lorenwest/node-config">github</a> under the <a href="https://github.com/lorenwest/node-config/blob/master/LICENSE">Apache License 2.0</a>
-<span class="subtitle">version 0.4.11</span>
+<span class="subtitle">version 0.4.13</span>
</div>
</div>
<script type="text/javascript">
View
18 doc/Config.html
@@ -4,11 +4,11 @@
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>config Config </title>
- <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1329362514.15" />
- <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1329362514.15" />
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1335400935.6" />
+ <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1335400935.6" />
- <script type="text/javascript" src="assets/api-js?stamp=1329362514.15"></script>
- <script type="text/javascript" src="assets/ac-js?stamp=1329362514.15"></script>
+ <script type="text/javascript" src="assets/api-js?stamp=1335400935.6"></script>
+ <script type="text/javascript" src="assets/ac-js?stamp=1335400935.6"></script>
</head>
<body id="node-monitor">
@@ -599,8 +599,10 @@ <h3 id="methods">Methods</h3>
.json = File is parsed using JSON.parse()
.coffee = File to run that has a module.exports with coffee-script containing the config object
.yaml = Parsed with a YAML parser
-If the file doesn't exist, a null will be returned.
-If the file can't be parsed, an exception will be thrown.
+If the file doesn't exist, a null will be returned. If the file can't be
+parsed, an exception will be thrown.
+This method performs synchronous file operations, and should not be called
+after synchronous module loading.
</div>
<div class="description">
@@ -1249,7 +1251,7 @@ <h3 id="methods">Methods</h3>
<p>
This method allows you to change the polling interval from the default
interval (2.5 seconds), or to turn file watching off. On Linux systems with
-inotify, this interval is ignored.
+inotify, and in node.js versions 0.6 and above, this interval is ignored.
</p>
</div>
@@ -1354,7 +1356,7 @@ <h3 id="methods">Methods</h3>
<div id="ft">
<hr />
Released on <a href="https://github.com/lorenwest/node-config">github</a> under the <a href="https://github.com/lorenwest/node-config/blob/master/LICENSE">Apache License 2.0</a>
-<span class="subtitle">version 0.4.11</span>
+<span class="subtitle">version 0.4.13</span>
</div>
</div>
<script type="text/javascript">
View
10 doc/ConfigTest.html
@@ -4,11 +4,11 @@
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>test ConfigTest </title>
- <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1329362514.09" />
- <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1329362514.09" />
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1335400935.57" />
+ <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1335400935.57" />
- <script type="text/javascript" src="assets/api-js?stamp=1329362514.09"></script>
- <script type="text/javascript" src="assets/ac-js?stamp=1329362514.09"></script>
+ <script type="text/javascript" src="assets/api-js?stamp=1335400935.57"></script>
+ <script type="text/javascript" src="assets/ac-js?stamp=1335400935.57"></script>
</head>
<body id="node-monitor">
@@ -120,7 +120,7 @@
<div id="ft">
<hr />
Released on <a href="https://github.com/lorenwest/node-config">github</a> under the <a href="https://github.com/lorenwest/node-config/blob/master/LICENSE">Apache License 2.0</a>
-<span class="subtitle">version 0.4.11</span>
+<span class="subtitle">version 0.4.13</span>
</div>
</div>
<script type="text/javascript">
View
10 doc/ProtectedTest.html
@@ -4,11 +4,11 @@
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>test ProtectedTest </title>
- <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1329362514.09" />
- <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1329362514.09" />
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1335400935.57" />
+ <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1335400935.57" />
- <script type="text/javascript" src="assets/api-js?stamp=1329362514.09"></script>
- <script type="text/javascript" src="assets/ac-js?stamp=1329362514.09"></script>
+ <script type="text/javascript" src="assets/api-js?stamp=1335400935.57"></script>
+ <script type="text/javascript" src="assets/ac-js?stamp=1335400935.57"></script>
</head>
<body id="node-monitor">
@@ -120,7 +120,7 @@
<div id="ft">
<hr />
Released on <a href="https://github.com/lorenwest/node-config">github</a> under the <a href="https://github.com/lorenwest/node-config/blob/master/LICENSE">Apache License 2.0</a>
-<span class="subtitle">version 0.4.11</span>
+<span class="subtitle">version 0.4.13</span>
</div>
</div>
<script type="text/javascript">
View
99 doc/config.js.html
@@ -4,11 +4,11 @@
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>config config.js </title>
- <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1329362514.15" />
- <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1329362514.15" />
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1335400935.6" />
+ <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1335400935.6" />
- <script type="text/javascript" src="assets/api-js?stamp=1329362514.15"></script>
- <script type="text/javascript" src="assets/ac-js?stamp=1329362514.15"></script>
+ <script type="text/javascript" src="assets/api-js?stamp=1335400935.6"></script>
+ <script type="text/javascript" src="assets/ac-js?stamp=1335400935.6"></script>
</head>
<body id="node-monitor">
@@ -46,20 +46,22 @@
<style>
#doc3 .classopts { display:none; }
</style>
-<div class="highlight"><pre><span class="c1">// Dependencies</span>
-<span class="kd">var</span> <span class="nx">Yaml</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;yaml&#39;</span><span class="p">),</span>
- <span class="nx">Coffee</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;coffee-script&#39;</span><span class="p">),</span>
+<div class="highlight"><pre><span class="cm">/*jsl:declare global */</span>
+<span class="c1">// Dependencies</span>
+<span class="kd">var</span> <span class="nx">Yaml</span> <span class="o">=</span> <span class="kc">null</span><span class="p">,</span> <span class="c1">// External libraries are lazy-loaded</span>
+ <span class="nx">Coffee</span> <span class="o">=</span> <span class="kc">null</span><span class="p">,</span> <span class="c1">// only if these file types exist.</span>
<span class="nx">FileSystem</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;fs&#39;</span><span class="p">);</span>
<span class="c1">// Static members</span>
<span class="kd">var</span> <span class="nx">DEFAULT_CLONE_DEPTH</span> <span class="o">=</span> <span class="mi">6</span><span class="p">,</span>
- <span class="nx">FILE_WATCHER_INTERVAL</span> <span class="o">=</span> <span class="mi">2500</span><span class="p">,</span>
+ <span class="nx">FILE_WATCHER_INTERVAL</span> <span class="o">=</span> <span class="mi">2500</span><span class="p">,</span> <span class="c1">// For old style (pre-6.0) file watching</span>
<span class="nx">DIR</span> <span class="o">=</span> <span class="s1">&#39;NODE_CONFIG_DIR&#39;</span><span class="p">,</span>
<span class="nx">CONFIG_DIR</span> <span class="o">=</span> <span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">[</span><span class="nx">DIR</span><span class="p">]</span> <span class="o">?</span> <span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">[</span><span class="nx">DIR</span><span class="p">]</span> <span class="o">:</span> <span class="nx">process</span><span class="p">.</span><span class="nx">cwd</span><span class="p">()</span> <span class="o">+</span> <span class="s1">&#39;/config&#39;</span><span class="p">,</span>
<span class="nx">runtimeJsonFilename</span> <span class="o">=</span> <span class="nx">CONFIG_DIR</span> <span class="o">+</span> <span class="s1">&#39;/runtime.json&#39;</span><span class="p">,</span>
- <span class="nx">originalConfig</span> <span class="o">=</span> <span class="kc">null</span><span class="p">,</span> <span class="c1">// Not including the runtime.json values</span>
- <span class="nx">runtimeJson</span> <span class="o">=</span> <span class="p">{},</span> <span class="c1">// Current runtimeJson extensions</span>
- <span class="nx">isQueuedForPersistence</span> <span class="o">=</span> <span class="kc">false</span>
+ <span class="nx">originalConfig</span> <span class="o">=</span> <span class="kc">null</span><span class="p">,</span> <span class="c1">// Not including the runtime.json values</span>
+ <span class="nx">runtimeJson</span> <span class="o">=</span> <span class="p">{},</span> <span class="c1">// Current runtimeJson extensions</span>
+ <span class="nx">runtimeJsonWatcher</span> <span class="o">=</span> <span class="kc">null</span><span class="p">,</span> <span class="c1">// Filesystem watcher for runtime.json</span>
+ <span class="nx">isQueuedForPersistence</span> <span class="o">=</span> <span class="kc">false</span><span class="p">;</span>
<span class="cm">/**</span>
<span class="cm"> * &lt;p&gt;Runtime Application Configurations&lt;/p&gt;</span>
@@ -457,7 +459,7 @@
<span class="cm"> * &lt;p&gt;</span>
<span class="cm"> * This method allows you to change the polling interval from the default</span>
<span class="cm"> * interval (2.5 seconds), or to turn file watching off. On Linux systems with</span>
-<span class="cm"> * inotify, this interval is ignored.</span>
+<span class="cm"> * inotify, and in node.js versions 0.6 and above, this interval is ignored.</span>
<span class="cm"> * &lt;/p&gt;</span>
<span class="cm"> *</span>
<span class="cm"> * @method watchForConfigFileChanges</span>
@@ -467,20 +469,20 @@
<span class="c1">// Turn off any prior watching</span>
<span class="kd">var</span> <span class="nx">t</span> <span class="o">=</span> <span class="k">this</span><span class="p">,</span> <span class="nx">watchInterval</span> <span class="o">=</span> <span class="nx">interval</span> <span class="o">||</span> <span class="nx">FILE_WATCHER_INTERVAL</span><span class="p">;</span>
- <span class="nx">FileSystem</span><span class="p">.</span><span class="nx">unwatchFile</span><span class="p">(</span><span class="nx">runtimeJsonFilename</span><span class="p">);</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nx">FileSystem</span><span class="p">.</span><span class="nx">watch</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nx">runtimeJsonWatcher</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nx">runtimeJsonWatcher</span><span class="p">.</span><span class="nx">close</span><span class="p">();</span>
+ <span class="nx">runtimeJsonWatcher</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
+ <span class="p">}</span>
+ <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
+ <span class="nx">FileSystem</span><span class="p">.</span><span class="nx">unwatchFile</span><span class="p">(</span><span class="nx">runtimeJsonFilename</span><span class="p">);</span>
+ <span class="p">}</span>
<span class="c1">// If interval is zero, don&#39;t attach a new watcher</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">interval</span> <span class="o">===</span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span><span class="k">return</span><span class="p">;}</span>
- <span class="c1">// Attach a new watcher</span>
- <span class="nx">FileSystem</span><span class="p">.</span><span class="nx">watchFile</span><span class="p">(</span><span class="nx">runtimeJsonFilename</span><span class="p">,</span> <span class="p">{</span><span class="nx">persistent</span><span class="o">:</span><span class="kc">false</span><span class="p">,</span> <span class="nx">interval</span><span class="o">:</span><span class="nx">watchInterval</span><span class="p">},</span> <span class="kd">function</span><span class="p">(</span><span class="nx">curr</span><span class="p">,</span> <span class="nx">prev</span><span class="p">)</span> <span class="p">{</span>
-
- <span class="c1">// no-op if the file hasn&#39;t changed</span>
- <span class="k">if</span> <span class="p">(</span><span class="nx">curr</span><span class="p">.</span><span class="nx">mtime</span><span class="p">.</span><span class="nx">getTime</span><span class="p">()</span> <span class="o">===</span> <span class="nx">prev</span><span class="p">.</span><span class="nx">mtime</span><span class="p">.</span><span class="nx">getTime</span><span class="p">())</span> <span class="p">{</span>
- <span class="k">return</span><span class="p">;</span>
- <span class="p">}</span>
-
- <span class="c1">// Load the runtime.json file asynchronously.</span>
+ <span class="c1">// Re-merge the runtime JSON file if we notice a change</span>
+ <span class="kd">var</span> <span class="nx">onFileChange</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="nx">FileSystem</span><span class="p">.</span><span class="nx">readFile</span><span class="p">(</span><span class="nx">runtimeJsonFilename</span><span class="p">,</span> <span class="s1">&#39;UTF-8&#39;</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">fileContent</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// Not much to do on error</span>
@@ -498,9 +500,25 @@
<span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s2">&quot;Error parsing &quot;</span> <span class="o">+</span> <span class="nx">runtimeJsonFilename</span><span class="p">,</span> <span class="nx">e</span><span class="p">);</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
-
<span class="p">});</span>
- <span class="p">});</span>
+ <span class="p">};</span>
+
+ <span class="c1">// Use the latest version of file watching</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nx">FileSystem</span><span class="p">.</span><span class="nx">watch</span><span class="p">)</span> <span class="p">{</span>
+ <span class="c1">// This is the latest</span>
+ <span class="nx">runtimeJsonWatcher</span> <span class="o">=</span> <span class="nx">FileSystem</span><span class="p">.</span><span class="nx">watch</span><span class="p">(</span><span class="nx">runtimeJsonFilename</span><span class="p">,</span> <span class="p">{</span><span class="nx">persistent</span><span class="o">:</span><span class="kc">false</span><span class="p">},</span> <span class="kd">function</span><span class="p">(</span><span class="nx">event</span><span class="p">,</span> <span class="nx">filename</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nx">event</span> <span class="o">!=</span> <span class="s1">&#39;change&#39;</span><span class="p">)</span> <span class="p">{</span><span class="k">return</span><span class="p">;}</span>
+ <span class="nx">onFileChange</span><span class="p">();</span>
+ <span class="p">});</span>
+ <span class="p">}</span>
+ <span class="k">else</span> <span class="p">{</span>
+ <span class="c1">// Old style polling - only choice if running pre-6.0</span>
+ <span class="nx">FileSystem</span><span class="p">.</span><span class="nx">watchFile</span><span class="p">(</span><span class="nx">runtimeJsonFilename</span><span class="p">,</span> <span class="p">{</span><span class="nx">persistent</span><span class="o">:</span><span class="kc">false</span><span class="p">,</span> <span class="nx">interval</span><span class="o">:</span><span class="nx">watchInterval</span><span class="p">},</span> <span class="kd">function</span><span class="p">(</span><span class="nx">curr</span><span class="p">,</span> <span class="nx">prev</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nx">curr</span><span class="p">.</span><span class="nx">mtime</span><span class="p">.</span><span class="nx">getTime</span><span class="p">()</span> <span class="o">===</span> <span class="nx">prev</span><span class="p">.</span><span class="nx">mtime</span><span class="p">.</span><span class="nx">getTime</span><span class="p">())</span> <span class="p">{</span><span class="k">return</span><span class="p">;}</span>
+ <span class="nx">onFileChange</span><span class="p">();</span>
+ <span class="p">});</span>
+ <span class="p">}</span>
+
<span class="p">};</span>
<span class="cm">/**</span>
@@ -536,7 +554,7 @@
<span class="k">if</span> <span class="p">(</span><span class="nx">error</span><span class="p">)</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s2">&quot;Error writing &quot;</span> <span class="o">+</span> <span class="nx">runtimeJsonFilename</span><span class="p">,</span> <span class="nx">error</span><span class="p">);</span>
<span class="p">});</span>
- <span class="p">};</span>
+ <span class="p">}</span>
<span class="c1">// Set up for next time</span>
<span class="nx">isQueuedForPersistence</span> <span class="o">=</span> <span class="kc">false</span><span class="p">;</span>
@@ -649,9 +667,11 @@
<span class="cm"> * .coffee = File to run that has a module.exports with coffee-script containing the config object</span>
<span class="cm"> * .yaml = Parsed with a YAML parser</span>
<span class="cm"> *</span>
-<span class="cm"> * If the file doesn&#39;t exist, a null will be returned.</span>
+<span class="cm"> * If the file doesn&#39;t exist, a null will be returned. If the file can&#39;t be</span>
+<span class="cm"> * parsed, an exception will be thrown.</span>
<span class="cm"> *</span>
-<span class="cm"> * If the file can&#39;t be parsed, an exception will be thrown.</span>
+<span class="cm"> * This method performs synchronous file operations, and should not be called</span>
+<span class="cm"> * after synchronous module loading.</span>
<span class="cm"> *</span>
<span class="cm"> * @protected</span>
<span class="cm"> * @method _parseFile</span>
@@ -666,17 +686,26 @@
<span class="nx">configObject</span> <span class="o">=</span> <span class="kc">null</span><span class="p">,</span>
<span class="nx">fileContent</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
+ <span class="c1">// Make sure the runtime.json file exists. This is required for fs.watch().</span>
+ <span class="kd">var</span> <span class="nx">checkRuntimeJson</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nx">fullFilename</span> <span class="o">==</span> <span class="nx">runtimeJsonFilename</span><span class="p">)</span> <span class="p">{</span>
+<span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">&quot;Writing runtime json file&quot;</span><span class="p">);</span>
+ <span class="nx">FileSystem</span><span class="p">.</span><span class="nx">writeFileSync</span><span class="p">(</span><span class="nx">runtimeJsonFilename</span><span class="p">,</span> <span class="s1">&#39;{}&#39;</span><span class="p">);</span>
+ <span class="k">return</span> <span class="p">{};</span>
+ <span class="p">}</span>
+ <span class="k">return</span> <span class="kc">null</span><span class="p">;</span>
+ <span class="p">};</span>
+
<span class="c1">// Return null if the file doesn&#39;t exist.</span>
- <span class="c1">// Note that all methods here are the Sync versions. This allows the</span>
- <span class="c1">// config package to follow the same calling semantics as require(&#39;filename&#39;)</span>
- <span class="c1">// which is also synchronous.</span>
+ <span class="c1">// Note that all methods here are the Sync versions. This is appropriate during</span>
+ <span class="c1">// module loading (which is a synchronous operation), but not thereafter.</span>
<span class="k">try</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">stat</span> <span class="o">=</span> <span class="nx">FileSystem</span><span class="p">.</span><span class="nx">statSync</span><span class="p">(</span><span class="nx">fullFilename</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">stat</span> <span class="o">||</span> <span class="nx">stat</span><span class="p">.</span><span class="nx">size</span> <span class="o">&lt;</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
- <span class="k">return</span> <span class="kc">null</span><span class="p">;</span>
+ <span class="k">return</span> <span class="nx">checkRuntimeJson</span><span class="p">();</span>
<span class="p">}</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e1</span><span class="p">)</span> <span class="p">{</span>
- <span class="k">return</span> <span class="kc">null</span><span class="p">;</span>
+ <span class="k">return</span> <span class="nx">checkRuntimeJson</span><span class="p">();</span>
<span class="p">}</span>
<span class="c1">// Try loading the file.</span>
@@ -690,6 +719,8 @@
<span class="c1">// Parse the file based on extension</span>
<span class="k">try</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">extension</span> <span class="o">==</span> <span class="s1">&#39;yaml&#39;</span><span class="p">)</span> <span class="p">{</span>
+ <span class="c1">// Lazy loading</span>
+ <span class="nx">Yaml</span> <span class="o">=</span> <span class="nx">Yaml</span> <span class="o">||</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;yaml&#39;</span><span class="p">);</span>
<span class="c1">// The yaml library doesn&#39;t like strings that have newlines but don&#39;t</span>
<span class="c1">// end in a newline: https://github.com/visionmedia/js-yaml/issues/issue/13</span>
<span class="nx">fileContent</span> <span class="o">+=</span> <span class="s1">&#39;\n&#39;</span><span class="p">;</span>
@@ -704,6 +735,8 @@
<span class="nx">configObject</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="nx">fullFilename</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="nx">extension</span> <span class="o">==</span> <span class="s1">&#39;coffee&#39;</span><span class="p">)</span> <span class="p">{</span>
+ <span class="c1">// Lazy load the coffee-script extension</span>
+ <span class="nx">Coffee</span> <span class="o">=</span> <span class="nx">Coffee</span> <span class="o">||</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;coffee-script&#39;</span><span class="p">);</span>
<span class="c1">// Use the built-in parser for .coffee files with coffee-script</span>
<span class="nx">configObject</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="nx">fullFilename</span><span class="p">);</span>
<span class="p">}</span>
@@ -1110,7 +1143,7 @@
<div id="ft">
<hr />
Released on <a href="https://github.com/lorenwest/node-config">github</a> under the <a href="https://github.com/lorenwest/node-config/blob/master/LICENSE">Apache License 2.0</a>
-<span class="subtitle">version 0.4.11</span>
+<span class="subtitle">version 0.4.13</span>
</div>
</div>
<script type="text/javascript">
View
10 doc/default.js.html
@@ -4,11 +4,11 @@
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>test default.js </title>
- <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1329362514.09" />
- <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1329362514.09" />
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1335400935.57" />
+ <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1335400935.57" />
- <script type="text/javascript" src="assets/api-js?stamp=1329362514.09"></script>
- <script type="text/javascript" src="assets/ac-js?stamp=1329362514.09"></script>
+ <script type="text/javascript" src="assets/api-js?stamp=1335400935.57"></script>
+ <script type="text/javascript" src="assets/ac-js?stamp=1335400935.57"></script>
</head>
<body id="node-monitor">
@@ -98,7 +98,7 @@
<div id="ft">
<hr />
Released on <a href="https://github.com/lorenwest/node-config">github</a> under the <a href="https://github.com/lorenwest/node-config/blob/master/LICENSE">Apache License 2.0</a>
-<span class="subtitle">version 0.4.11</span>
+<span class="subtitle">version 0.4.13</span>
</div>
</div>
<script type="text/javascript">
View
20 doc/index.html
@@ -4,11 +4,11 @@
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title> </title>
- <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1329362514.21" />
- <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1329362514.21" />
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1335400935.63" />
+ <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1335400935.63" />
- <script type="text/javascript" src="assets/api-js?stamp=1329362514.21"></script>
- <script type="text/javascript" src="assets/ac-js?stamp=1329362514.21"></script>
+ <script type="text/javascript" src="assets/api-js?stamp=1335400935.63"></script>
+ <script type="text/javascript" src="assets/ac-js?stamp=1335400935.63"></script>
</head>
<body id="node-monitor">
@@ -86,6 +86,9 @@
</pre>
<p>
Where EXT can be .yaml, .coffee, .json, or .js depending on the format you prefer.
+ NOTE: If you use .yaml or .coffee file extensions, the 'yaml' or 'coffee-script'
+ modules must be available. These external dependencies are not included from
+ this package.
</p>
<p>
<i>hostname</i> is the $HOST environment variable if set, otherwise the
@@ -210,12 +213,11 @@
<p>
If configuration values change at runtime, these changes are persisted
into the runtime.json file within the config directory. Multi-node
- application instances can keep in synch by calling the
- <a href="Config.html#method_watchForConfigFileChanges">watchForConfigFileChanges</a>
- method at startup.
+ application instances keep in synch by watching for and loading changes
+ in this file when detected.
</p>
<p>
- This paradigm does not currently extend beyond a single machine.
+ This paradigm does not extend beyond a single machine.
</p>
<h2>For Module Developers</h2>
@@ -286,7 +288,7 @@
<div id="ft">
<hr />
Released on <a href="https://github.com/lorenwest/node-config">github</a> under the <a href="https://github.com/lorenwest/node-config/blob/master/LICENSE">Apache License 2.0</a>
-<span class="subtitle">version 0.4.11</span>
+<span class="subtitle">version 0.4.13</span>
</div>
</div>
<script type="text/javascript">
View
10 doc/module_config.html
@@ -4,11 +4,11 @@
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>config </title>
- <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1329362514.15" />
- <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1329362514.15" />
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1335400935.6" />
+ <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1335400935.6" />
- <script type="text/javascript" src="assets/api-js?stamp=1329362514.15"></script>
- <script type="text/javascript" src="assets/ac-js?stamp=1329362514.15"></script>
+ <script type="text/javascript" src="assets/api-js?stamp=1335400935.6"></script>
+ <script type="text/javascript" src="assets/ac-js?stamp=1335400935.6"></script>
</head>
<body id="node-monitor">
@@ -141,7 +141,7 @@
<div id="ft">
<hr />
Released on <a href="https://github.com/lorenwest/node-config">github</a> under the <a href="https://github.com/lorenwest/node-config/blob/master/LICENSE">Apache License 2.0</a>
-<span class="subtitle">version 0.4.11</span>
+<span class="subtitle">version 0.4.13</span>
</div>
</div>
<script type="text/javascript">
View
10 doc/module_test.html
@@ -4,11 +4,11 @@
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>test </title>
- <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1329362514.09" />
- <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1329362514.09" />
+ <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css?stamp=1335400935.57" />
+ <link rel="stylesheet" type="text/css" href="assets/api.css?stamp=1335400935.57" />
- <script type="text/javascript" src="assets/api-js?stamp=1329362514.09"></script>
- <script type="text/javascript" src="assets/ac-js?stamp=1329362514.09"></script>
+ <script type="text/javascript" src="assets/api-js?stamp=1335400935.57"></script>
+ <script type="text/javascript" src="assets/ac-js?stamp=1335400935.57"></script>
</head>
<body id="node-monitor">
@@ -113,7 +113,7 @@
<div id="ft">
<hr />
Released on <a href="https://github.com/lorenwest/node-config">github</a> under the <a href="https://github.com/lorenwest/node-config/blob/master/LICENSE">Apache License 2.0</a>
-<span class="subtitle">version 0.4.11</span>
+<span class="subtitle">version 0.4.13</span>
</div>
</div>
<script type="text/javascript">
View
2  doc/raw.json
@@ -1 +1 @@
-{"majorversion": 3, "classmap": {"ConfigTest": {"name": "ConfigTest", "namespace": "", "module": "test", "guessedname": "ConfigTest", "file": "2-config-test.js", "guessedtype": "property", "shortname": "ConfigTest", "description": "<p>Unit tests for the node-config library. To run type:</p>\n<pre>npm test config</pre>"}, "Config": {"name": "Config", "namespace": "", "module": "config", "methods": {"watchForConfigFileChanges": {"params": [{"type": "Integer", "name": "interval", "description": " - Polling interval in milliseconds. Defaults to 2500."}], "description": "Change the runtime.json file watching polling interval.\n<p>\nNode-config automatically monitors and apply changes made to the\nconfig/runtime.json file. This paradigm allows for manual changes to running\napplication servers, and for multi-node application servers to keep in sync.\n</p>\n<p>\nThis method allows you to change the polling interval from the default\ninterval (2.5 seconds), or to turn file watching off. On Linux systems with\ninotify, this interval is ignored.\n</p>", "guessedname": "watchForConfigFileChanges", "guessedtype": "function"}, "_attachProtoDeep": {"return": {"type": "", "description": "toObject"}, "description": "Attach the Config class prototype to all config objects recursively.\n<p>\nThis allows you to do anything with CONFIG sub-objects as you can do with\nthe top-level CONFIG object. It's so you can do this:\n</p>\n<pre>\nvar CUST_CONFIG = require('config').Customer;\nCUST_CONFIG.watch(...)\n</pre>", "protected": "", "params": [{"type": "", "name": "toObject", "description": ""}, {"type": "", "name": "depth", "description": ""}], "guessedname": "_attachProtoDeep", "guessedtype": "function"}, "_persistConfigsOnChange": {"protected": "", "params": [{"type": "object", "name": "object", "description": " - The config object to watch"}], "description": "<p>\nWatch the specified object for a change in properties, and persist changes\nto runtime.json when a change is detected.\n</p>", "guessedname": "_persistConfigsOnChange", "guessedtype": "function"}, "setModuleDefaults": {"return": {"type": "object", "description": "moduleConfig - The module level configuration object."}, "params": [{"type": "string", "name": "moduleName", "description": " - Name of your module."}, {"type": "object", "name": "defaultProperties", "description": " - The default module configuration."}], "description": "<p>\nSet default configurations for a node.js module.\n</p>\n<p>\nThis allows module developers to attach their configurations onto the\ndefault configuration object so they can be configured by the consumers\nof the module.\n</p>\n<p>Using the function within your module:</p>\n<pre>\nvar CONFIG = require(\"config\");\nCONFIG.setModuleDefaults(\"MyModule\", {\n&nbsp;&nbsp;templateName: \"t-50\",\n&nbsp;&nbsp;colorScheme: \"green\"\n});\n<br>\n// Template name may be overridden by application config files\nconsole.log(\"Template: \" + CONFIG.MyModule.templateName);\n</pre>\n<p>\nThe above example results in a \"MyModule\" element of the configuration\nobject, containing an object with the specified default values.\n</p>", "guessedname": "setModuleDefaults", "guessedtype": "function"}, "watch": {"return": {"type": "object", "description": "object - The original object is returned - for chaining."}, "params": [{"type": "object", "name": "object", "description": " - The object to watch."}, {"type": "string", "name": "property", "description": " - The property name to watch. Watch all object properties if null."}, {"type": "function(object, propertyName, priorValue, newValue)", "name": "handler", "description": " - Handler called when a property change is detected.\nThe handler is run along with other handlers registered for notification.\nIf your handler changes the value of the property, that change is applied after all handlers have finished processing the current change.\nThen all handlers (including this one) will be called again with the newly changed value."}, {"type": "integer", "name": "depth", "description": " (optional) - If watching all object properties or if the specified property is an object, this specifies the depth of the object graph to watch for changes. Default 6."}], "description": "<p>Monitor a configuration value for runtime changes.</p>\n<p>\nConfiguration values can be changed at runtime by the application or by a\nmanual change to the config/runtime.json file.\nThis method lets you specify a function to run when a configuration\nvalue changes.\n</p>\n<p><i>\nThis was built for monitoring changes to configuration values,\nbut it can be used for watching changes to <u>any</u> javascript object.\n</i></p>\n<p>Example:</p>\n<pre>\nvar CONFIG = require('config').customer;\n...\n// Watch for any changes to the customer configuration\nCONFIG.watch(CONFIG, null, function(object, propertyName, priorValue, newValue) {\n&nbsp;console.log(\"Customer configuration \" + propertyName + \" changed from \" + priorValue + \" to \" + newValue);\n});\n</pre>", "guessedname": "watch", "guessedtype": "function"}, "_stripComments": {"return": {"type": "string", "description": "The string with comments stripped."}, "description": "Strip all Javascript type comments from the string.\nThe string is usually a file loaded from the O/S, containing\nnewlines and javascript type comments.\nThanks to James Padolsey, and all who conributed to this implementation.\nhttp://james.padolsey.com/javascript/javascript-comment-removal-revisted/", "protected": "", "params": [{"type": "string", "name": "fileString", "description": " The string to strip comments from"}], "guessedname": "_stripComments", "guessedtype": "function"}, "makeHidden": {"return": {"type": "object", "description": "object - The original object is returned - for chaining."}, "params": [{"type": "object", "name": "object", "description": " - The object to make a hidden property into."}, {"type": "string", "name": "property", "description": " - The name of the property to make hidden."}, {"type": "mixed", "name": "value", "description": " - (optional) Set the property value to this (otherwise leave alone)"}], "description": "<p>Make a configuration property hidden so it doesn't appear when enumerating\nelements of the object.</p>\n<p>\nThe property still exists and can be read from and written to, but it won't\nshow up in for ... in loops, Object.keys(), or JSON.stringify() type methods.\n</p>\n<p>\nIf the property already exists, it will be made hidden. Otherwise it will\nbe created as a hidden property with the specified value.\n</p>\n<p><i>\nThis method was built for hiding configuration values, but it can be applied\nto <u>any</u> javascript object.\n</i></p>\n<p>Example:</p>\n<pre>\nvar CONFIG = require('config');\n...\n// Hide the Amazon S3 credentials\nCONFIG.makeHidden(CONFIG.amazonS3, 'access_id');\nCONFIG.makeHidden(CONFIG.amazonS3, 'secret_key');\n</pre>", "guessedname": "makeHidden", "guessedtype": "function"}, "_equalsDeep": {"return": {"type": "boolean", "description": "True if both objects have equivalent contents"}, "description": "Return true if two objects have equal contents.", "protected": "", "params": [{"type": "object", "name": "object1", "description": " The object to compare from"}, {"type": "object", "name": "object2", "description": " The object to compare with"}, {"type": "integer", "name": "depth", "description": " An optional depth to prevent recursion. Default: 20."}], "guessedname": "_equalsDeep", "guessedtype": "function"}, "_stripYamlComments": {"return": {"type": "string", "description": "The string with comments stripped."}, "description": "Strip YAML comments from the string\nThe 2.0 yaml parser doesn't allow comment-only or blank lines. Strip them.", "protected": "", "params": [{"type": "string", "name": "fileString", "description": " The string to strip comments from"}], "guessedname": "_stripYamlComments", "guessedtype": "function"}, "makeImmutable": {"return": {"type": "object", "description": "object - The original object is returned - for chaining."}, "params": [{"type": "object", "name": "object", "description": " - The object to attach an immutable property into."}, {"type": "string", "name": "property", "description": " - The name of the property to make immutable."}, {"type": "mixed", "name": "value", "description": " - (optional) Set the property value to this (otherwise leave alone)"}], "description": "<p>Make a configuration property immutable (assuring it cannot be changed\nfrom the current value).</p>\n<p>\nThis operation cannot be un-done.\n</p>\n<p><i>\nThis method was built for disabling runtime changes to configuration values,\nbut it can be applied to <u>any</u> javascript object.\n</i></p>\n<p>Example:</p>\n<pre>\nvar CONFIG = require('config').customer;\n...\n// Obtain a DB connection using CONFIG parameters\ndatabase.open(CONFIG.db.name, CONFIG.db.port);\n...\n// Don't allow database changes after connect\nCONFIG.makeImmutable(CONFIG.db, 'name');\nCONFIG.makeImmutable(CONFIG.db, 'port');\n</pre>", "guessedname": "makeImmutable", "guessedtype": "function"}, "_cloneDeep": {"return": {"type": "object", "description": "A new object with the elements copied from the copyFrom object"}, "description": "Return a deep copy of the specified object.\nThis returns a new object with all elements copied from the specified\nobject. Deep copies are made of objects and arrays so you can do anything\nwith the returned object without affecting the input object.", "protected": "", "params": [{"type": "object", "name": "copyFrom", "description": " The original object to copy from"}, {"type": "integer", "name": "depth", "description": " An optional depth to prevent recursion. Default: 20."}], "guessedname": "_cloneDeep", "guessedtype": "function"}, "_loadFileConfigs": {"protected": "", "return": {"type": "this", "description": "The configuration object"}, "description": "Load the individual file configurations.\n<p>\nThis method builds a map of filename to the configuration object defined\nby the file. The search order is:\n</p>\n<pre>\ndefault.EXT\n(hostname).EXT\n(deployment).EXT\n(hostname)-(deployment).EXT\nruntime.json\n</pre>\n<p>\nEXT can be yaml, coffee, json, or js signifying the file type.\nyaml is in YAML format, coffee is a coffee-script,\njson is in strict JSON format, and js is a javascript executable file that is\nrequire()'d with module.exports being the config object.\n</p>\n<p>\n(hostname) is the $HOST environment variable if set, otherwise the\nhostname found from require('os').hostname()\n</p>\n<p>\n(deployment) is the deployment type, found in the $NODE_ENV environment\nvariable. Defaults to 'development'.\n</p>\n<p>\nThe runtime.json file contains configuration changes made at runtime either\nmanually, or by the application setting a configuration value.\n</p>", "guessedname": "_loadFileConfigs", "guessedtype": "function"}, "constructor": {"return": {"type": "object", "description": "CONFIG - The top level configuration object"}, "description": "<p>Get the configuration object.</p>\n<p>\nThe configuration object is a shared singleton object within the applicaiton,\nattained by calling require('config').\n</p>\n<p>\nUsually you'll specify a CONFIG variable at the top of your .js file\nfor file/module scope. If you want the root of the object, you can do this:\n</p>\n<pre>\nvar CONFIG = require('config');\n</pre>\n<p>\nSometimes you only care about a specific sub-object within the CONFIG\nobject. In that case you could do this at the top of your file:\n</p>\n<pre>\nvar CONFIG = require('config').customer;\nor\nvar CUSTOMER_CONFIG = require('config').customer;\n</pre>\n<script type=\"text/javascript\">\ndocument.getElementById(\"showProtected\").style.display = \"block\";\n</script>", "guessedname": "Config", "guessedtype": "function"}, "_diffDeep": {"return": {"type": "object", "description": "A differential object, which if extended onto object1 would\nresult in object2."}, "description": "Returns an object containing all elements that differ between two objects.\n<p>\nThis method was designed to be used to create the runtime.json file\ncontents, but can be used to get the diffs between any two Javascript objects.\n</p>\n<p>\nIt works best when object2 originated by deep copying object1, then\nchanges were made to object2, and you want an object that would give you\nthe changes made to object1 which resulted in object2.\n</p>", "protected": "", "params": [{"type": "object", "name": "object1", "description": " The base object to compare to"}, {"type": "object", "name": "object2", "description": " The object to compare with"}, {"type": "integer", "name": "depth", "description": " An optional depth to prevent recursion. Default: 20."}], "guessedname": "_diffDeep", "guessedtype": "function"}, "_isObject": {"return": {"type": "boolean", "description": "TRUE if the arg is an object, FALSE if not"}, "description": "Is the specified argument a regular javascript object?\nThe argument is an object if it's a JS object, but not an array.", "protected": "", "params": [{"type": "MIXED", "name": "arg", "description": " An argument of any type."}], "guessedname": "_isObject", "guessedtype": "function"}, "_parseFile": {"return": {"type": "configObject", "description": "The configuration object parsed from the file"}, "description": "Parse and return the specified configuration file.\nIf the file exists in the application config directory, it will\nparse and return it as a JavaScript object.\nThe file extension determines the parser to use.\n.js = File to run that has a module.exports containing the config object\n.json = File is parsed using JSON.parse()\n.coffee = File to run that has a module.exports with coffee-script containing the config object\n.yaml = Parsed with a YAML parser\nIf the file doesn't exist, a null will be returned.\nIf the file can't be parsed, an exception will be thrown.", "protected": "", "params": [{"type": "string", "name": "fullFilename", "description": " The full file path and name"}], "guessedname": "_parseFile", "guessedtype": "function"}, "_extendDeep": {"return": {"type": "object", "description": "The altered mergeInto object is returned"}, "description": "Extend an object, and any object it contains.\nThis does not replace deep objects, but dives into them\nreplacing individual elements instead.", "protected": "", "params": [{"type": "object", "name": "mergeInto", "description": " The object to merge into"}, {"type": "object...", "name": "mergeFrom...", "description": " - Any number of objects to merge from"}, {"type": "integer", "name": "depth", "description": " An optional depth to prevent recursion. Default: 20."}], "guessedname": "_extendDeep", "guessedtype": "function"}}, "file": "config.js", "shortname": "Config", "description": "<p>Runtime Application Configurations</p>\n<p>\nThe config module exports a singleton object representing all runtime\nconfigurations for this application deployment.\n</p>\n<p>\nApplication configurations are stored in files within the config directory\nof your application. The default configuration file is loaded, followed\nby files specific to the deployment type (development, testing, staging,\nproduction, etc.).\n</p>\n<p>\nFor example, with the following config/default.yaml file:\n</p>\n<pre>\n...\ncustomer:\n&nbsp;&nbsp;initialCredit: 500\n&nbsp;&nbsp;db:\n&nbsp;&nbsp;&nbsp;&nbsp;name: customer\n&nbsp;&nbsp;&nbsp;&nbsp;port: 5984\n...\n</pre>\n<p>\nThe following code loads the customer section into the CONFIG variable:\n<p>\n<pre>\nvar CONFIG = require('config').customer;\n...\nnewCustomer.creditLimit = CONFIG.initialCredit;\ndatabase.open(CONFIG.db.name, CONFIG.db.port);\n...\n</pre>"}, "ProtectedTest": {"name": "ProtectedTest", "namespace": "", "module": "test", "guessedname": "PrivateTest", "file": "1-protected-test.js", "guessedtype": "property", "shortname": "ProtectedTest", "description": "<p>Tests for underlying node-config utilities. To run type:</p>\n<pre>npm test config</pre>"}}, "version": "0.4.11", "modules": {"test": {"description": "<p>Unit tests</p>", "submodules": [], "classlist": ["ProtectedTest", "ConfigTest"], "filelist": ["1-protected-test.js", "2-config-test.js", "default.js"], "subdata": {}, "name": "test"}, "config": {"description": "<p>Runtime Application Configurations</p>\n<p>\nThe config module exports a singleton object representing all runtime\nconfigurations for this application deployment.\n</p>\n<p>\nApplication configurations are stored in files within the config directory\nof your application. The default configuration file is loaded, followed\nby files specific to the deployment type (development, testing, staging,\nproduction, etc.).\n</p>\n<p>\nFor example, with the following config/default.yaml file:\n</p>\n<pre>\n...\ncustomer:\n&nbsp;&nbsp;initialCredit: 500\n&nbsp;&nbsp;db:\n&nbsp;&nbsp;&nbsp;&nbsp;name: customer\n&nbsp;&nbsp;&nbsp;&nbsp;port: 5984\n...\n</pre>\n<p>\nThe following code loads the customer section into the CONFIG variable:\n<p>\n<pre>\nvar CONFIG = require('config').customer;\n...\nnewCustomer.creditLimit = CONFIG.initialCredit;\ndatabase.open(CONFIG.db.name, CONFIG.db.port);\n...\n</pre>", "submodules": [], "classlist": ["Config"], "filelist": ["config.js"], "subdata": {}, "name": "config"}}, "filemap": {"default.js": {"classlist": [], "name": "default.js", "module": "test"}, "2-config-test.js": {"classlist": ["ConfigTest"], "name": "2-config-test.js", "module": "test"}, "config.js": {"classlist": ["Config"], "name": "config.js", "module": "config"}, "1-protected-test.js": {"classlist": ["ProtectedTest"], "name": "1-protected-test.js", "module": "test"}}}
+{"majorversion": 3, "classmap": {"ConfigTest": {"name": "ConfigTest", "namespace": "", "module": "test", "guessedname": "ConfigTest", "file": "2-config-test.js", "guessedtype": "property", "shortname": "ConfigTest", "description": "<p>Unit tests for the node-config library. To run type:</p>\n<pre>npm test config</pre>"}, "Config": {"name": "Config", "namespace": "", "module": "config", "methods": {"watchForConfigFileChanges": {"params": [{"type": "Integer", "name": "interval", "description": " - Polling interval in milliseconds. Defaults to 2500."}], "description": "Change the runtime.json file watching polling interval.\n<p>\nNode-config automatically monitors and apply changes made to the\nconfig/runtime.json file. This paradigm allows for manual changes to running\napplication servers, and for multi-node application servers to keep in sync.\n</p>\n<p>\nThis method allows you to change the polling interval from the default\ninterval (2.5 seconds), or to turn file watching off. On Linux systems with\ninotify, and in node.js versions 0.6 and above, this interval is ignored.\n</p>", "guessedname": "watchForConfigFileChanges", "guessedtype": "function"}, "_attachProtoDeep": {"return": {"type": "", "description": "toObject"}, "description": "Attach the Config class prototype to all config objects recursively.\n<p>\nThis allows you to do anything with CONFIG sub-objects as you can do with\nthe top-level CONFIG object. It's so you can do this:\n</p>\n<pre>\nvar CUST_CONFIG = require('config').Customer;\nCUST_CONFIG.watch(...)\n</pre>", "protected": "", "params": [{"type": "", "name": "toObject", "description": ""}, {"type": "", "name": "depth", "description": ""}], "guessedname": "_attachProtoDeep", "guessedtype": "function"}, "_persistConfigsOnChange": {"protected": "", "params": [{"type": "object", "name": "object", "description": " - The config object to watch"}], "description": "<p>\nWatch the specified object for a change in properties, and persist changes\nto runtime.json when a change is detected.\n</p>", "guessedname": "_persistConfigsOnChange", "guessedtype": "function"}, "setModuleDefaults": {"return": {"type": "object", "description": "moduleConfig - The module level configuration object."}, "params": [{"type": "string", "name": "moduleName", "description": " - Name of your module."}, {"type": "object", "name": "defaultProperties", "description": " - The default module configuration."}], "description": "<p>\nSet default configurations for a node.js module.\n</p>\n<p>\nThis allows module developers to attach their configurations onto the\ndefault configuration object so they can be configured by the consumers\nof the module.\n</p>\n<p>Using the function within your module:</p>\n<pre>\nvar CONFIG = require(\"config\");\nCONFIG.setModuleDefaults(\"MyModule\", {\n&nbsp;&nbsp;templateName: \"t-50\",\n&nbsp;&nbsp;colorScheme: \"green\"\n});\n<br>\n// Template name may be overridden by application config files\nconsole.log(\"Template: \" + CONFIG.MyModule.templateName);\n</pre>\n<p>\nThe above example results in a \"MyModule\" element of the configuration\nobject, containing an object with the specified default values.\n</p>", "guessedname": "setModuleDefaults", "guessedtype": "function"}, "watch": {"return": {"type": "object", "description": "object - The original object is returned - for chaining."}, "params": [{"type": "object", "name": "object", "description": " - The object to watch."}, {"type": "string", "name": "property", "description": " - The property name to watch. Watch all object properties if null."}, {"type": "function(object, propertyName, priorValue, newValue)", "name": "handler", "description": " - Handler called when a property change is detected.\nThe handler is run along with other handlers registered for notification.\nIf your handler changes the value of the property, that change is applied after all handlers have finished processing the current change.\nThen all handlers (including this one) will be called again with the newly changed value."}, {"type": "integer", "name": "depth", "description": " (optional) - If watching all object properties or if the specified property is an object, this specifies the depth of the object graph to watch for changes. Default 6."}], "description": "<p>Monitor a configuration value for runtime changes.</p>\n<p>\nConfiguration values can be changed at runtime by the application or by a\nmanual change to the config/runtime.json file.\nThis method lets you specify a function to run when a configuration\nvalue changes.\n</p>\n<p><i>\nThis was built for monitoring changes to configuration values,\nbut it can be used for watching changes to <u>any</u> javascript object.\n</i></p>\n<p>Example:</p>\n<pre>\nvar CONFIG = require('config').customer;\n...\n// Watch for any changes to the customer configuration\nCONFIG.watch(CONFIG, null, function(object, propertyName, priorValue, newValue) {\n&nbsp;console.log(\"Customer configuration \" + propertyName + \" changed from \" + priorValue + \" to \" + newValue);\n});\n</pre>", "guessedname": "watch", "guessedtype": "function"}, "_stripComments": {"return": {"type": "string", "description": "The string with comments stripped."}, "description": "Strip all Javascript type comments from the string.\nThe string is usually a file loaded from the O/S, containing\nnewlines and javascript type comments.\nThanks to James Padolsey, and all who conributed to this implementation.\nhttp://james.padolsey.com/javascript/javascript-comment-removal-revisted/", "protected": "", "params": [{"type": "string", "name": "fileString", "description": " The string to strip comments from"}], "guessedname": "_stripComments", "guessedtype": "function"}, "makeHidden": {"return": {"type": "object", "description": "object - The original object is returned - for chaining."}, "params": [{"type": "object", "name": "object", "description": " - The object to make a hidden property into."}, {"type": "string", "name": "property", "description": " - The name of the property to make hidden."}, {"type": "mixed", "name": "value", "description": " - (optional) Set the property value to this (otherwise leave alone)"}], "description": "<p>Make a configuration property hidden so it doesn't appear when enumerating\nelements of the object.</p>\n<p>\nThe property still exists and can be read from and written to, but it won't\nshow up in for ... in loops, Object.keys(), or JSON.stringify() type methods.\n</p>\n<p>\nIf the property already exists, it will be made hidden. Otherwise it will\nbe created as a hidden property with the specified value.\n</p>\n<p><i>\nThis method was built for hiding configuration values, but it can be applied\nto <u>any</u> javascript object.\n</i></p>\n<p>Example:</p>\n<pre>\nvar CONFIG = require('config');\n...\n// Hide the Amazon S3 credentials\nCONFIG.makeHidden(CONFIG.amazonS3, 'access_id');\nCONFIG.makeHidden(CONFIG.amazonS3, 'secret_key');\n</pre>", "guessedname": "makeHidden", "guessedtype": "function"}, "_equalsDeep": {"return": {"type": "boolean", "description": "True if both objects have equivalent contents"}, "description": "Return true if two objects have equal contents.", "protected": "", "params": [{"type": "object", "name": "object1", "description": " The object to compare from"}, {"type": "object", "name": "object2", "description": " The object to compare with"}, {"type": "integer", "name": "depth", "description": " An optional depth to prevent recursion. Default: 20."}], "guessedname": "_equalsDeep", "guessedtype": "function"}, "_stripYamlComments": {"return": {"type": "string", "description": "The string with comments stripped."}, "description": "Strip YAML comments from the string\nThe 2.0 yaml parser doesn't allow comment-only or blank lines. Strip them.", "protected": "", "params": [{"type": "string", "name": "fileString", "description": " The string to strip comments from"}], "guessedname": "_stripYamlComments", "guessedtype": "function"}, "makeImmutable": {"return": {"type": "object", "description": "object - The original object is returned - for chaining."}, "params": [{"type": "object", "name": "object", "description": " - The object to attach an immutable property into."}, {"type": "string", "name": "property", "description": " - The name of the property to make immutable."}, {"type": "mixed", "name": "value", "description": " - (optional) Set the property value to this (otherwise leave alone)"}], "description": "<p>Make a configuration property immutable (assuring it cannot be changed\nfrom the current value).</p>\n<p>\nThis operation cannot be un-done.\n</p>\n<p><i>\nThis method was built for disabling runtime changes to configuration values,\nbut it can be applied to <u>any</u> javascript object.\n</i></p>\n<p>Example:</p>\n<pre>\nvar CONFIG = require('config').customer;\n...\n// Obtain a DB connection using CONFIG parameters\ndatabase.open(CONFIG.db.name, CONFIG.db.port);\n...\n// Don't allow database changes after connect\nCONFIG.makeImmutable(CONFIG.db, 'name');\nCONFIG.makeImmutable(CONFIG.db, 'port');\n</pre>", "guessedname": "makeImmutable", "guessedtype": "function"}, "_cloneDeep": {"return": {"type": "object", "description": "A new object with the elements copied from the copyFrom object"}, "description": "Return a deep copy of the specified object.\nThis returns a new object with all elements copied from the specified\nobject. Deep copies are made of objects and arrays so you can do anything\nwith the returned object without affecting the input object.", "protected": "", "params": [{"type": "object", "name": "copyFrom", "description": " The original object to copy from"}, {"type": "integer", "name": "depth", "description": " An optional depth to prevent recursion. Default: 20."}], "guessedname": "_cloneDeep", "guessedtype": "function"}, "_loadFileConfigs": {"protected": "", "return": {"type": "this", "description": "The configuration object"}, "description": "Load the individual file configurations.\n<p>\nThis method builds a map of filename to the configuration object defined\nby the file. The search order is:\n</p>\n<pre>\ndefault.EXT\n(hostname).EXT\n(deployment).EXT\n(hostname)-(deployment).EXT\nruntime.json\n</pre>\n<p>\nEXT can be yaml, coffee, json, or js signifying the file type.\nyaml is in YAML format, coffee is a coffee-script,\njson is in strict JSON format, and js is a javascript executable file that is\nrequire()'d with module.exports being the config object.\n</p>\n<p>\n(hostname) is the $HOST environment variable if set, otherwise the\nhostname found from require('os').hostname()\n</p>\n<p>\n(deployment) is the deployment type, found in the $NODE_ENV environment\nvariable. Defaults to 'development'.\n</p>\n<p>\nThe runtime.json file contains configuration changes made at runtime either\nmanually, or by the application setting a configuration value.\n</p>", "guessedname": "_loadFileConfigs", "guessedtype": "function"}, "constructor": {"return": {"type": "object", "description": "CONFIG - The top level configuration object"}, "description": "<p>Get the configuration object.</p>\n<p>\nThe configuration object is a shared singleton object within the applicaiton,\nattained by calling require('config').\n</p>\n<p>\nUsually you'll specify a CONFIG variable at the top of your .js file\nfor file/module scope. If you want the root of the object, you can do this:\n</p>\n<pre>\nvar CONFIG = require('config');\n</pre>\n<p>\nSometimes you only care about a specific sub-object within the CONFIG\nobject. In that case you could do this at the top of your file:\n</p>\n<pre>\nvar CONFIG = require('config').customer;\nor\nvar CUSTOMER_CONFIG = require('config').customer;\n</pre>\n<script type=\"text/javascript\">\ndocument.getElementById(\"showProtected\").style.display = \"block\";\n</script>", "guessedname": "Config", "guessedtype": "function"}, "_diffDeep": {"return": {"type": "object", "description": "A differential object, which if extended onto object1 would\nresult in object2."}, "description": "Returns an object containing all elements that differ between two objects.\n<p>\nThis method was designed to be used to create the runtime.json file\ncontents, but can be used to get the diffs between any two Javascript objects.\n</p>\n<p>\nIt works best when object2 originated by deep copying object1, then\nchanges were made to object2, and you want an object that would give you\nthe changes made to object1 which resulted in object2.\n</p>", "protected": "", "params": [{"type": "object", "name": "object1", "description": " The base object to compare to"}, {"type": "object", "name": "object2", "description": " The object to compare with"}, {"type": "integer", "name": "depth", "description": " An optional depth to prevent recursion. Default: 20."}], "guessedname": "_diffDeep", "guessedtype": "function"}, "_isObject": {"return": {"type": "boolean", "description": "TRUE if the arg is an object, FALSE if not"}, "description": "Is the specified argument a regular javascript object?\nThe argument is an object if it's a JS object, but not an array.", "protected": "", "params": [{"type": "MIXED", "name": "arg", "description": " An argument of any type."}], "guessedname": "_isObject", "guessedtype": "function"}, "_parseFile": {"return": {"type": "configObject", "description": "The configuration object parsed from the file"}, "description": "Parse and return the specified configuration file.\nIf the file exists in the application config directory, it will\nparse and return it as a JavaScript object.\nThe file extension determines the parser to use.\n.js = File to run that has a module.exports containing the config object\n.json = File is parsed using JSON.parse()\n.coffee = File to run that has a module.exports with coffee-script containing the config object\n.yaml = Parsed with a YAML parser\nIf the file doesn't exist, a null will be returned. If the file can't be\nparsed, an exception will be thrown.\nThis method performs synchronous file operations, and should not be called\nafter synchronous module loading.", "protected": "", "params": [{"type": "string", "name": "fullFilename", "description": " The full file path and name"}], "guessedname": "_parseFile", "guessedtype": "function"}, "_extendDeep": {"return": {"type": "object", "description": "The altered mergeInto object is returned"}, "description": "Extend an object, and any object it contains.\nThis does not replace deep objects, but dives into them\nreplacing individual elements instead.", "protected": "", "params": [{"type": "object", "name": "mergeInto", "description": " The object to merge into"}, {"type": "object...", "name": "mergeFrom...", "description": " - Any number of objects to merge from"}, {"type": "integer", "name": "depth", "description": " An optional depth to prevent recursion. Default: 20."}], "guessedname": "_extendDeep", "guessedtype": "function"}}, "file": "config.js", "shortname": "Config", "description": "<p>Runtime Application Configurations</p>\n<p>\nThe config module exports a singleton object representing all runtime\nconfigurations for this application deployment.\n</p>\n<p>\nApplication configurations are stored in files within the config directory\nof your application. The default configuration file is loaded, followed\nby files specific to the deployment type (development, testing, staging,\nproduction, etc.).\n</p>\n<p>\nFor example, with the following config/default.yaml file:\n</p>\n<pre>\n...\ncustomer:\n&nbsp;&nbsp;initialCredit: 500\n&nbsp;&nbsp;db:\n&nbsp;&nbsp;&nbsp;&nbsp;name: customer\n&nbsp;&nbsp;&nbsp;&nbsp;port: 5984\n...\n</pre>\n<p>\nThe following code loads the customer section into the CONFIG variable:\n<p>\n<pre>\nvar CONFIG = require('config').customer;\n...\nnewCustomer.creditLimit = CONFIG.initialCredit;\ndatabase.open(CONFIG.db.name, CONFIG.db.port);\n...\n</pre>"}, "ProtectedTest": {"name": "ProtectedTest", "namespace": "", "module": "test", "guessedname": "PrivateTest", "file": "1-protected-test.js", "guessedtype": "property", "shortname": "ProtectedTest", "description": "<p>Tests for underlying node-config utilities. To run type:</p>\n<pre>npm test config</pre>"}}, "version": "0.4.13", "modules": {"test": {"description": "<p>Unit tests</p>", "submodules": [], "classlist": ["ProtectedTest", "ConfigTest"], "filelist": ["1-protected-test.js", "2-config-test.js", "default.js"], "subdata": {}, "name": "test"}, "config": {"description": "<p>Runtime Application Configurations</p>\n<p>\nThe config module exports a singleton object representing all runtime\nconfigurations for this application deployment.\n</p>\n<p>\nApplication configurations are stored in files within the config directory\nof your application. The default configuration file is loaded, followed\nby files specific to the deployment type (development, testing, staging,\nproduction, etc.).\n</p>\n<p>\nFor example, with the following config/default.yaml file:\n</p>\n<pre>\n...\ncustomer:\n&nbsp;&nbsp;initialCredit: 500\n&nbsp;&nbsp;db:\n&nbsp;&nbsp;&nbsp;&nbsp;name: customer\n&nbsp;&nbsp;&nbsp;&nbsp;port: 5984\n...\n</pre>\n<p>\nThe following code loads the customer section into the CONFIG variable:\n<p>\n<pre>\nvar CONFIG = require('config').customer;\n...\nnewCustomer.creditLimit = CONFIG.initialCredit;\ndatabase.open(CONFIG.db.name, CONFIG.db.port);\n...\n</pre>", "submodules": [], "classlist": ["Config"], "filelist": ["config.js"], "subdata": {}, "name": "config"}}, "filemap": {"default.js": {"classlist": [], "name": "default.js", "module": "test"}, "2-config-test.js": {"classlist": ["ConfigTest"], "name": "2-config-test.js", "module": "test"}, "config.js": {"classlist": ["Config"], "name": "config.js", "module": "config"}, "1-protected-test.js": {"classlist": ["ProtectedTest"], "name": "1-protected-test.js", "module": "test"}}}
View
27 lib/config.js
@@ -411,7 +411,7 @@ Config.prototype.makeImmutable = function(object, property, value) {
* <p>
* This method allows you to change the polling interval from the default
* interval (2.5 seconds), or to turn file watching off. On Linux systems with
- * inotify, this interval is ignored.
+ * inotify, and in node.js versions 0.6 and above, this interval is ignored.
* </p>
*
* @method watchForConfigFileChanges
@@ -619,9 +619,11 @@ Config.prototype._loadFileConfigs = function() {
* .coffee = File to run that has a module.exports with coffee-script containing the config object
* .yaml = Parsed with a YAML parser
*
- * If the file doesn't exist, a null will be returned.
+ * If the file doesn't exist, a null will be returned. If the file can't be
+ * parsed, an exception will be thrown.
*
- * If the file can't be parsed, an exception will be thrown.
+ * This method performs synchronous file operations, and should not be called
+ * after synchronous module loading.
*
* @protected
* @method _parseFile
@@ -636,17 +638,26 @@ Config.prototype._parseFile = function(fullFilename) {
configObject = null,
fileContent = null;
+ // Make sure the runtime.json file exists. This is required for fs.watch().
+ var checkRuntimeJson = function() {
+ if (fullFilename == runtimeJsonFilename) {
+console.log("Writing runtime json file");
+ FileSystem.writeFileSync(runtimeJsonFilename, '{}');
+ return {};
+ }
+ return null;
+ };
+
// Return null if the file doesn't exist.
- // Note that all methods here are the Sync versions. This allows the
- // config package to follow the same calling semantics as require('filename')
- // which is also synchronous.
+ // Note that all methods here are the Sync versions. This is appropriate during
+ // module loading (which is a synchronous operation), but not thereafter.
try {
var stat = FileSystem.statSync(fullFilename);
if (!stat || stat.size < 1) {
- return null;
+ return checkRuntimeJson();
}
} catch (e1) {
- return null;
+ return checkRuntimeJson();
}
// Try loading the file.
View
7 package.json
@@ -1,14 +1,15 @@
{
"name": "config",
- "version": "0.4.12",
+ "version": "0.4.13",
"main": "./lib/config.js",
"description": "Configuration control for production node deployments",
"author": "Loren West <open_source@lorenwest.com>",
"homepage": "http://lorenwest.github.com/node-config/",
"directories": {"lib": "./lib", "config": "./config", "test": "./test"},
- "dependencies": {},
+ "dependencies": {
+ "vows" : ">=0.5.13"
+ },
"devDependencies": {
- "vows" : "0.5.x",
"yaml" : "0.2.x",
"coffee-script" : ">=1.2.0"
},
Please sign in to comment.
Something went wrong with that request. Please try again.