[sparkly] introduce typings (#18291)

* [sparkly] introduce typings

* [sparkly] restrict input type to allow all types from examples but not more than that

types/sparkly/index.d.ts

@@ -0,0 +1,16 @@
+// Type definitions for sparkly 3.1
+// Project: https://github.com/sindresorhus/sparkly
+// Definitions by: BendingBender <https://github.com/BendingBender>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+export = sparkly;
+
+declare function sparkly(numbers: Array<number | ''>, options?: sparkly.Options): string;
+
+declare namespace sparkly {
+    interface Options {
+        min?: number;
+        max?: number;
+        style?: 'fire';
+    }
+}

types/sparkly/sparkly-tests.ts

@@ -0,0 +1,7 @@
+import sparkly = require('sparkly');
+
+let str: string;
+str = sparkly([0, 3, 5, 8, 4, 3, 4, 10]);
+str = sparkly([0, 3, 5, '', 4, 3, 4, 10]);
+str = sparkly([1, 2, 3, 4, 5], {min: 0, max: 10});
+str = sparkly([1, 2, 3, 4, 5, 6, 7, 8], {style: 'fire'});

types/sparkly/tsconfig.json

@@ -0,0 +1,22 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "sparkly-tests.ts"
+    ]
+}

types/sparkly/tslint.json

@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }