Checks whether a value is an array or not.


Keywords
array, is-array, type, datatype, fav
License
MIT
Install
npm install @fav/type.is-array@1.0.2

Documentation

@fav/type.is-array NPM MIT License Build Status Build Status Coverage status

Checks whether a value is an array or not.

"fav" is an abbreviation of "favorite" and also the acronym of "for all versions". This package is intended to support all Node.js versions and many browsers as possible. At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.

Install

To install from npm:

$ npm install --save @fav/type.is-array

NOTE: npm < 2.7.0 does not support scoped package, but old version Node.js supports it. So when you use such older npm, you should download this package from github.com, and move it in node_modules/@fav/type.is-array/ directory manually.

Usage

For Node.js:

var isArray = require('@fav/type.is-array');
isArray([1, 2, 3]); // => true
isArray.not([1, 2, 3]); // => false

For Web browsers:

<script src="fav.type.is-array.min.js"></script>
<script>
var isArray = fav.type.isArray;
isArray([1, 2, 3]); // => true
isArray.not([1, 2, 3]); // => false
</script>

API

isArray(value) : boolean

Checks if value is an array.

This function returns false for typed-arrays, e.g. Int16Array.

Parameter:

Parameter Type Description
value any The value to be checked.

Return:

True, if value is an array.

Type: boolean

isArray.not(value) : boolean

Checks if value is not an array.

This function returns true for typed-arrays, e.g. Int16Array.

Parameter:

Parameter Type Description
value any The value to be checked.

Return:

True, if value is not an array.

Type: boolean

Checked

Node.js (4〜)

Platform 4 5 6 7 8 9 10
macOS
Windows10
Linux

io.js (1〜3)

Platform 1 2 3
macOS
Windows10
Linux

Node.js (〜0.12)

Platform 0.8 0.9 0.10 0.11 0.12
macOS
Windows10
Linux

Web browsers

Platform Chrome Firefox Vivaldi Safari Edge IE11
macOS -- --
Windows10 --
Linux -- -- --

License

Copyright (C) 2017-2018 Takayuki Sato

This program is free software under MIT License. See the file LICENSE in this distribution for more details.