@maddimathon/utility-typescript/dist/functions/regex/escRegExpReplace.d.ts

TypeScript utilities (types, functions, classes) to use in various projects.

/**
 * @since 0.1.0
 *
 * @packageDocumentation
 */
/*!
 * @maddimathon/utility-typescript@2.0.0-beta.1
 * @license MIT
 */
/**
 * Escapes a string for use as a replacement for a regular expression.
 *
 * @category  Escapers
 *
 * @source
 *
 * @example
 * ```ts
 * 'cash money'.replace( /(dollars?|money)/gi, escRegExpReplace( '$$$' ) );
 * // result: 'cash $$$'
 * ```
 *
 * @param str To convert.
 *
 * @return  Escaped string.
 *
 * @since 0.1.0
 */
export declare function escRegExpReplace(str: string): string;
//# sourceMappingURL=escRegExpReplace.d.ts.map