Test if a value is an Error object.
APACHE-2.0 License
Test if a value is an Error object.
npm install @stdlib/assert-is-error
Alternatively,
script
tag without installation and bundlers, use the ES Module available on the esm
branch (see README).deno
branch (see README for usage intructions).umd
branch (see README).The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var isError = require( '@stdlib/assert-is-error' );
Tests if a value
is an Error
object.
var bool = isError( new Error( 'beep' ) );
// returns true
var isError = require( '@stdlib/assert-is-error' );
var bool = isError( new Error( 'error' ) );
// returns true
bool = isError( new EvalError( 'eval error' ) );
// returns true
bool = isError( new RangeError( 'range error' ) );
// returns true
bool = isError( new ReferenceError( 'reference error' ) );
// returns true
bool = isError( new SyntaxError( 'syntax error' ) );
// returns true
bool = isError( new TypeError( 'type error' ) );
// returns true
bool = isError( new URIError( 'URI error' ) );
// returns true
bool = isError( {} );
// returns false
bool = isError( null );
// returns false
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.