包详细信息

@stdlib/array-base-assert-is-accessor-array

stdlib-js63.5kApache-2.00.2.2

Test if an array-like object supports the accessor (get/set) protocol.

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!

isAccessorArray

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

Test if an array-like object supports the accessor (get/set) protocol.

An accessor array is defined as either an [Array][mdn-array], [Typed Array][mdn-typed-array], or an array-like [Object][mdn-object] (excluding strings and functions) having get and set methods for accessing array elements.
## Installation bash npm install @stdlib/array-base-assert-is-accessor-array
## Usage javascript var isAccessorArray = require( '@stdlib/array-base-assert-is-accessor-array' ); #### isAccessorArray( value ) Tests if an array-like object supports the accessor (get/set) protocol. javascript var Complex128Array = require( '@stdlib/array-complex128' ); var Complex128 = require( '@stdlib/complex-float64-ctor' ); // Create a new complex number array: var arr = new Complex128Array( 10 ); // Retrieve a complex number element: var z = arr.get( 0 ); // returns <Complex128> // Set a complex number element: arr.set( new Complex128( 1.0, 1.0 ), 0 ); // ... // Check whether an array is an accessor array: var bool = isAccessorArray( arr ); // returns true
## 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 Complex128Array = require( '@stdlib/array-complex128' ); var Complex64Array = require( '@stdlib/array-complex64' ); var isAccessorArray = require( '@stdlib/array-base-assert-is-accessor-array' ); var bool = isAccessorArray( new Complex128Array( 10 ) ); // returns true bool = isAccessorArray( new Complex64Array( 10 ) ); // returns true bool = isAccessorArray( [] ); // returns false bool = isAccessorArray( new Float64Array( 10 ) ); // returns false bool = isAccessorArray( new Float32Array( 10 ) ); // returns false bool = isAccessorArray( new Int32Array( 10 ) ); // returns false bool = isAccessorArray( new Uint32Array( 10 ) ); // returns false bool = isAccessorArray( new Int16Array( 10 ) ); // returns false bool = isAccessorArray( new Uint16Array( 10 ) ); // returns false bool = isAccessorArray( new Int8Array( 10 ) ); // returns false bool = isAccessorArray( new Uint8Array( 10 ) ); // returns false bool = isAccessorArray( new Uint8ClampedArray( 10 ) ); // returns false bool = isAccessorArray( { 'length': 0 } ); // returns false
* ## 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/array-base-assert-is-accessor-array.svg [npm-url]: https://npmjs.org/package/@stdlib/array-base-assert-is-accessor-array [test-image]: https://github.com/stdlib-js/array-base-assert-is-accessor-array/actions/workflows/test.yml/badge.svg?branch=v0.2.2 [test-url]: https://github.com/stdlib-js/array-base-assert-is-accessor-array/actions/workflows/test.yml?query=branch:v0.2.2 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-assert-is-accessor-array/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/array-base-assert-is-accessor-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/array-base-assert-is-accessor-array/tree/deno [deno-readme]: https://github.com/stdlib-js/array-base-assert-is-accessor-array/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/array-base-assert-is-accessor-array/tree/umd [umd-readme]: https://github.com/stdlib-js/array-base-assert-is-accessor-array/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/array-base-assert-is-accessor-array/tree/esm [esm-readme]: https://github.com/stdlib-js/array-base-assert-is-accessor-array/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/array-base-assert-is-accessor-array/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-assert-is-accessor-array/main/LICENSE [mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray [mdn-object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object