RegExp String
Escapes a regular expression string or pattern.
Installation
$ npm install utils-escape-regex-string
Usage
var rescape = ;
rescape( str )
Escapes a regular expression string
or pattern.
var str = ;// returns '/\\[A\\-Z\\]\\*/'str = ;// returns '\\[A\\-Z\\]\\*'
If provided a value which is not a primitive string
, the function throws a TypeError
.
try// throws...var str = ;catch errconsole;
Examples
var rescape = ;console;// returns '/beep/'console;// returns 'beep'console;// returns '/\\[A\\-Z\\]\\*/'console;// returns '\\[A\\-Z\\]\\*'console;// returns '/\\\\\\\//ig'console;// returns '\\\\\\\/'console;// returns '/\\[A\\-Z\\]\\{0,\\}/'console;// returns '\\[A\\-Z\\]\\{0,\\}'console;// returns '/\\^boop\\$/'console;// returns '\\^boop\\$'console;// returns '/\\(\\?:\\.\\*\\)/'console;// returns '\\(\\?:\\.\\*\\)'console;// returns '/\\(\\?:beep\\|boop\\)/'console;// 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.