# 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.
A collection is defined as either an [`Array`][mdn-array], [`Typed Array`][mdn-typed-array], or an array-like [`Object`][mdn-object] (excluding `strings` and `functions`).
## Installation
```bash
npm install @stdlib/assert-is-collection
```
## Usage
```javascript
var isCollection = require( '@stdlib/assert-is-collection' );
```
#### isCollection( value )
Tests if a value is a collection.
```javascript
var bool = isCollection( [] );
// 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 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
```
* * *
## 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-2022. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-is-collection.svg
[npm-url]: https://npmjs.org/package/@stdlib/assert-is-collection
[test-image]: https://github.com/stdlib-js/assert-is-collection/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/assert-is-collection/actions/workflows/test.yml
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-collection/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-collection?branch=main
[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/assert-is-collection/tree/deno
[umd-url]: https://github.com/stdlib-js/assert-is-collection/tree/umd
[esm-url]: https://github.com/stdlib-js/assert-is-collection/tree/esm
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-collection/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
[@stdlib/assert/is-array-like]: https://www.npmjs.com/package/@stdlib/assert-is-array-like