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

    0.0.7 • Public • Published

    isSyntaxError

    NPM version Build Status Coverage Status dependencies

    Test if a value is a SyntaxError object.

    Installation

    npm install @stdlib/assert-is-syntax-error

    Usage

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

    isSyntaxError( value )

    Tests if a value is a SyntaxError object.

    var bool = isSyntaxError( new SyntaxError( 'beep' ) );
    // returns true

    Notes

    • This function should not be considered robust. While the function should always return true if provided a SyntaxError (or a descendant) object, false positives may occur due to the fact that the SyntaxError constructor inherits from Error and has no internal class of its own. Hence, SyntaxError impersonation is possible.

    Examples

    var isSyntaxError = require( '@stdlib/assert-is-syntax-error' );
    
    var bool = isSyntaxError( new SyntaxError( 'syntax error' ) );
    // returns true
    
    bool = isSyntaxError( new Error( 'error' ) );
    // returns false
    
    bool = isSyntaxError( new EvalError( 'eval error' ) );
    // returns false
    
    bool = isSyntaxError( new ReferenceError( 'reference error' ) );
    // returns false
    
    bool = isSyntaxError( new RangeError( 'range error' ) );
    // returns false
    
    bool = isSyntaxError( new TypeError( 'type error' ) );
    // returns false
    
    bool = isSyntaxError( new URIError( 'URI error' ) );
    // returns false
    
    bool = isSyntaxError( {} );
    // returns false
    
    bool = isSyntaxError( 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-syntax-error

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    16

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    37.6 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser