UNPKG

@apidevtools/json-schema-ref-parser

Version:

Parse, Resolve, and Dereference JSON Schema $ref pointers

53 lines (52 loc) 2.02 kB
"use strict"; var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", { value: true }); const errors_js_1 = require("../util/errors.js"); const js_yaml_1 = __importDefault(require("js-yaml")); const js_yaml_2 = require("js-yaml"); exports.default = { /** * The order that this parser will run, in relation to other parsers. */ order: 200, /** * Whether to allow "empty" files. This includes zero-byte files, as well as empty JSON objects. */ allowEmpty: true, /** * Determines whether this parser can parse a given file reference. * Parsers that match will be tried, in order, until one successfully parses the file. * Parsers that don't match will be skipped, UNLESS none of the parsers match, in which case * every parser will be tried. */ canParse: [".yaml", ".yml", ".json"], // JSON is valid YAML /** * Parses the given file as YAML * * @param file - An object containing information about the referenced file * @param file.url - The full URL of the referenced file * @param file.extension - The lowercased file extension (e.g. ".txt", ".html", etc.) * @param file.data - The file contents. This will be whatever data type was returned by the resolver * @returns */ async parse(file) { let data = file.data; if (Buffer.isBuffer(data)) { data = data.toString(); } if (typeof data === "string") { try { return js_yaml_1.default.load(data, { schema: js_yaml_2.JSON_SCHEMA }); } catch (e) { throw new errors_js_1.ParserError(e?.message || "Parser Error", file.url); } } else { // data is already a JavaScript value (object, array, number, null, NaN, etc.) return data; } }, };