Test if a value is an Error object.
npm install @stdlib/assert-is-errorAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var isError = require( '@stdlib/assert-is-error' );Tests if a value is an Error object.
var bool = isError( new Error( 'beep' ) );
// returns truevar 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 falseThis 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-2023. The Stdlib Authors.
