82 lines
2.3 KiB
Markdown
82 lines
2.3 KiB
Markdown
|
[](https://www.npmjs.org/package/array-back)
|
||
|
|
[](https://www.npmjs.org/package/array-back)
|
||
|
|
[](https://travis-ci.org/75lb/array-back)
|
||
|
|
[](https://coveralls.io/github/75lb/array-back?branch=master)
|
||
|
|
[](https://david-dm.org/75lb/array-back)
|
||
|
|
[](https://github.com/feross/standard)
|
||
|
|
|
||
|
|
<a name="module_array-back"></a>
|
||
|
|
|
||
|
|
## 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**
|
||
|
|
```js
|
||
|
|
> 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 ]
|
||
|
|
```
|
||
|
|
<a name="exp_module_array-back--arrayify"></a>
|
||
|
|
|
||
|
|
### arrayify(input) ⇒ <code>Array</code> ⏏
|
||
|
|
**Kind**: Exported function
|
||
|
|
|
||
|
|
| Param | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| input | <code>\*</code> | 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:
|
||
|
|
|
||
|
|
```js
|
||
|
|
const arrayify = require('array-back')
|
||
|
|
```
|
||
|
|
|
||
|
|
Within Node.js with ECMAScript Module support enabled:
|
||
|
|
|
||
|
|
```js
|
||
|
|
import arrayify from 'array-back'
|
||
|
|
```
|
||
|
|
|
||
|
|
Within an modern browser ECMAScript Module:
|
||
|
|
|
||
|
|
```js
|
||
|
|
import arrayify from './node_modules/array-back/index.mjs'
|
||
|
|
```
|
||
|
|
|
||
|
|
Old browser (adds `window.arrayBack`):
|
||
|
|
|
||
|
|
```html
|
||
|
|
<script nomodule src="./node_modules/array-back/dist/index.js"></script>
|
||
|
|
```
|
||
|
|
|
||
|
|
* * *
|
||
|
|
|
||
|
|
© 2015-19 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown).
|