Add typedoc dev dependency to generate documentation from the index.d.ts file

schroffl · schroffl · commit e2ff7bdf6c4a · 2023-12-20T14:36:32.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 tags
 node_modules/
 coverage
+docs
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -6,13 +6,15 @@
     "types": "index.d.ts",
     "directories": {},
     "scripts": {
-        "test": "c8 -r html --100 ava"
+        "test": "c8 -r html --100 ava",
+        "docs": "typedoc ./index.d.ts"
     },
     "author": "schroffl",
     "license": "MIT",
     "devDependencies": {
         "ava": "^4.0.1",
         "benchmark": "^2.1.4",
-        "c8": "^7.11.3"
+        "c8": "^7.11.3",
+        "typedoc": "^0.25.4"
     }
 }

-Original file line number
+Diff line change
@@ @@ -1,3 +1,4 @@ @@
 tags
 node_modules/
 coverage
 +docs