JSDoc Type Definition Extractor
Extracts and indexes JSDoc type annotations from JavaScript codebases using the jsdoc-api parser. Generates TypeScript declaration files (.d.ts) and searchable type catalogs from @typedef and @param tags.
Installation
Use the upstream install or setup path that matches your environment:
- npm install -g jsdoc
- npm install --save-dev jsdoc
Requirements and caveats from upstream:
- JSDoc supports stable versions of Node.js 8.15.0 and later. You can install
- To install the latest version on npm globally (might require sudo;
Basic usage or getting-started notes:
JSDoc globally or in your project's node_modules folder.
To install the latest version on npm locally and save it in your package's
Source: https://github.com/jsdoc/jsdoc
Extracted from upstream docs: https://raw.githubusercontent.com/jsdoc/jsdoc/HEAD/README.md