Package Exports

@stdlib/utils-escape-regexp-string
@stdlib/utils-escape-regexp-string/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/utils-escape-regexp-string) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

rescape

Escape a regular expression string or pattern.

Installation

npm install @stdlib/utils-escape-regexp-string

Usage

var rescape = require( '@stdlib/utils-escape-regexp-string' );

rescape( str )

Escapes a regular expression string or pattern.

var str = rescape( '/[A-Z]*/' );
// returns '/\\[A\\-Z\\]\\*/'

str = rescape( '[A-Z]*' );
// returns '\\[A\\-Z\\]\\*'

If provided a value which is not a primitive string, the function throws a TypeError.

try {
    rescape( null );
    // throws an error...
} catch ( err ) {
    console.error( err );
}

The following characters have special meaning inside of regular expressions and need to be escaped in case the characters should be treated literally:

description	value
Backslash	`\`
Braces	`{ }`
Brackets	`[ ]`
Caret	`^`
Dollar Sign	`$`
Forward Slash	`/`
Asterisk	`*`
Parentheses	`( )`
Period	`.`
Plus Sign	`+`
Vertical Bar	`\|`
Question Mark	`?`

Examples

var rescape = require( '@stdlib/utils-escape-regexp-string' );

var out = rescape( '/beep/' );
// returns '/beep/'

out = rescape( 'beep' );
// returns 'beep'

out = rescape( '/[A-Z]*/' );
// returns '/\\[A\\-Z\\]\\*/'

out = rescape( '[A-Z]*' );
// returns '\\[A\\-Z\\]\\*'

out = rescape( '/\\\//ig' );
// returns '/\\\\\\\//ig'

out = rescape( '\\\/' );
// returns '\\\\\\\/'

out = rescape( '/[A-Z]{0,}/' );
// returns '/\\[A\\-Z\\]\\{0,\\}/'

out = rescape( '[A-Z]{0,}' );
// returns '\\[A\\-Z\\]\\{0,\\}'

out = rescape( '/^boop$/' );
// returns '/\\^boop\\$/'

out = rescape( '^boop$' );
// returns '\\^boop\\$'

out = rescape( '/(?:.*)/' );
// returns '/\\(\\?:\\.\\*\\)/'

out = rescape( '(?:.*)' );
// returns '\\(\\?:\\.\\*\\)'

out = rescape( '/(?:beep|boop)/' );
// returns '/\\(\\?:beep\\|boop\\)/'

out = rescape( '(?:beep|boop)' );
// returns '\\(\\?:beep\\|boop\\)'

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

@stdlib/utils-escape-regexp-string