Narcoleptic Programmers' Medicine

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

    0.0.9 • Public • Published

    isSymbol

    NPM version Build Status Coverage Status

    Test if a value is a symbol.

    Installation

    npm install @stdlib/assert-is-symbol

    Usage

    var isSymbol = require( '@stdlib/assert-is-symbol' );

    isSymbol( value )

    Tests if a value is a symbol.

    var Symbol = require( '@stdlib/symbol-ctor' );
    
    var bool = isSymbol( Symbol( 'beep' ) );
    // returns true
    
    bool = isSymbol( Object( Symbol( 'beep' ) ) );
    // returns true

    isSymbol.isPrimitive( value )

    Tests if a value is a primitive symbol.

    var Symbol = require( '@stdlib/symbol-ctor' );
    
    var bool = isSymbol.isPrimitive( Symbol( 'beep' ) );
    // returns true
    
    bool = isSymbol.isPrimitive( Object( Symbol( 'boop' ) ) );
    // returns false

    isSymbol.isObject( value )

    Tests if a value is a Symbol object.

    var Symbol = require( '@stdlib/symbol-ctor' );
    
    var bool = isSymbol.isObject( Symbol( 'beep' ) );
    // returns false
    
    bool = isSymbol.isObject( Object( Symbol( 'boop' ) ) );
    // returns true

    Examples

    var hasSymbolSupport = require( '@stdlib/assert-has-symbol-support' );
    var Symbol = require( '@stdlib/symbol-ctor' );
    var isSymbol = require( '@stdlib/assert-is-symbol' );
    
    var bool;
    if ( hasSymbolSupport() ) {
        bool = isSymbol( Symbol( 'beep' ) );
        // returns true
    } else {
        console.log( 'Environment does not support symbols.' );
    }
    bool = isSymbol( 'beep' );
    // returns false
    
    bool = isSymbol( {} );
    // returns false
    
    bool = isSymbol( [] );
    // returns false
    
    bool = isSymbol( null );
    // returns false
    
    bool = isSymbol( void 0 );
    // returns false
    
    bool = isSymbol( true );
    // returns false
    
    bool = isSymbol( function foo() {} );
    // 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-2022. The Stdlib Authors.

    Install

    npm i @stdlib/assert-is-symbol

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    113

    Version

    0.0.9

    License

    Apache-2.0

    Unpacked Size

    33.2 kB

    Total Files

    15

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser