Package Exports

@stdlib/assert-is-error

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/assert-is-error) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

isError

Test if a value is an Error object.

Installation

npm install @stdlib/assert-is-error

Usage

var isError = require( '@stdlib/assert-is-error' );

isError( value )

Tests if a value is an Error object.

var bool = isError( new Error( 'beep' ) );
// returns true

Examples

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

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.

License

See LICENSE.

@stdlib/assert-is-error