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

isEven

Test if a value is an even number.

Usage

var isEven = require( '@stdlib/assert/is-even' );

isEven( value )

Tests if a value is an even number.

var Number = require( '@stdlib/number/ctor' );

var bool = isEven( 6.0 );
// returns true

bool = isEven( new Number( 6.0 ) );
// returns true

bool = isEven( 3.0 );
// returns false

bool = isEven( -3.14 );
// returns false

bool = isEven( null );
// returns false

bool = isEven( NaN );
// returns false

isEven.isPrimitive( value )

Tests if a value is a primitive even number.

var Number = require( '@stdlib/number/ctor' );

var bool = isEven.isPrimitive( -4.0 );
// returns true

bool = isEven.isPrimitive( new Number( -4.0 ) );
// returns false

isEven.isObject( value )

Tests if a value is a Number object having an even number value.

var Number = require( '@stdlib/number/ctor' );

var bool = isEven.isObject( 4.0 );
// returns false

bool = isEven.isObject( new Number( 4.0 ) );
// returns true

Examples

var Number = require( '@stdlib/number/ctor' );
var isEven = require( '@stdlib/assert/is-even' );

var bool = isEven( 4.0 );
// returns true

bool = isEven( 0.0 );
// returns true

bool = isEven( new Number( 4 ) );
// returns true

bool = isEven( 5.0 );
// returns false

bool = isEven( NaN );
// returns false

bool = isEven( '5' );
// returns false

bool = isEven( null );
// returns false