Added typedoc. Runnable with yarn build:docs

Signed-off-by: AZMCode <[email protected]>
hafidamirudin · Aug 9, 2020 · 99fe157 · 99fe157
1 parent cea93ae
commit 99fe157
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,4 @@ package-lock.json
 decoded-ws.json
 auth_info2.json
 lib
+doc
diff --git a/package.json b/package.json
@@ -21,6 +21,7 @@
     "test": "mocha --timeout 60000 -r ts-node/register src/*/Tests.ts",
     "lint": "eslint '*/*.ts' --quiet --fix",
     "build": "tsc",
+    "build:docs":"typedoc",
     "example": "npx ts-node Example/example.ts",
     "browser-decode": "npx ts-node src/WAConnection/BrowserMessageDecoding.ts"
   },
@@ -54,6 +55,7 @@
     "mocha": "^8.0.1",
     "prettier": "^2.0.5",
     "ts-node-dev": "^1.0.0-pre.49",
+    "typedoc": "^0.18.0",
     "typescript": "^3.9.5"
   }
 }
diff --git a/typedoc.json b/typedoc.json
@@ -0,0 +1,5 @@
+{
+  "inputFiles": ["./src"],
+  "mode": "modules",
+  "out": "doc"
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,3 +13,4 @@ package-lock.json @@
     decoded-ws.json
     auth_info2.json
     lib
+    doc