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!
isAccessorArray
Test if a value is an array-like object supporting the accessor (get/set) protocol.
An accessor array is defined as either an Array, Typed Array, or an array-like Object (excluding strings and functions) having get and set methods for accessing array elements.
Installation
npm install @stdlib/assert-is-accessor-array
Usage
var isAccessorArray = require( '@stdlib/assert-is-accessor-array' );
isAccessorArray( value )
Tests if a value is an array-like object supporting the accessor (get/set) protocol.
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
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/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
bool = isAccessorArray( {} );
// returns false
bool = isAccessorArray( 'beep' );
// returns false
bool = isAccessorArray( isAccessorArray );
// returns false
bool = isAccessorArray( null );
// returns false
bool = isAccessorArray( void 0 );
// returns false
bool = isAccessorArray( 3.14 );
// 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.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.
