@stdlib/assert-is-regexp

What is @stdlib/assert-is-regexp?

@stdlib/assert-is-regexp is a utility package that provides functionality to check if a value is a regular expression object. This can be useful in various scenarios where type checking is necessary, especially when dealing with dynamic data or inputs.

What are @stdlib/assert-is-regexp's main functionalities?

Check if a value is a regular expression

This feature allows you to check if a given value is a regular expression. It returns true if the value is a RegExp object, and false otherwise.

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

console.log(isRegExp(/abc/)); // true
console.log(isRegExp(new RegExp('abc'))); // true
console.log(isRegExp('abc')); // false

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.

README

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

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-2024. The Stdlib Authors.

Changelog

0.2.2 (2024-07-27)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.2.1">