@barchart/common-js/dist/cjs/api/http/definitions/Parameter.js

Library of common JavaScript utilities

var __create = Object.create;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __getProtoOf = Object.getPrototypeOf;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __export = (target, all) => {
  for (var name in all)
    __defProp(target, name, { get: all[name], enumerable: true });
};
var __copyProps = (to, from, except, desc) => {
  if (from && typeof from === "object" || typeof from === "function") {
    for (let key of __getOwnPropNames(from))
      if (!__hasOwnProp.call(to, key) && key !== except)
        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
  }
  return to;
};
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
  // If the importer is in node compatibility mode or this is not an ESM
  // file that has been converted to a CommonJS file using a Babel-
  // compatible transform (i.e. "__esModule" has not been set), then set
  // "default" to the CommonJS "module.exports" for node compatibility.
  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
  mod
));
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
var Parameter_exports = {};
__export(Parameter_exports, {
  default: () => Parameter
});
module.exports = __toCommonJS(Parameter_exports);
var is = __toESM(require("./../../../lang/is.js"));
class Parameter {
  #description;
  #key;
  #extractor;
  #optional;
  /**
   * @param {string} description
   * @param {string} key
   * @param {parameterValueCallback} extractor
   * @param {boolean=} optional
   */
  constructor(description, key, extractor, optional) {
    this.#description = description || null;
    this.#key = key || null;
    this.#extractor = extractor || null;
    this.#optional = is.boolean(optional) && optional;
  }
  /**
   * The human-readable description of the parameter.
   *
   * @public
   * @returns {string}
   */
  get description() {
    return this.#description;
  }
  /**
   * The name of the parameter.
   *
   * @public
   * @returns {string}
   */
  get key() {
    return this.#key;
  }
  /**
   * A function for extracting the parameter's value.
   *
   * @public
   * @returns {parameterValueCallback}
   */
  get extractor() {
    return this.#extractor;
  }
  /**
   * Indicates if the parameter is required.
   *
   * @public
   * @returns {boolean}
   */
  get optional() {
    return this.#optional;
  }
  /**
   * Throws an {@link Error} if the instance is invalid.
   *
   * @public
   */
  validate() {
    if (!is.string(this.key) || this.key.length === 0) {
      throw new Error("Parameter key must be a non-zero length string");
    }
    if (!is.fn(this.#extractor)) {
      throw new Error("Parameter extractor must be a function.");
    }
  }
  /**
   * Returns a string representation.
   *
   * @public
   * @returns {string}
   */
  toString() {
    return `[Parameter]`;
  }
}

{
	const cjsExports = module.exports;
	const cjsDefaultExport = cjsExports && cjsExports.__esModule ? cjsExports.default : cjsExports;

	if (cjsDefaultExport && (typeof cjsDefaultExport === 'function' || typeof cjsDefaultExport === 'object')) {
		Object.keys(cjsExports).forEach((key) => {
			if (key !== 'default' && key !== '__esModule') {
				cjsDefaultExport[key] = cjsExports[key];
			}
		});
	}

	module.exports = cjsDefaultExport;
}