Add support for Iterable, require Node.js 8, add TypeScript definit…

…ion (#6)

.editorconfig

@@ -7,9 +7,6 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[{package.json,*.yml}]
+[*.yml]
 indent_style = space
 indent_size = 2
-
-[*.md]
-trim_trailing_whitespace = false

.gitattributes

@@ -1 +1 @@
-* text=auto
+* text=auto eol=lf

.gitignore

@@ -1 +1,2 @@
 node_modules
+yarn.lock

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.travis.yml

@@ -1,5 +1,4 @@
-sudo: false
 language: node_js
 node_js:
-  - 'stable'
-  - '0.12'
+  - '10'
+  - '8'

index.d.ts

@@ -0,0 +1,32 @@
+/**
+Convert a value to an array.
+
+_Supplying `null` or `undefined` results in an empty array._
+
+@example
+```
+import arrify = require('arrify');
+
+arrify('🦄');
+//=> ['🦄']
+
+arrify(['🦄']);
+//=> ['🦄']
+
+arrify(new Set(['🦄']));
+//=> ['🦄']
+
+arrify(null);
+//=> []
+
+arrify(undefined);
+//=> []
+```
+*/
+declare function arrify(value: null | undefined): [];
+declare function arrify(value: string): [string];
+declare function arrify<ValueType>(value: ValueType[]): ValueType[];
+declare function arrify<ValueType>(value: Iterable<ValueType>): ValueType[];
+declare function arrify<ValueType>(value: ValueType): [ValueType];
+
+export = arrify;

index.js

@@ -1,8 +1,23 @@
 'use strict';
-module.exports = function (val) {
-	if (val === null || val === undefined) {
+
+const arrify = value => {
+	if (value === null || value === undefined) {
 		return [];
 	}
 
-	return Array.isArray(val) ? val : [val];
+	if (Array.isArray(value)) {
+		return value;
+	}
+
+	if (typeof value === 'string') {
+		return [value];
+	}
+
+	if (typeof value[Symbol.iterator] === 'function') {
+		return [...value];
+	}
+
+	return [value];
 };
+
+module.exports = arrify;

index.test-d.ts

@@ -0,0 +1,14 @@
+import {expectType} from 'tsd';
+import arrify = require('.');
+
+expectType<[]>(arrify(null));
+expectType<[]>(arrify(undefined));
+expectType<[string]>(arrify('🦄'));
+expectType<string[]>(arrify(['🦄']));
+expectType<[boolean]>(arrify(true));
+expectType<[number]>(arrify(1));
+expectType<[{}]>(arrify({}));
+expectType<([string | number, string | number])[]>(
+	arrify(new Map<string | number, string | number>([[1, 2], ['a', 'b']]))
+);
+expectType<number[]>(arrify(new Set([1, 2])));

license

@@ -1,21 +1,9 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package.json

@@ -1,33 +1,35 @@
 {
-  "name": "arrify",
-  "version": "1.0.1",
-  "description": "Convert a value to an array",
-  "license": "MIT",
-  "repository": "sindresorhus/arrify",
-  "author": {
-    "name": "Sindre Sorhus",
-    "email": "sindresorhus@gmail.com",
-    "url": "sindresorhus.com"
-  },
-  "engines": {
-    "node": ">=0.10.0"
-  },
-  "scripts": {
-    "test": "xo && ava"
-  },
-  "files": [
-    "index.js"
-  ],
-  "keywords": [
-    "array",
-    "arr",
-    "arrify",
-    "arrayify",
-    "convert",
-    "value"
-  ],
-  "devDependencies": {
-    "ava": "*",
-    "xo": "*"
-  }
+	"name": "arrify",
+	"version": "1.0.1",
+	"description": "Convert a value to an array",
+	"license": "MIT",
+	"repository": "sindresorhus/arrify",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "sindresorhus@gmail.com",
+		"url": "sindresorhus.com"
+	},
+	"engines": {
+		"node": ">=8"
+	},
+	"scripts": {
+		"test": "xo && ava && tsd"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"keywords": [
+		"array",
+		"arr",
+		"arrify",
+		"arrayify",
+		"convert",
+		"value"
+	],
+	"devDependencies": {
+		"ava": "^1.4.1",
+		"tsd": "^0.7.2",
+		"xo": "^0.24.0"
+	}
 }

readme.md

@@ -15,11 +15,14 @@ $ npm install --save arrify
 ```js
 const arrify = require('arrify');
 
-arrify('unicorn');
-//=> ['unicorn']
+arrify('🦄');
+//=> ['🦄']
 
-arrify(['unicorn']);
-//=> ['unicorn']
+arrify(['🦄']);
+//=> ['🦄']
+
+arrify(new Set(['🦄']));
+//=> ['🦄']
 
 arrify(null);
 //=> []

test.js

@@ -1,9 +1,13 @@
 import test from 'ava';
-import fn from './';
+import arrify from '.';
 
-test(t => {
-	t.is(fn('foo')[0], 'foo');
-	t.is(fn(['foo'])[0], 'foo');
-	t.is(fn(null)[0], undefined);
-	t.is(fn(undefined)[0], undefined);
+test('main', t => {
+	t.deepEqual(arrify('foo'), ['foo']);
+	t.deepEqual(arrify(new Map([[1, 2], ['a', 'b']])), [[1, 2], ['a', 'b']]);
+	t.deepEqual(arrify(new Set([1, 2])), [1, 2]);
+	t.deepEqual(arrify(null), []);
+	t.deepEqual(arrify(undefined), []);
+
+	const fooArray = ['foo'];
+	t.is(arrify(fooArray), fooArray);
 });