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

….ts file
schroffl · Dec 20, 2023 · e2ff7bd · e2ff7bd
1 parent fa087e8
commit e2ff7bd
Show file tree

Hide file tree

Showing 3 changed files with 207 additions and 3 deletions.
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"
     }
 }