@stdlib/assert-is-uint8array

What is @stdlib/assert-is-uint8array?

@stdlib/assert-is-uint8array is a utility package that provides functionality to check if a value is a Uint8Array. This can be useful in various scenarios where type checking is necessary, especially when dealing with binary data.

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

Check if a value is a Uint8Array

This feature allows you to check if a given value is a Uint8Array. In the code sample, a new Uint8Array is created and passed to the isUint8Array function, which returns true.

const isUint8Array = require('@stdlib/assert-is-uint8array');

const buffer = new Uint8Array(10);
const result = isUint8Array(buffer);
console.log(result); // true

Check if a value is not a Uint8Array

This feature allows you to check if a given value is not a Uint8Array. In the code sample, an array is passed to the isUint8Array function, which returns false.

const isUint8Array = require('@stdlib/assert-is-uint8array');

const notBuffer = [1, 2, 3];
const result = isUint8Array(notBuffer);
console.log(result); // false

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

is-typedarray

The 'is-typedarray' package provides a function to check if a value is a typed array, including Uint8Array. It is more general than @stdlib/assert-is-uint8array as it supports multiple typed array types.

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!

isUint8Array

Test if a value is a Uint8Array.

Installation

npm install @stdlib/assert-is-uint8array

Usage

var isUint8Array = require( '@stdlib/assert-is-uint8array' );

isUint8Array( value )

Tests if a value is a Uint8Array.

var Uint8Array = require( '@stdlib/array-uint8' );

var bool = isUint8Array( new Uint8Array( 10 ) );
// returns true

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

var bool = isUint8Array( new Uint8Array( 10 ) );
// returns true

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

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

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

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

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

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

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

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

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

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

bool = isUint8Array( null );
// returns false

---

See Also

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

---

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">