NestJS Typescript Docs

Coming from Java and Spring Boot, I miss a good typescriptdoc (a javadoc alternative). And while NestJS has a quite excellent documentation, it is missing source code documentation. Javadoc for open source projects has a free hosting called Unfortunately I could not find a similar service for TypeScript. Nevertheless, there is a way to generate documentation using typedoc.


Generating typedoc for NestJS

Run the following command after installing typedoc and cloning NestJS

typedoc --out nest-docs/ nest/packages/ --ignoreCompilerErrors --mode file

where nest-docs/ is where the documentation will be outputted.


I ran this command and put the NestJS API here: NestJS Documentation


You may also like...

Leave a Reply

Your email address will not be published. Required fields are marked *