History

NunoSempere b6addc7f05 feat: add the node modules Necessary in order to clearly see the squiggle hotwiring.		2022-12-03 12:44:49 +00:00
..
docs	feat: add the node modules	2022-12-03 12:44:49 +00:00
lib	feat: add the node modules	2022-12-03 12:44:49 +00:00
package.json	feat: add the node modules	2022-12-03 12:44:49 +00:00
README.md	feat: add the node modules	2022-12-03 12:44:49 +00:00

README.md

isBigInt

Test if a value is a BigInt.

Usage

var isBigInt = require( '@stdlib/assert/is-bigint' );

isBigInt( value )

Tests if a value is a BigInt.

var BigInt = require( '@stdlib/bigint/ctor' );

var bool = isBigInt( BigInt( '1' ) );
// returns true

bool = isBigInt( Object( BigInt( '1' ) ) );
// returns true

isBigInt.isPrimitive( value )

Tests if a value is a primitive BigInt.

var BigInt = require( '@stdlib/bigint/ctor' );

var bool = isBigInt.isPrimitive( BigInt( '1' ) );
// returns true

bool = isBigInt.isPrimitive( Object( BigInt( '1' ) ) );
// returns false

isBigInt.isObject( value )

Tests if a value is a BigInt object.

var BigInt = require( '@stdlib/bigint/ctor' );

var bool = isBigInt.isObject( BigInt( '1' ) );
// returns false

bool = isBigInt.isObject( Object( BigInt( '1' ) ) );
// returns true

Examples

var hasBigIntSupport = require( '@stdlib/assert/has-bigint-support' );
var BigInt = require( '@stdlib/bigint/ctor' );
var isBigInt = require( '@stdlib/assert/is-bigint' );

var bool;
if ( hasBigIntSupport() ) {
    bool = isBigInt( BigInt( '1' ) );
    // returns true
} else {
    console.log( 'Environment does not support BigInts.' );
}
bool = isBigInt( 1 );
// returns false

bool = isBigInt( '1' );
// returns false

bool = isBigInt( {} );
// returns false

bool = isBigInt( [] );
// returns false

bool = isBigInt( null );
// returns false

bool = isBigInt( void 0 );
// returns false

bool = isBigInt( true );
// returns false

bool = isBigInt( function foo() {} );
// returns false