time-to-botec/js/node_modules/@stdlib/assert/is-falsy/README.md

isFalsy

Test if a value 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