1. module cjson
   1. function cjson.decomment (str)
   2. function cjson.extend (deep, obj1, obj2)
   3. function cjson.freeze (obj)
   4. function cjson.load (path, options)
   5. function cjson.parse (str, reviver)
   6. function cjson.replace (str, data)
   7. object cjson.options
2. module cjson.options
   1. boolean cjson.options.freeze
   2. boolean cjson.options.merge
   3. function cjson.options.parse (text, reviver)
   4. object cjson.options.replace
   5. string cjson.options.ext

module cjson

function cjson.decomment (str)

• description and source-code

  decomment = function (str) {
      var i,
          curChar, nextChar,
          inString = false,
          inComment = false,
          newStr = '';
  
      for (i = 0; i < str.length; ++i) {
          curChar = str.charAt(i);
          nextChar = str.charAt(i + 1);
  
          // it's either closing or opening inString and it is not escaped
          if (!inComment && curChar === '"' && str.charAt(i - 1) !== '\\') {
              inString = !inString;
          }
  
          // we are not inside of a string
          if (!inString) {
              // singleline comment start
              if (!inComment && curChar + nextChar === '//') {
                  ++i;
                  inComment = 1;
              // singleline comment end
              } else if (inComment === 1 && curChar === '\n') {
                  inComment = false;
              // multiline comment start
              } else if (!inComment && curChar + nextChar === '/*') {
                  ++i;
                  inComment = 2;
                  curChar = '';
              // multiline comment end
              } else if (inComment === 2 && curChar + nextChar === '*/') {
                  ++i;
                  inComment = false;
                  curChar = '';
              }
  
              if (inComment) {
                  curChar = '';
              }
          }
  
          newStr += curChar;
      }
  
  
      return newStr;
  }

• example usage

  ...
  *
  * @param {String} json.
  * @param {Function} [reviver] will be called for every key and value at every
  *     level of the final result.
  * @return {Object} parsed json object.
  */
  exports.parse = function(str, reviver) {
     return exports.options.parse(exports.decomment(str), reviver);
  };
  
  /**
  * Replace templates with data. {{toReplace}}
  *
  * @param {String} json.
  * @param {Object} data data hash.
  ...

function cjson.extend (deep, obj1, obj2)

• description and source-code

  function extend(deep, obj1, obj2) {
      // take first argument, if its not a boolean
      var args = arguments,
          i = deep === true ? 1 : 0,
          key,
          target = args[i];
  
      for (++i; i < args.length; ++i) {
          for (key in args[i]) {
              if (deep === true &&
                  target[key] &&
                  // if not doing this check you may end in
                  // endless loop if using deep option
                  toString.call(args[i][key]) === obj &&
                  toString.call(target[key]) === obj) {
  
                  // create a copy of target object to avoid subobjects changes
                  target[key] = extend(deep, {}, target[key]);
  
                  extend(deep, target[key], args[i][key]);
              } else {
                  target[key] = args[i][key];
              }
          }
      }
  
      return target;
  }

• example usage

  ...
  exports.load = function load(path, options) {
  var data, paths, conf;
  
  if (options === true) {
      options = {merge: true};
  }
  
  options = exports.extend({}, exports.options, options);
  
  if (Array.isArray(path)) {
      conf = {};
      path.forEach(function(path) {
          if (fs.existsSync(path)) {
              var data = load(path, options),
                  filename;
  ...

function cjson.freeze (obj)

• description and source-code

  function freeze(obj) {
      var key;
  
      if (obj instanceof Object) {
          for (key in obj) {
              freeze(obj[key]);
          }
  
          Object.freeze(obj);
      }
  }

• example usage

  ...
     var key;
  
     if (obj instanceof Object) {
         for (key in obj) {
             freeze(obj[key]);
         }
  
         Object.freeze(obj);
     }
  };
  
  /**
  * Load and parse a config file/files.
  *
  * @param {String|Array} path absolute path/paths to the file/files or dir.
  ...

function cjson.load (path, options)

• description and source-code

  function load(path, options) {
      var data, paths, conf;
  
      if (options === true) {
          options = {merge: true};
      }
  
      options = exports.extend({}, exports.options, options);
  
      if (Array.isArray(path)) {
          conf = {};
          path.forEach(function(path) {
              if (fs.existsSync(path)) {
                  var data = load(path, options),
                      filename;
  
                  if (options.merge) {
                      exports.extend(true, conf, data);
                  } else {
                      filename = Path.basename(path, options.ext);
                      conf[filename] = data;
                  }
              }
          });
  
          return conf;
      }
  
      if (fs.statSync(path).isDirectory()) {
          paths = [];
          fs.readdirSync(path).forEach(function(filename) {
              var file = Path.join(path, filename);
  
              if (Path.extname(file) == options.ext && fs.statSync(file).isFile()) {
                  paths.push(file);
              }
          });
  
          return load(paths, options);
      }
  
      data = fs.readFileSync(path, 'utf-8');
  
      // replace BOM Character
      data = data.replace(/\ufeff/g, '');
  
      if (options.replace) {
          data = exports.replace(data, options.replace);
      }
  
      try {
          data = exports.parse(data);
      } catch(err) {
          err.message += '\nFile: "' + path + '"';
          throw err;
      }
  
      if (options.freeze) {
          exports.freeze(data);
      }
  
      return data;
  }

• example usage

  ...
  ```
  
  ## API
  
  ### load the module
  	var cjson = require('cjson');
  
  ### cjson.load(path, [options]);
  
  Load config file from given path, array of paths or directory. Second parameter is optional and can be a boolean or object.
  
  - `path` {String|Array} absolute path to the file, array of paths or directory
  - `options` {Boolean|Object} optional options. If you pass `true` as second param, its the same like `    {merge: true}` and will
   merge all configs together.
  ...

function cjson.parse (str, reviver)

• description and source-code

  parse = function (str, reviver) {
      return exports.options.parse(exports.decomment(str), reviver);
  }

• example usage

  ...
  *
  * @param {String} json.
  * @param {Function} [reviver] will be called for every key and value at every
  *     level of the final result.
  * @return {Object} parsed json object.
  */
  exports.parse = function(str, reviver) {
     return exports.options.parse(exports.decomment(str), reviver);
  };
  
  /**
  * Replace templates with data. {{toReplace}}
  *
  * @param {String} json.
  * @param {Object} data data hash.
  ...

function cjson.replace (str, data)

• description and source-code

  replace = function (str, data) {
      return str.replace(/\{\{([^}]+)\}\}/g, function(match, search) {
          if (data.hasOwnProperty(search)) {
              // If the variable is an object, stringify it before replacement.
              // The false positive of "null" is fine in this case.
              if (typeof data[search] === 'object') {
                  return JSON.stringify(data[search]);
              }
              return data[search];
          }
          return match;
      });
  }

• example usage

  ...
   * Replace templates with data. {{toReplace}}
   *
   * @param {String} json.
   * @param {Object} data data hash.
   * @return {String} json string with replaced data.
   */
  exports.replace = function(str, data) {
  return str.replace(/\{\{([^}]+)\}\}/g, function(match, search) {
      if (data.hasOwnProperty(search)) {
          // If the variable is an object, stringify it before replacement.
          // The false positive of "null" is fine in this case.
          if (typeof data[search] === 'object') {
              return JSON.stringify(data[search]);
          }
          return data[search];
  ...

module cjson.options

function cjson.options.parse (text, reviver)

• description and source-code

  function parse(text, reviver) {
      try {
          return JSON.parse(text, reviver);
      } catch (err) {
          // we expect this to throw with a more informative message
          jju.parse(text, {
              mode: 'json',
              reviver: reviver
          });
  
          // backup if jju is not as strict as JSON.parse; re-throw error
          // data-dependent code path, I do not know how to cover it
          throw err;
      }
  }

• example usage

  ...
  *
  * @param {String} json.
  * @param {Function} [reviver] will be called for every key and value at every
  *     level of the final result.
  * @return {Object} parsed json object.
  */
  exports.parse = function(str, reviver) {
     return exports.options.parse(exports.decomment(str), reviver);
  };
  
  /**
  * Replace templates with data. {{toReplace}}
  *
  * @param {String} json.
  * @param {Object} data data hash.
  ...