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!
isCollection
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
Test if a value is a collection.
Array
][mdn-array], [Typed Array
][mdn-typed-array], or an array-like [Object
][mdn-object] (excluding strings
and functions
).
bash
npm install @stdlib/assert-is-collection
javascript
var isCollection = require( '@stdlib/assert-is-collection' );
#### isCollection( value )
Tests if a value is a collection.
javascript
var bool = isCollection( [] );
// returns true
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 isCollection = require( '@stdlib/assert-is-collection' );
var bool = isCollection( [] );
// returns true
bool = isCollection( new Float64Array( 10 ) );
// returns true
bool = isCollection( new Float32Array( 10 ) );
// returns true
bool = isCollection( new Int32Array( 10 ) );
// returns true
bool = isCollection( new Uint32Array( 10 ) );
// returns true
bool = isCollection( new Int16Array( 10 ) );
// returns true
bool = isCollection( new Uint16Array( 10 ) );
// returns true
bool = isCollection( new Int8Array( 10 ) );
// returns true
bool = isCollection( new Uint8Array( 10 ) );
// returns true
bool = isCollection( new Uint8ClampedArray( 10 ) );
// returns true
bool = isCollection( { 'length': 0 } );
// returns true
bool = isCollection( {} );
// returns false
bool = isCollection( 'beep' );
// returns false
bool = isCollection( isCollection );
// returns false
bool = isCollection( null );
// returns false
bool = isCollection( void 0 );
// returns false
bool = isCollection( 3.14 );
// returns false
@stdlib/assert-is-array-like
][@stdlib/assert/is-array-like]: test if a value is array-like.
- [@stdlib/assert-is-array-like-object
][@stdlib/assert/is-array-like-object]: test if a value is an array-like object.