# isRegExpString
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Test if a value is a regular expression string.
## Installation
```bash
npm install @stdlib/assert-is-regexp-string
```
## Usage
```javascript
var isRegExpString = require( '@stdlib/assert-is-regexp-string' );
```
#### isRegExpString( value )
Tests if a `value` is a regular expression `string`.
```javascript
var bool = isRegExpString( '/^beep$/' );
// returns true
```
## Examples
```javascript
var isRegExpString = require( '@stdlib/assert-is-regexp-string' );
var bool;
bool = isRegExpString( '/beep/' );
// returns true
bool = isRegExpString( '/beep/gim' );
// returns true
bool = isRegExpString( 'beep' );
// returns false
bool = isRegExpString( '' );
// returns false
bool = isRegExpString( null );
// returns false
```
* * *
## CLI
## Installation
To use the module as a general utility, install the module globally
```bash
npm install -g @stdlib/assert-is-regexp-string
```
### Usage
```text
Usage: is-regexp-string [options] []
Options:
-h, --help Print this message.
-V, --version Print the package version.
```
### Examples
```bash
$ is-regexp-string '/beep/'
true
```
To use as a [standard stream][standard-streams],
```bash
$ echo -n '/beep/' | is-regexp-string
true
```
* * *
## 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/assert-is-regexp-string.svg
[npm-url]: https://npmjs.org/package/@stdlib/assert-is-regexp-string
[test-image]: https://github.com/stdlib-js/assert-is-regexp-string/actions/workflows/test.yml/badge.svg?branch=v0.0.9
[test-url]: https://github.com/stdlib-js/assert-is-regexp-string/actions/workflows/test.yml?query=branch:v0.0.9
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-regexp-string/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-regexp-string?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/assert-is-regexp-string/tree/deno
[umd-url]: https://github.com/stdlib-js/assert-is-regexp-string/tree/umd
[esm-url]: https://github.com/stdlib-js/assert-is-regexp-string/tree/esm
[branches-url]: https://github.com/stdlib-js/assert-is-regexp-string/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-regexp-string/main/LICENSE
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
[@stdlib/assert/is-regexp]: https://www.npmjs.com/package/@stdlib/assert-is-regexp