Improve API documentation
This commit is contained in:
@ -13,7 +13,7 @@
|
|||||||
"tsc": "rimraf ./build && tsc -p .",
|
"tsc": "rimraf ./build && tsc -p .",
|
||||||
"webpack": "rimraf ./build && webpack",
|
"webpack": "rimraf ./build && webpack",
|
||||||
"demo": "npm run build && node ./demo",
|
"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": "prettier -l \"src/**/*.ts\"",
|
||||||
"style.fix": "prettier \"src/**/*.ts\" --write",
|
"style.fix": "prettier \"src/**/*.ts\" --write",
|
||||||
"fix-types": "node types-absolute-fixer.js"
|
"fix-types": "node types-absolute-fixer.js"
|
||||||
|
@ -23,5 +23,23 @@
|
|||||||
"tests",
|
"tests",
|
||||||
"**/*.spec.ts",
|
"**/*.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"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user