@stdlib/assert-is-uint16array

What is @stdlib/assert-is-uint16array?

The @stdlib/assert-is-uint16array package is a utility for checking if a value is a Uint16Array. It is part of the larger @stdlib library, which provides a wide range of utilities for scientific computing in JavaScript.

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

Check if a value is a Uint16Array

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

const isUint16Array = require('@stdlib/assert-is-uint16array');

const arr = new Uint16Array(10);
console.log(isUint16Array(arr)); // true

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

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

is-typedarray

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

typedarray-to-buffer

The typedarray-to-buffer package converts typed arrays to Node.js Buffer objects. While it does not specifically check if a value is a Uint16Array, it works with Uint16Array and other typed arrays, providing additional functionality for handling typed arrays.

is-buffer

The is-buffer package checks if a value is a Buffer object. Although it does not directly check for Uint16Array, it is often used in conjunction with typed arrays in Node.js environments.

README

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

isUint16Array

Test if a value is a Uint16Array.

Installation

npm install @stdlib/assert-is-uint16array

Usage

var isUint16Array = require( '@stdlib/assert-is-uint16array' );

isUint16Array( value )

Tests if a value is a Uint16Array.

var Uint16Array = require( '@stdlib/array-uint16' );

var bool = isUint16Array( new Uint16Array( 10 ) );
// returns true

bool = isUint16Array( [] );
// 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 isUint16Array = require( '@stdlib/assert-is-uint16array' );

var bool = isUint16Array( new Uint16Array( 10 ) );
// returns true

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

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

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

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

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

bool = isUint16Array( new Uint32Array( 10 ) );
// returns false

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

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

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

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

bool = isUint16Array( null );
// returns false

---

See Also

• @stdlib/assert-is-typed-array: test if a value is a typed array.
• @stdlib/assert-is-uint32array: test if a value is a Uint32Array.
• @stdlib/assert-is-uint8array: test if a value is a Uint8Array.

---

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.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.2.2 (2024-07-27)

No changes reported for this release.

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