Merge pull request #104 from AZMCode/master

Added typedoc. Runnable with yarn build:docs
This commit is contained in:
Adhiraj Singh
2020-08-11 11:03:37 +05:30
committed by GitHub
3 changed files with 8 additions and 0 deletions

1
.gitignore vendored
View File

@@ -13,3 +13,4 @@ package-lock.json
decoded-ws.json
auth_info2.json
lib
doc

View File

@@ -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"
}
}

5
typedoc.json Normal file
View File

@@ -0,0 +1,5 @@
{
"inputFiles": ["./src"],
"mode": "modules",
"out": "doc"
}