util-ex/lib/escapeStringRegexp.d.ts

Browser-friendly enhanced util fully compatible with standard node.js

/**
 * Escapes a string for use in a regular expression pattern.
 *
 * @param {string} string - The string to be escaped. Must be of type 'string', otherwise a `TypeError` will be thrown.
 * @returns {string} - The escaped string where special characters are escaped to ensure they are not interpreted as special syntax within a regular expression.
 *
 * @example
 * const input = "Hello, world! (It's me.)";
 * const escaped = escapeStringRegexp(input);
 * console.log(escaped); // Outputs: "Hello, world! \(It's me\.\)"
 */
export function escapeStringRegexp(string: string): string;
export default escapeStringRegexp;