- refactored the $RefParser static methods to support inheritance

- renamed ParserOptions to $RefParserOptions

Author: JamesMessinger

dist/ref-parser.js

@@ -1,3 +1,9 @@
+/**!
+ * JSON Schema $Ref Parser v1.0.0-alpha.13
+ *
+ * @link https://github.com/BigstickCarpet/json-schema-ref-parser
+ * @license MIT
+ */
 'use strict';
 
 module.exports = bundle;
@@ -8,7 +14,7 @@ module.exports = bundle;
  * This method mutates the JSON schema object, adding new references and remapping existing ones.
  *
  * @param {$RefParser} parser
- * @param {ParserOptions} options
+ * @param {$RefParserOptions} options
  */
 function bundle(parser, options) {
   throw new Error('The "bundle" method is not implemented yet.  It will be implemented before the final alpha.');

dist/ref-parser.js.map

@@ -14,7 +14,7 @@ module.exports = dereference;
  * This method mutates the JSON schema object, replacing JSON references with their resolved value.
  *
  * @param {$RefParser} parser
- * @param {ParserOptions} options
+ * @param {$RefParserOptions} options
  */
 function dereference(parser, options) {
   util.debug('Dereferencing $ref pointers in %s', parser._basePath);
@@ -28,7 +28,7 @@ function dereference(parser, options) {
  * @param {string} path - The path to use for resolving relative JSON references
  * @param {object[]} parents - An array of the parent objects that have already been dereferenced
  * @param {$Refs} $refs - The resolved JSON references
- * @param {ParserOptions} options
+ * @param {$RefParserOptions} options
  */
 function crawl(obj, path, parents, $refs, options) {
   if (_isObject(obj) || _isArray(obj)) {

dist/ref-parser.min.js

@@ -17,7 +17,6 @@ var Promise        = require('./promise'),
     _isString      = require('lodash/lang/isString');
 
 module.exports = $RefParser;
-module.falsy && require('./_preamble');
 
 /**
  * This class parses a JSON schema, builds a map of its JSON references and their resolved values,
@@ -54,12 +53,13 @@ function $RefParser() {
  * It just reads a single file in JSON or YAML format, and parse it as a JavaScript object.
  *
  * @param {string|object} schema - The file path or URL of the JSON schema. Or a JSON schema object.
- * @param {ParserOptions} [options] - Options that determine how the schema is parsed
+ * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed
  * @param {function} [callback] - An error-first callback. The second parameter is the parsed JSON schema object.
  * @returns {Promise} - The returned promise resolves with the parsed JSON schema object.
  */
 $RefParser.parse = function(schema, options, callback) {
-  return new $RefParser().parse(schema, options, callback);
+  var Class = this;
+  return new Class().parse(schema, options, callback);
 };
 
 /**
@@ -68,7 +68,7 @@ $RefParser.parse = function(schema, options, callback) {
  * It just reads a single file in JSON or YAML format, and parse it as a JavaScript object.
  *
  * @param {string|object} schema - The file path or URL of the JSON schema. Or a JSON schema object.
- * @param {ParserOptions} [options] - Options that determine how the schema is parsed
+ * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed
  * @param {function} [callback] - An error-first callback. The second parameter is the parsed JSON schema object.
  * @returns {Promise} - The returned promise resolves with the parsed JSON schema object.
  */
@@ -124,23 +124,24 @@ $RefParser.prototype.parse = function(schema, options, callback) {
  * externally-referenced files.
  *
  * @param {string|object} schema - The file path or URL of the JSON schema. Or a JSON schema object.
- * @param {ParserOptions} [options] - Options that determine how the schema is parsed and resolved
+ * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed and resolved
  * @param {function} [callback]
  * - An error-first callback. The second parameter is a {@link $Refs} object containing the resolved JSON references
  *
  * @returns {Promise}
  * The returned promise resolves with a {@link $Refs} object containing the resolved JSON references
  */
 $RefParser.resolve = function(schema, options, callback) {
-  return new $RefParser().resolve(schema, options, callback);
+  var Class = this;
+  return new Class().resolve(schema, options, callback);
 };
 
 /**
  * Parses the given JSON schema and resolves any JSON references, including references in
  * externally-referenced files.
  *
  * @param {string|object} schema - The file path or URL of the JSON schema. Or a JSON schema object.
- * @param {ParserOptions} [options] - Options that determine how the schema is parsed and resolved
+ * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed and resolved
  * @param {function} [callback]
  * - An error-first callback. The second parameter is a {@link $Refs} object containing the resolved JSON references
  *
@@ -176,12 +177,13 @@ $RefParser.prototype.resolve = function(schema, options, callback) {
  * not any *external* references.
  *
  * @param {string|object} schema - The file path or URL of the JSON schema. Or a JSON schema object.
- * @param {ParserOptions} [options] - Options that determine how the schema is parsed, resolved, and dereferenced
+ * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed, resolved, and dereferenced
  * @param {function} [callback] - An error-first callback. The second parameter is the bundled JSON schema object
  * @returns {Promise} - The returned promise resolves with the bundled JSON schema object.
  */
 $RefParser.bundle = function(schema, options, callback) {
-  return new $RefParser().bundle(schema, options, callback);
+  var Class = this;
+  return new Class().bundle(schema, options, callback);
 };
 
 /**
@@ -190,7 +192,7 @@ $RefParser.bundle = function(schema, options, callback) {
  * not any *external* references.
  *
  * @param {string|object} schema - The file path or URL of the JSON schema. Or a JSON schema object.
- * @param {ParserOptions} [options] - Options that determine how the schema is parsed, resolved, and dereferenced
+ * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed, resolved, and dereferenced
  * @param {function} [callback] - An error-first callback. The second parameter is the bundled JSON schema object
  * @returns {Promise} - The returned promise resolves with the bundled JSON schema object.
  */
@@ -220,20 +222,21 @@ $RefParser.prototype.bundle = function(schema, options, callback) {
  * That is, all JSON references are replaced with their resolved values.
  *
  * @param {string|object} schema - The file path or URL of the JSON schema. Or a JSON schema object.
- * @param {ParserOptions} [options] - Options that determine how the schema is parsed, resolved, and dereferenced
+ * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed, resolved, and dereferenced
  * @param {function} [callback] - An error-first callback. The second parameter is the dereferenced JSON schema object
  * @returns {Promise} - The returned promise resolves with the dereferenced JSON schema object.
  */
 $RefParser.dereference = function(schema, options, callback) {
-  return new $RefParser().dereference(schema, options, callback);
+  var Class = this;
+  return new Class().dereference(schema, options, callback);
 };
 
 /**
  * Parses the given JSON schema, resolves any JSON references, and dereferences the JSON schema.
  * That is, all JSON references are replaced with their resolved values.
  *
  * @param {string|object} schema - The file path or URL of the JSON schema. Or a JSON schema object.
- * @param {ParserOptions} [options] - Options that determine how the schema is parsed, resolved, and dereferenced
+ * @param {$RefParserOptions} [options] - Options that determine how the schema is parsed, resolved, and dereferenced
  * @param {function} [callback] - An error-first callback. The second parameter is the dereferenced JSON schema object
  * @returns {Promise} - The returned promise resolves with the dereferenced JSON schema object.
  */

dist/ref-parser.min.js.map

@@ -2,15 +2,15 @@
 
 var _merge = require('lodash/object/merge');
 
-module.exports = ParserOptions;
+module.exports = $RefParserOptions;
 
 /**
  * Options that determine how JSON schemas are parsed, dereferenced, and cached.
  *
- * @param {object|ParserOptions} [options] - Overridden options
+ * @param {object|$RefParserOptions} [options] - Overridden options
  * @constructor
  */
-function ParserOptions(options) {
+function $RefParserOptions(options) {
   /**
    * Determines what types of files can be parsed
    */

lib/_preamble.js

@@ -13,7 +13,7 @@ module.exports = parse;
  *
  * @param {string|Buffer} data - The data to be parsed
  * @param {string} path - The file path or URL that `data` came from
- * @param {ParserOptions} options
+ * @param {$RefParserOptions} options
  *
  * @returns {string|Buffer|object}
  * If `data` can be parsed as YAML or JSON, then the returned value is a JavaScript object.