# RegExp String
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Regular expression][regexp] to parse a [regular expression][regexp] string.
## Installation
```bash
npm install @stdlib/regexp-regexp
```
## Usage
```javascript
var reRegExp = require( '@stdlib/regexp-regexp' );
```
#### reRegExp()
Returns a [regular expression][regexp] to parse a [regular expression][regexp] `string`.
```javascript
var RE_REGEXP = reRegExp();
var bool = RE_REGEXP.test( '/^beep$/' );
// returns true
bool = RE_REGEXP.test( '' );
// returns false
var parts = RE_REGEXP.exec( '/^.*$/ig' );
// returns [ '/^.*$/ig', '^.*$', 'ig', 'index': 0, 'input': '/^.*$/ig' ]
```
[Regular expression][regexp] strings should be escaped.
```javascript
var RE_REGEXP = reRegExp();
var bool = RE_REGEXP.test( '/^\/([^\/]+)\/(.*)$/' );
// returns false
bool = RE_REGEXP.test( '/^\\/([^\\/]+)\\/(.*)$/' );
// returns true
```
#### reRegExp.REGEXP
[Regular expression][regexp] to parse a [regular expression][regexp] `string`.
```javascript
var bool = reRegExp.REGEXP.test( '/^beep$/' );
// returns true
```
## Examples
```javascript
var reRegExp = require( '@stdlib/regexp-regexp' );
var RE_REGEXP = reRegExp();
var bool = RE_REGEXP.test( '/beep/' );
// returns true
bool = RE_REGEXP.test( '/^.*$/ig' );
// returns true
bool = RE_REGEXP.test( '/^\\/([^\\/]+)\\/(.*)$/' );
// returns true
bool = RE_REGEXP.test( '/^\/([^\/]+)\/(.*)$/' );
// returns false
bool = RE_REGEXP.test( '/boop' );
// returns false
bool = RE_REGEXP.test( '' );
// returns false
```
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/regexp-regexp.svg
[npm-url]: https://npmjs.org/package/@stdlib/regexp-regexp
[test-image]: https://github.com/stdlib-js/regexp-regexp/actions/workflows/test.yml/badge.svg?branch=v0.0.8
[test-url]: https://github.com/stdlib-js/regexp-regexp/actions/workflows/test.yml?query=branch:v0.0.8
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/regexp-regexp/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/regexp-regexp?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/regexp-regexp/tree/deno
[umd-url]: https://github.com/stdlib-js/regexp-regexp/tree/umd
[esm-url]: https://github.com/stdlib-js/regexp-regexp/tree/esm
[branches-url]: https://github.com/stdlib-js/regexp-regexp/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/regexp-regexp/main/LICENSE
[regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[@stdlib/utils/regexp-from-string]: https://www.npmjs.com/package/@stdlib/utils-regexp-from-string