This repository was archived by the owner on Oct 18, 2021. It is now read-only.
This repository was archived by the owner on Oct 18, 2021. It is now read-only.
Requires TS >= 4.3 be installed #1
Description
On TypeScript 4.2 (and presumably below) the extractor crashes due to a missing function in the TypeScript API.
Installing TypeScript 4.3 and above resolve this.
It should be made clear that this is the minimum dependency, through peerDependencies and perhaps documented/enforced at runtime too.
λ node node_modules/.bin/ts-docs src/index.ts
(node:67358) UnhandledPromiseRejectionWarning: TypeError: typescript_1.default.getTextOfJSDocComment is not a function
at Project.getJSDocData (/home/jake/Programming/Work/WebpartLibrary/node_modules/@ts-docs/extractor/dist/extractor/Project.js:938:54)
at Project.handleTypeAliasDecl (/home/jake/Programming/Work/WebpartLibrary/node_modules/@ts-docs/extractor/dist/extractor/Project.js:503:25)
at Project.handleSymbol (/home/jake/Programming/Work/WebpartLibrary/node_modules/@ts-docs/extractor/dist/extractor/Project.js:225:25)
at Project.visitor (/home/jake/Programming/Work/WebpartLibrary/node_modules/@ts-docs/extractor/dist/extractor/Project.js:123:38)
at Project.visitor (/home/jake/Programming/Work/WebpartLibrary/node_modules/@ts-docs/extractor/dist/extractor/Project.js:83:26)
at Project.visitor (/home/jake/Programming/Work/WebpartLibrary/node_modules/@ts-docs/extractor/dist/extractor/Project.js:72:34)
at TypescriptExtractor.run (/home/jake/Programming/Work/WebpartLibrary/node_modules/@ts-docs/extractor/dist/extractor/index.js:94:21)
at /home/jake/Programming/Work/WebpartLibrary/node_modules/@ts-docs/ts-docs/dist/cli.js:41:28
at Object.<anonymous> (/home/jake/Programming/Work/WebpartLibrary/node_modules/@ts-docs/ts-docs/dist/cli.js:51:3)
at Module._compile (internal/modules/cjs/loader.js:1085:14)
(Use `node --trace-warnings ...` to show where the warning was created)
(node:67358) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
(node:67358) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.