Improve API documentation

This commit is contained in:
Dolan
2018-08-08 22:51:54 +01:00
parent 4c75b91ce9
commit 94274733f4
2 changed files with 20 additions and 2 deletions

View File

@ -13,7 +13,7 @@
"tsc": "rimraf ./build && tsc -p .",
"webpack": "rimraf ./build && webpack",
"demo": "npm run build && node ./demo",
"typedoc": "typedoc --out docs/api/ src/ --module commonjs --target ES6 --disableOutputCheck --excludePrivate --externalPattern \"**/*.spec.ts\"",
"typedoc": "typedoc src/index.ts",
"style": "prettier -l \"src/**/*.ts\"",
"style.fix": "prettier \"src/**/*.ts\" --write",
"fix-types": "node types-absolute-fixer.js"

View File

@ -23,5 +23,23 @@
"tests",
"**/*.spec.ts",
"**/_*"
]
],
"typedocOptions": {
"mode": "modules",
"out": "docs/api",
"exclude": "test",
"theme": "default",
"ignoreCompilerErrors": true,
"excludePrivate": true,
"excludeProtected": true,
"excludeNotExported": true,
"excludeExternals": false,
"target": "ES6",
"moduleResolution": "node",
"preserveConstEnums": true,
"stripInternal": true,
"suppressExcessPropertyErrors": true,
"suppressImplicitAnyIndexErrors": true,
"module": "commonjs"
}
}