Guarantees an array back


Keywords
to, convert, return, array, arrayify, javascript
License
MIT
Install
npm install array-back@3.1.0

Documentation

view on npm npm module downloads Build Status Coverage Status Dependency Status js-standard-style

array-back

Takes any input and guarantees an array back.

  • Converts array-like objects (e.g. arguments, Set) to a real array.
  • Converts undefined to an empty array.
  • Converts any another other, singular value (including null, objects and iterables other than Set) into an array containing that value.
  • Ignores input which is already an array.

Example

> const arrayify = require('array-back')

> arrayify(undefined)
[]

> arrayify(null)
[ null ]

> arrayify(0)
[ 0 ]

> arrayify([ 1, 2 ])
[ 1, 2 ]

> arrayify(new Set([ 1, 2 ]))
[ 1, 2 ]

> function f(){ return arrayify(arguments); }
> f(1,2,3)
[ 1, 2, 3 ]

arrayify(input) ⇒ Array

Kind: Exported function

Param Type Description
input * The input value to convert to an array

Load anywhere

This library is compatible with Node.js, the Web and any style of module loader. It can be loaded anywhere, natively without transpilation.

Node.js:

const arrayify = require('array-back')

Within Node.js with ECMAScript Module support enabled:

import arrayify from 'array-back'

Within an modern browser ECMAScript Module:

import arrayify from './node_modules/array-back/index.mjs'

Old browser (adds window.arrayBack):

<script nomodule src="./node_modules/array-back/dist/index.js"></script>

© 2015-19 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.