error.js

"use strict";

/**
 * Create an Error with a message relating to an invalid parameter.
 *
 * @param {string} name - parameter name.
 * @param {string} expected - description of the type/value/range expected.
 * @param {*} actual - the value received.
 * @returns {TypeError} Containing the formatted message.
 * @private
 */
 const invalidParameterError = function (name, expected, actual) {
	return new TypeError(
		`Expected <${expected}> for [${name}] but received ${actual} of type <${typeof actual}>`
	);
};

/**
 * Create an Error with a message relating to an invalid path.
 *
 * @param {string} name - parameter name.
 * @param {string} path = path string.
 * @returns {TypeError} Containing the formatted message.
 * @private
 */
const invalidPathError = function (name, path) {
	return new TypeError(`${name} path ${path} does not exist.`);
};

module.exports = {
    invalidPathError: invalidPathError,
	invalidParameterError: invalidParameterError,
};