TypeScript: add type definition tests

Author: lovell

package.json

@@ -24,7 +24,10 @@
   "type": "module",
   "scripts": {
     "build": "esbuild lib/limax.mjs --format=cjs --outfile=lib/limax.cjs",
-    "test": "semistandard lib/limax.mjs && npm run build && nyc --reporter=html ava test/unit.cjs",
+    "lint": "semistandard lib/limax.mjs",
+    "types": "tsd --files test/index.test-d.ts",
+    "unit": "nyc --reporter=html ava test/unit.cjs",
+    "test": "npm run lint && npm run build && npm run types && npm run unit",
     "changelog": "conventional-changelog -i CHANGELOG.md -s"
   },
   "keywords": [
@@ -56,14 +59,15 @@
   "dependencies": {
     "hepburn": "^1.2.2",
     "lodash.deburr": "^4.1.0",
-    "speakingurl": "^14.0.1",
-    "pinyin-pro": "^3.27.0"
+    "pinyin-pro": "^3.27.0",
+    "speakingurl": "^14.0.1"
   },
   "devDependencies": {
     "ava": "^5.3.1",
     "conventional-changelog-cli": "^2.2.2",
     "esbuild": "^0.25.10",
     "nyc": "^15.1.0",
-    "semistandard": "^16.0.1"
+    "semistandard": "^16.0.1",
+    "tsd": "^0.33.0"
   }
 }

test/index.test-d.ts

@@ -0,0 +1,39 @@
+import limax from '..';
+
+const input: string = 'foo bar baz';
+
+const slug: string = limax(input);
+const slugWithOptions: string = limax(input, { separator: '_', custom: ['.'] });
+const slugWithAllOptions: string = limax(input, {
+    separator: '_',
+    replacement: '-',
+    maintainCase: true,
+    tone: true,
+    custom: { 'o': '0' },
+    lang: 'en',
+});
+const slugWithLangOnly: string = limax(input, { lang: 'de' });
+
+// @ts-expect-error
+limax(123);
+
+// @ts-expect-error
+limax(input, { separator: 123 });
+
+// @ts-expect-error
+limax(input, { replacement: 123 });
+
+// @ts-expect-error
+limax(input, { maintainCase: 'true' });
+
+// @ts-expect-error
+limax(input, { tone: 'true' });
+
+// @ts-expect-error
+limax(input, { custom: 'not-an-object' });
+
+// @ts-expect-error
+limax(input, { lang: 123 });
+
+// @ts-expect-error
+limax(input, { unknownOption: true });