README

isBigInt

Test if a value is a BigInt.

Installation

npm install @stdlib/assert-is-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

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

License

See LICENSE.

@stdlib/assert-is-bigint

Usage no npm install needed!