isAccessorArray
Test if an array-like object supports 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.
Usage
var isAccessorArray = require( '@stdlib/array/base/assert/is-accessor-array' );
isAccessorArray( value )
Tests if an array-like object supports 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/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