time-to-botec/js/node_modules/@stdlib/assert/is-bigint64array/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

122 lines
2.8 KiB
Markdown

<!--
@license Apache-2.0
Copyright (c) 2021 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
# isBigInt64Array
> Test if a value is a [BigInt64Array][mdn-bigint64array].
<section class="usage">
## Usage
```javascript
var isBigInt64Array = require( '@stdlib/assert/is-bigint64array' );
```
#### isBigInt64Array( value )
Tests if a value is a [`BigInt64Array`][mdn-bigint64array].
<!-- eslint-disable stdlib/require-globals, no-undef -->
```javascript
var bool = isBigInt64Array( new BigInt64Array( 10 ) );
// returns true
bool = isBigInt64Array( [] );
// returns false
```
</section>
<!-- /.usage -->
<section class="examples">
## Examples
<!-- eslint no-undef: "error" -->
<!-- eslint-disable stdlib/require-globals, no-undef -->
```javascript
var Int8Array = require( '@stdlib/array/int8' );
var Uint8Array = require( '@stdlib/array/uint8' );
var Uint8ClampedArray = require( '@stdlib/array/uint8c' );
var Int16Array = require( '@stdlib/array/int16' );
var Uint16Array = require( '@stdlib/array/uint16' );
var Int32Array = require( '@stdlib/array/int32' );
var Uint32Array = require( '@stdlib/array/uint32' );
var Float32Array = require( '@stdlib/array/float32' );
var Float64Array = require( '@stdlib/array/float64' );
var isBigInt64Array = require( '@stdlib/assert/is-bigint64array' );
var bool = isBigInt64Array( new BigInt64Array( 10 ) );
// returns true
bool = isBigInt64Array( new Int8Array( 10 ) );
// returns false
bool = isBigInt64Array( new Uint8Array( 10 ) );
// returns false
bool = isBigInt64Array( new Uint8ClampedArray( 10 ) );
// returns false
bool = isBigInt64Array( new Int16Array( 10 ) );
// returns false
bool = isBigInt64Array( new Uint16Array( 10 ) );
// returns false
bool = isBigInt64Array( new Int32Array( 10 ) );
// returns false
bool = isBigInt64Array( new Uint32Array( 10 ) );
// returns false
bool = isBigInt64Array( new Float64Array( 10 ) );
// returns false
bool = isBigInt64Array( new Float32Array( 10 ) );
// returns false
bool = isBigInt64Array( new Array( 10 ) );
// returns false
bool = isBigInt64Array( {} );
// returns false
bool = isBigInt64Array( null );
// returns false
```
</section>
<!-- /.examples -->
<section class="links">
[mdn-bigint64array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt64Array
</section>
<!-- /.links -->