isRegExpString

Test if a value is a regular expression 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

Usage

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

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.

Notes

If the split separator is a regular expression, ensure that the split option is either properly escaped or enclosed in quotes.

# Not escaped...
$ echo -n $'beEp booP\n/beep/' | is-regexp-string --split /\r?\n/
# Escaped...
$ echo -n $'beEp booP\n/beep/' | is-regexp-string --split /\\r?\\n/

The implementation ignores trailing delimiters.

Examples

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

To use as a standard stream,

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

By default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.

$ echo -n 'beep\t/boop/' | is-regexp-string --split '\t'
false
true