Add TypeScript definition

sindresorhus · Mar 12, 2024 · 5d5823a · 5d5823a
1 parent bc57478
commit 5d5823a
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,7 @@
+/**
+ * Check if a string is HTML.
+ *
+ * @param string The string to check if it is HTML.
+ * @returns `true` if the string is HTML, `false` otherwise.
+ */
+export default function isHtml(string: string): boolean;
diff --git a/index.test-d.ts b/index.test-d.ts
@@ -0,0 +1,4 @@
+import {expectType} from 'tsd';
+import isHtml from './index.js';
+
+expectType<boolean>(isHtml('<!doctype html>'));
diff --git a/package.json b/package.json
@@ -16,10 +16,11 @@
 		"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
-		"index.js"
+		"index.js",
+		"index.d.ts"
 	],
 	"keywords": [
 		"html",
@@ -35,6 +36,7 @@
 	},
 	"devDependencies": {
 		"ava": "^3.15.0",
+		"tsd": "^0.30.7",
 		"xo": "^0.44.0"
 	}
 }