@stdlib/assert-is-regexp

isRegExp

Test if a value is a regular expression.

Installation

npm install @stdlib/assert-is-regexp

Usage

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

isRegExp( value )

Tests if a value is a regular expression.

var bool = isRegExp( /.+/ );
// returns true

bool = isRegExp( {} );
// returns false

Examples

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

var bool = isRegExp( /.+/ );
// returns true

bool = isRegExp( new RegExp( '.+' ) );
// returns true

bool = isRegExp( '/.+/' );
// returns false

bool = isRegExp( {} );
// returns false

bool = isRegExp( null );
// returns false

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.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.

Similar packages

Other packages similar to @stdlib/assert-is-regexp

is-regex

The 'is-regex' package provides a similar functionality to @stdlib/assert-is-regexp by checking if a value is a regular expression. It is a lightweight package and can be used as an alternative for simple type checking.

lodash.isregexp

The 'lodash.isregexp' package is part of the Lodash library, which is a utility library offering a wide range of functions. 'lodash.isregexp' specifically checks if a value is a regular expression. It is useful if you are already using Lodash in your project and want to leverage its consistent API.

core-util-is

The 'core-util-is' package is a part of Node.js's core utilities and provides various type-checking functions, including checking if a value is a regular expression. It is a good choice if you need a broader set of type-checking utilities in addition to regular expression checks.