Test if a value is a collection.
A collection is defined as either an Array
, Typed Array
, or an array-like Object
(excluding strings
and functions
).
npm install @devtea2027/reiciendis-quas-at-saepe
Alternatively,
script
tag without installation and bundlers, use the ES Module available on the esm
branch (see README).deno
branch (see README for usage intructions).umd
branch (see README).The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var isCollection = require( '@devtea2027/reiciendis-quas-at-saepe' );
Tests if a value is a collection.
var bool = isCollection( [] );
// returns true
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( '@devtea2027/reiciendis-quas-at-saepe' );
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
: test if a value is array-like.
@stdlib/assert-is-array-like-object
: test if a value is an array-like object.
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.