包详细信息

@stdlib/assert-is-typed-array

stdlib-js61kApache-2.00.2.2

Test if a value is a typed array.

stdlib, stdassert, assertion, assert

自述文件

<summary> About stdlib... </summary>

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!

isTypedArray

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

Test if a value is a [typed array][mdn-typed-array].

## Installation bash npm install @stdlib/assert-is-typed-array
## Usage javascript var isTypedArray = require( '@stdlib/assert-is-typed-array' ); #### isTypedArray( value ) Tests if a value is a [typed array][mdn-typed-array]. javascript var Int8Array = require( '@stdlib/array-int8' ); var bool = isTypedArray( new Int8Array( 10 ) ); // returns true bool = isTypedArray( [] ); // returns false
## Examples 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 isTypedArray = require( '@stdlib/assert-is-typed-array' ); var arr = new Int8Array( 10 ); var bool = isTypedArray( arr ); // returns true arr = new Uint8Array( 10 ); bool = isTypedArray( arr ); // returns true arr = new Uint8ClampedArray( 10 ); bool = isTypedArray( arr ); // returns true arr = new Int16Array( 10 ); bool = isTypedArray( arr ); // returns true arr = new Uint16Array( 10 ); bool = isTypedArray( arr ); // returns true arr = new Int32Array( 10 ); bool = isTypedArray( arr ); // returns true arr = new Uint32Array( 10 ); bool = isTypedArray( arr ); // returns true arr = new Float32Array( 10 ); bool = isTypedArray( arr ); // returns true arr = new Float64Array( 10 ); bool = isTypedArray( arr ); // returns true bool = isTypedArray( [] ); // returns false bool = isTypedArray( {} ); // returns false bool = isTypedArray( null ); // returns false
* ## See Also - [@stdlib/assert-is-array][@stdlib/assert/is-array]: test if a value is an array. - [@stdlib/assert-is-typed-array-like][@stdlib/assert/is-typed-array-like]: test if a value is typed-array-like.
* ## Notice This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-is-typed-array.svg [npm-url]: https://npmjs.org/package/@stdlib/assert-is-typed-array [test-image]: https://github.com/stdlib-js/assert-is-typed-array/actions/workflows/test.yml/badge.svg?branch=v0.2.2 [test-url]: https://github.com/stdlib-js/assert-is-typed-array/actions/workflows/test.yml?query=branch:v0.2.2 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-typed-array/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/assert-is-typed-array?branch=main [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im [stdlib]: https://github.com/stdlib-js/stdlib [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors [umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules [deno-url]: https://github.com/stdlib-js/assert-is-typed-array/tree/deno [deno-readme]: https://github.com/stdlib-js/assert-is-typed-array/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/assert-is-typed-array/tree/umd [umd-readme]: https://github.com/stdlib-js/assert-is-typed-array/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/assert-is-typed-array/tree/esm [esm-readme]: https://github.com/stdlib-js/assert-is-typed-array/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/assert-is-typed-array/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-typed-array/main/LICENSE [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Typed_arrays [@stdlib/assert/is-array]: https://www.npmjs.com/package/@stdlib/assert-is-array [@stdlib/assert/is-typed-array-like]: https://www.npmjs.com/package/@stdlib/assert-is-typed-array-like