log-ocd/src/helpers/escape.js

the best node.js logger

/**
 * -----------------------------------------------------------------------------
 * LOG-OCD: ESCAPE 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';

/**
 * @private
 * @type {!RegExp}
 * @const
 */
var ESCAPE_CHARS = /[\\^$.*+?|(){}[\]]/g;

/**
 * @param {string} source
 * @return {string}
 */
module.exports = function escape(source) {
  return source.replace(ESCAPE_CHARS, '\\$&');
};