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

    0.0.7 • Public • Published

    isFalsy

    NPM version Build Status Coverage Status

    Test if a value is falsy.

    Installation

    npm install @stdlib/assert-is-falsy

    Usage

    var isFalsy = require( '@stdlib/assert-is-falsy' );

    isFalsy( value )

    Tests if a value is a value which translates to false when evaluated in a boolean context.

    var bool = isFalsy( false );
    // returns true
    
    bool = isFalsy( '' );
    // returns true
    
    bool = isFalsy( 0 );
    // returns true
    
    bool = isFalsy( NaN );
    // returns true
    
    bool = isFalsy( null );
    // returns true
    
    bool = isFalsy( void 0 );
    // returns true
    
    bool = isFalsy( [] );
    // returns false

    Examples

    var isFalsy = require( '@stdlib/assert-is-falsy' );
    
    var bool = isFalsy( false );
    // returns true
    
    bool = isFalsy( 0 );
    // returns true
    
    bool = isFalsy( NaN );
    // returns true
    
    bool = isFalsy( '' );
    // returns true
    
    bool = isFalsy( void 0 );
    // returns true
    
    bool = isFalsy( null );
    // returns true
    
    bool = isFalsy( 'beep' );
    // returns false
    
    bool = isFalsy( 5 );
    // returns false
    
    bool = isFalsy( true );
    // returns false
    
    bool = isFalsy( [] );
    // returns false
    
    bool = isFalsy( {} );
    // returns false
    
    bool = isFalsy( function foo() {} );
    // returns false

    See Also


    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-falsy

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    72

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    36.7 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser