beautifyJSON comment improvements

added return type to comments.
This commit is contained in:
RefinedSoftwareLLC 2013-03-22 17:24:14 -06:00
parent 368fb1329a
commit 9b320fcb33

View File

@ -115,16 +115,22 @@ exports.minify = function(files, options) {
}; };
}; };
exports.beautifyJSON = function(files, options) { // UglifyJS.beautifyJSON(files, options) { return beautifyedString; };
// files = a (single or array of) file names, JSON strings, or JSON Objects. // files = a (single or array of) file names, JSON strings, or JSON Objects.
// options = UglifyJS minify options. // options = UglifyJS minify options.
// returns beautifyed string of JSON info.
//
// NEW OPTIONS: // NEW OPTIONS:
// fromObject:true allows passing a JSON object or an array of JSON objects. // fromObject:true allows passing a JSON object or an array of JSON objects.
// replacer:function(key, oldValue){ return newValue; } // replacer:function(key, oldValue){ return newValue; }
// replacer:["Array", "of", "kept", "properties", "all", "others", "discarded"] // replacer:["Array", "of", "kept", "properties", "all", "others", "discarded"]
//
// UNSUPPORTED: (Source Maps):true, compress:true, quote_keys:false. // UNSUPPORTED: (Source Maps):true, compress:true, quote_keys:false.
//
// WARNING: All input is run through JSON.stringify() which will change some invalid // WARNING: All input is run through JSON.stringify() which will change some invalid
// values (like NaN and infinity) and error on others (like incorrect syntax). // values (like NaN and infinity) and error on others (like incorrect syntax).
exports.beautifyJSON = function(files, options) {
// 1. updating options with standard beautify settings and overrides: // 1. updating options with standard beautify settings and overrides:
options = UglifyJS.defaults(options, { options = UglifyJS.defaults(options, {