log-ocd/src/methods/helpers/prop-type-error.js

the best node.js logger

/**
 * -----------------------------------------------------------------------------
 * LOG-OCD: PROP-TYPE-ERROR HELPER
 * -----------------------------------------------------------------------------
 * @version 1.0.0-beta.11
 * @see [log-ocd]{@link https://github.com/imaginate/log-ocd}
 *
 * @author Adam Smith <imagineadamsmith@gmail.com> (https://github.com/imaginate)
 * @copyright 2022 Adam A Smith <imagineadamsmith@gmail.com> (https://github.com/imaginate)
 *
 * Supporting Libraries:
 * @see [chalk]{@link https://github.com/chalk/chalk}
 * @see [vitals]{@link https://github.com/imaginate/vitals}
 *
 * Annotations:
 * @see [JSDoc3]{@link http://usejsdoc.org/}
 * @see [Closure Compiler specific JSDoc]{@link https://developers.google.com/closure/compiler/docs/js-for-compiler}
 */

'use strict';

var fuse = require('../../helpers').fuse;
var log = require('../log');

/**
 * @param {Settings} settings
 * @param {string} method
 * @param {string} prop
 * @param {*} val
 * @return {boolean}
 */
module.exports = function propTypeError(settings, method, prop, val) {

  /** @type {string} */
  var errorMsg;
  /** @type {!Config} */
  var config;
  /** @type {!Object} */
  var ocdmap;
  /** @type {string} */
  var header;
  /** @type {!TypeError} */
  var error;
  /** @type {!Array} */
  var args;
  /** @type {string} */
  var msg;

  config = settings.error.config;

  header = fuse('Invalid `log-ocd.', method, '` Call');
  msg = fuse('invalid type for `', prop, '` property');

  errorMsg = fuse(header, ': ', msg);
  error = new TypeError(errorMsg);

  ocdmap = { ocdmap: true };
  ocdmap[param] = val;

  args = [ 'error' ];
  if (config.header) args = fuse(args, header);
  if (config.msg) args = fuse(args, msg);
  args = fuse(args, error, ocdmap);
  log.apply(settings, args);

  return false;
};