Add TypeScript definition (#7)

UltiRequiem · sindresorhus · web-flow · commit aae7539cb32f · 2022-02-02T12:48:31.000+07:00
Co-authored-by: Sindre Sorhus &lt;sindresorhus@gmail.com&gt;
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,26 @@
+/**
+Returns an array filled with the specified input.
+
+@param value - The value to fill the array with.
+@param count - The number of items to fill the array with.
+
+@example
+```
+import filledArray from 'filled-array';
+
+filledArray('x', 3);
+//=> ['x', 'x', 'x']
+
+filledArray(0, 3);
+//=> [0, 0, 0]
+
+filledArray(index => {
+	return (++index % 3 ? '' : 'Fizz') + (index % 5 ? '' : 'Buzz') || index;
+}, 15);
+//=> [1, 2, 'Fizz', 4, 'Buzz', 'Fizz', 7, 8, 'Fizz', 'Buzz', 11, 'Fizz', 13, 14, 'FizzBuzz']
+```
+*/
+export default function filledArray<T>(
+	value: T | ((index: number, count: number, currentArray: T[]) => T),
+	count: number
+): T[];
diff --git a/index.test-d.ts b/index.test-d.ts
@@ -0,0 +1,6 @@
+import {expectType} from 'tsd';
+import filledArray from './index.js';
+
+expectType<string[]>(filledArray('x', 3));
+expectType<number[]>(filledArray(0, 3));
+expectType<string[]>(filledArray(index => `Hey ${index}`, 3));
diff --git a/package.json b/package.json
@@ -16,11 +16,12 @@
 		"node": ">=12"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
-		"index.js"
-	],
+ 		"index.js",
+		"index.d.ts"
+ 	],
 	"keywords": [
 		"array",
 		"elements",
@@ -33,6 +34,7 @@
 	],
 	"devDependencies": {
 		"ava": "^4.0.0",
+		"tsd": "^0.19.1",
 		"xo": "^0.47.0"
 	}
 }
