utils-escape-regex-string v1.0.1
RegExp String
Escapes a regular expression string or pattern.
Installation
$ npm install utils-escape-regex-string
Usage
var rescape = require( 'utils-escape-regex-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 {
// throws...
var str = rescape( null );
} catch ( err ) {
console.error( err );
}
Examples
var rescape = require( 'utils-escape-regex-string' );
console.log( rescape( '/beep/' ) );
// returns '/beep/'
console.log( rescape( 'beep' ) );
// returns 'beep'
console.log( rescape( '/[A-Z]*/' ) );
// returns '/\\[A\\-Z\\]\\*/'
console.log( rescape( '[A-Z]*' ) );
// returns '\\[A\\-Z\\]\\*'
console.log( rescape( '/\\\//ig' ) );
// returns '/\\\\\\\//ig'
console.log( rescape( '\\\/' ) );
// returns '\\\\\\\/'
console.log( rescape( '/[A-Z]{0,}/' ) );
// returns '/\\[A\\-Z\\]\\{0,\\}/'
console.log( rescape( '[A-Z]{0,}' ) );
// returns '\\[A\\-Z\\]\\{0,\\}'
console.log( rescape( '/^boop$/' ) );
// returns '/\\^boop\\$/'
console.log( rescape( '^boop$' ) );
// returns '\\^boop\\$'
console.log( rescape( '/(?:.*)/' ) );
// returns '/\\(\\?:\\.\\*\\)/'
console.log( rescape( '(?:.*)' ) );
// returns '\\(\\?:\\.\\*\\)'
console.log( rescape( '/(?:beep|boop)/' ) );
// returns '/\\(\\?:beep\\|boop\\)/'
console.log( rescape( '(?:beep|boop)' ) );
// returns '\\(\\?:beep\\|boop\\)'
To run the example code from the top-level application directory,
$ node ./examples/index.js
Tests
Unit
Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
License
Copyright
Copyright © 2015. Athan Reines.