@stdlib/assert-is-error
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    isError

    NPM version Build Status Coverage Status dependencies

    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.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/assert-is-error

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    8,255

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    35.8 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser