ts-jsdoc

Transform TypeScript to JSDoc annotated JS code

Usage no npm install needed!

<script type="module">
  import tsJsdoc from 'https://cdn.skypack.dev/ts-jsdoc';
</script>

README

Installation

This module requires Node.js 4.0 or higher to run.

npm install ts-jsdoc --save-dev

Generate JSDoc from TypeScript

In the tsconfig.js set jsdoc to path to output directory.

"jsdoc": "jsdoc/out"

Or to options object:

{
  "out": "our dir",
  "access": "set to public if you want to skip protected members"
}

Execute: ts2jsdoc path-to-dir-with-tsconfig