2011-06-05 05:39:39 +00:00
<!DOCTYPE html> < html > < head > < title > nconf.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 … < div id = "jump_wrapper" > < div id = "jump_page" > < 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/redis.html" > nconf/stores/redis.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 > nconf.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" > ¶ < / a > < / div > < / td > < td class = "code" > < div class = "highlight" > < pre > < span class = "cm" > /*< / span >
2011-04-02 08:42:26 +00:00
< span class = "cm" > * nconf.js: Top-level include for the nconf module< / span >
< span class = "cm" > *< / span >
< span class = "cm" > * (C) 2011, Charlie Robbins< / span >
< span class = "cm" > *< / span >
< span class = "cm" > */< / span >
2011-06-05 05:39:39 +00:00
< span class = "kd" > var< / span > < span class = "nx" > Provider< / span > < span class = "o" > =< / span > < span class = "nx" > require< / span > < span class = "p" > (< / span > < span class = "s1" > ' ./nconf/provider' < / span > < span class = "p" > ).< / span > < span class = "nx" > Provider< / span > < span class = "p" > ,< / span >
< span class = "nx" > nconf< / span > < span class = "o" > =< / span > < span class = "nx" > module< / span > < span class = "p" > .< / span > < span class = "nx" > exports< / span > < span class = "o" > =< / span > < span class = "nb" > Object< / span > < span class = "p" > .< / span > < span class = "nx" > create< / span > < span class = "p" > (< / span > < span class = "nx" > Provider< / span > < span class = "p" > .< / span > < span class = "nx" > prototype< / span > < span class = "p" > );< / span > < / pre > < / div > < / td > < / tr > < tr id = "section-2" > < td class = "docs" > < div class = "pilwrap" > < a class = "pilcrow" href = "#section-2" > ¶ < / a > < / div > < p > Use the memory engine by default.< / p > < / td > < td class = "code" > < div class = "highlight" > < pre > < span class = "nx" > nconf< / span > < span class = "p" > .< / span > < span class = "nx" > use< / span > < span class = "p" > (< / span > < span class = "s1" > ' memory' < / span > < span class = "p" > );< / span > < / pre > < / div > < / td > < / tr > < tr id = "section-3" > < td class = "docs" > < div class = "pilwrap" > < a class = "pilcrow" href = "#section-3" > ¶ < / a > < / div > < h3 > Version 0.1.9 :: 5/16/2011< / h3 > < / td > < td class = "code" > < div class = "highlight" > < pre > < span class = "nx" > nconf< / span > < span class = "p" > .< / span > < span class = "nx" > version< / span > < span class = "o" > =< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span > < span class = "mi" > 9< / span > < span class = "p" > ];< / span > < / pre > < / div > < / td > < / tr > < tr id = "section-4" > < td class = "docs" > < div class = "pilwrap" > < a class = "pilcrow" href = "#section-4" > ¶ < / a > < / div > < h3 > function path (key)< / h3 >
2011-04-02 08:42:26 +00:00
< h4 > @key {string} The ':' delimited key to split< / h4 >
< p > Returns a fully-qualified path to a nested nconf key. < / p > < / td > < td class = "code" > < div class = "highlight" > < pre > < span class = "nx" > nconf< / span > < span class = "p" > .< / span > < span class = "nx" > path< / span > < span class = "o" > =< / span > < span class = "kd" > function< / span > < span class = "p" > (< / span > < span class = "nx" > key< / span > < span class = "p" > )< / span > < span class = "p" > {< / span >
< span class = "k" > return< / span > < span class = "nx" > key< / span > < span class = "p" > .< / span > < span class = "nx" > split< / span > < span class = "p" > (< / span > < span class = "s1" > ' :' < / span > < span class = "p" > );< / span >
2011-06-05 05:39:39 +00:00
< span class = "p" > };< / span > < / pre > < / div > < / td > < / tr > < tr id = "section-5" > < td class = "docs" > < div class = "pilwrap" > < a class = "pilcrow" href = "#section-5" > ¶ < / a > < / div > < h3 > function key (arguments)< / h3 >
< p > Returns a < code > :< / code > joined string from the < code > arguments< / code > .< / p > < / td > < td class = "code" > < div class = "highlight" > < pre > < span class = "nx" > nconf< / span > < span class = "p" > .< / span > < span class = "nx" > key< / span > < span class = "o" > =< / span > < span class = "kd" > function< / span > < span class = "p" > ()< / span > < span class = "p" > {< / span >
< span class = "k" > return< / span > < span class = "nb" > Array< / span > < span class = "p" > .< / span > < span class = "nx" > prototype< / span > < span class = "p" > .< / span > < span class = "nx" > slice< / span > < span class = "p" > .< / span > < span class = "nx" > call< / span > < span class = "p" > (< / span > < span class = "nx" > arguments< / span > < span class = "p" > ).< / span > < span class = "nx" > join< / span > < span class = "p" > (< / span > < span class = "s1" > ' :' < / span > < span class = "p" > );< / span >
< span class = "p" > };< / span > < / pre > < / div > < / td > < / tr > < tr id = "section-6" > < td class = "docs" > < div class = "pilwrap" > < a class = "pilcrow" href = "#section-6" > ¶ < / a > < / div > < p > Expose the various components included with nconf< / p > < / td > < td class = "code" > < div class = "highlight" > < pre > < span class = "nx" > nconf< / span > < span class = "p" > .< / span > < span class = "nx" > stores< / span > < span class = "o" > =< / span > < span class = "nx" > require< / span > < span class = "p" > (< / span > < span class = "s1" > ' ./nconf/stores' < / span > < span class = "p" > );< / span >
< span class = "nx" > nconf< / span > < span class = "p" > .< / span > < span class = "nx" > Provider< / span > < span class = "o" > =< / span > < span class = "nx" > Provider< / span > < span class = "p" > ;< / span >
2011-04-02 08:42:26 +00:00
< / pre > < / div > < / td > < / tr > < / tbody > < / table > < / div > < / body > < / html >
