jsdocts
v0.1.4
Published
Creates typescript declarations files from jsDocs
Downloads
6
Readme
jsDoc-tsDec
Outputs typescript declaration files from javascript files documented with jsDoc
Overview
jsDoc-tsDec uses the jsdoc-toolkit to create a typescript decleration files from the jsdoc comments in the associated javascript files.
jsDoc-tsDec uses NOC to wrap the jsdoc-toolkit
Installation
npm install -g jsDoc-tsDec
Usage
jsdocts -d:<decleration_output_path> <source_dir> <source_file> ...
Known Issues
- Javascript optional parameters are not supported in typescript decleration files
- Javascript parameter overloading is not supported in typescript decleration files
Untested
- Passthrough of standard jsDoc-Toolkit options