@stdlib/assert-is-uint32array

What is @stdlib/assert-is-uint32array?

@stdlib/assert-is-uint32array is a package that provides functionality to check if a value is a Uint32Array. This can be useful in various scenarios where type checking is necessary, especially when dealing with binary data or performing operations that require specific typed arrays.

What are @stdlib/assert-is-uint32array's main functionalities?

Check if a value is a Uint32Array

This feature allows you to check if a given value is a Uint32Array. The function returns true if the value is a Uint32Array and false otherwise.

const isUint32Array = require('@stdlib/assert-is-uint32array');

const arr = new Uint32Array(10);
console.log(isUint32Array(arr)); // true

const notArr = [1, 2, 3];
console.log(isUint32Array(notArr)); // false

Other packages similar to @stdlib/assert-is-uint32array

is-typedarray

The 'is-typedarray' package provides a function to check if a value is a typed array, including Uint32Array. It is more general than @stdlib/assert-is-uint32array as it can check for various types of typed arrays, not just Uint32Array.

typedarray-to-buffer

The 'typedarray-to-buffer' package converts typed arrays to Node.js Buffer objects. While it does not directly check if a value is a Uint32Array, it operates on typed arrays and can be used in conjunction with type-checking packages.

is-buffer

The 'is-buffer' package checks if a value is a Buffer. Although it is not specifically for Uint32Array, it is often used in environments where type checking for binary data structures is necessary.

README

isUint32Array

Test if a value is a Uint32Array.

Installation

npm install @stdlib/assert-is-uint32array

Usage

var isUint32Array = require( '@stdlib/assert-is-uint32array' );

isUint32Array( value )

Tests if a value is a Uint32Array.

var Uint32Array = require( '@stdlib/array-uint32' );

var bool = isUint32Array( new Uint32Array( 10 ) );
// returns true

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

Examples

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 isUint32Array = require( '@stdlib/assert-is-uint32array' );

var bool = isUint32Array( new Uint32Array( 10 ) );
// returns true

bool = isUint32Array( new Int8Array( 10 ) );
// returns false

bool = isUint32Array( new Uint8Array( 10 ) );
// returns false

bool = isUint32Array( new Uint8ClampedArray( 10 ) );
// returns false

bool = isUint32Array( new Int16Array( 10 ) );
// returns false

bool = isUint32Array( new Uint16Array( 10 ) );
// returns false

bool = isUint32Array( new Int32Array( 10 ) );
// returns false

bool = isUint32Array( new Float32Array( 10 ) );
// returns false

bool = isUint32Array( new Float64Array( 10 ) );
// returns false

bool = isUint32Array( new Array( 10 ) );
// returns false

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

bool = isUint32Array( null );
// 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.

---

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.

Changelog

0.0.2 (2021-06-15)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.0.1">