Logo for jsDocs.io

escape-string-regexp

  • Version 5.0.0
  • Published
  • 3.66 kB
  • No dependencies
  • MIT license

Install

npm i escape-string-regexp
yarn add escape-string-regexp
pnpm add escape-string-regexp

Overview

Escape RegExp special characters

Index

Functions

Functions

function escapeStringRegexp

escapeStringRegexp: (string: string) => string;

  • Escape RegExp special characters.

    You can also use this to escape a string that is inserted into the middle of a regex, for example, into a character class.

    Example 1

    import escapeStringRegexp from 'escape-string-regexp';
    

    const escapedString = escapeStringRegexp('How much $ for a 🦄?');
    //=> 'How much \\$ for a 🦄\\?'
    

    new RegExp(escapedString);

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (3)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/escape-string-regexp.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/escape-string-regexp)
  • HTML
    <a href="https://www.jsdocs.io/package/escape-string-regexp"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>