Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@stdlib/utils-escape-regexp-string
Advanced tools
Readme
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Escape a regular expression string or pattern.
npm install @stdlib/utils-escape-regexp-string
var rescape = require( '@stdlib/utils-escape-regexp-string' );
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 | ? |
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\\)'
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.
FAQs
Escape a regular expression string or pattern.
The npm package @stdlib/utils-escape-regexp-string receives a total of 357,816 weekly downloads. As such, @stdlib/utils-escape-regexp-string popularity was classified as popular.
We found that @stdlib/utils-escape-regexp-string demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.