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

0.2.1 • Public • Published
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

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-2024. The Stdlib Authors.

Dependencies (0)

    Dev Dependencies (0)

      Package Sidebar

      Install

      npm i @stdlib/assert-is-falsy

      Homepage

      stdlib.io

      Weekly Downloads

      17

      Version

      0.2.1

      License

      Apache-2.0

      Unpacked Size

      25.8 kB

      Total Files

      11

      Last publish

      Collaborators

      • stdlib-bot
      • kgryte
      • planeshifter
      • rreusser