@stdlib/assert-is-regexp-string

isRegExpString

Test if a value is a regular expression string.

Installation

npm install @stdlib/assert-is-regexp-string

Usage

var isRegExpString = require( '@stdlib/assert-is-regexp-string' );

isRegExpString( value )

Tests if a value is a regular expression string.

var bool = isRegExpString( '/^beep$/' );
// returns true

Examples

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

npm install -g @stdlib/assert-is-regexp-string

Usage

Usage: is-regexp-string [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ is-regexp-string '/beep/'
true

To use as a standard stream,

$ echo -n '/beep/' | is-regexp-string
true

---

Notice

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.

---

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.