Support for TypeScript types inside JsDoc?

[timonson]

Is it somehow possible to convert JSDoc including the supported types by TypeScript?

For example:

/**
 * appendChild.
 * @param {Element} el
 * @return {(...nodesOrStrings: (Node|string)[]) => void}
 */
export function append(el) {
  return (...nodesOrStrings) => el.append(...nodesOrStrings);
}

I am getting the following error here:

JSDOC_ERROR: ERROR: Unable to parse a tag's type expression...

Thanks!

[nicolas-tesla-x]

Did you find a solution?

[timonson]

No

[gaurav-ingalkar]

is typescript even supported ? I dont see anything that enables generating docs for typescript files in the documentation. can you show how you are running it ? for me it says "JSDOC_ERROR: There are no input files to process" when I run it for typescript files

[qqqiangqiang]

https://github.com/jsdoc2md/jsdoc-to-markdown/wiki/How-to-document-TypeScript

[75lb]

Personally, I don't use Typescript (nor intend to) so I don't have a quick solution but as a general rule, if you see JSDOC_ERROR then the problem is within jsdoc:

JSDOC_ERROR: ERROR: Unable to parse a tag's type expression...

jsdoc2md sits downstream of jsdoc output, so first you need to get your code working in jsdoc.. once you're happy with what jsdoc generates, give it another go in jsdoc2md.. I've added some labels to try and attract more feedback..