Include underlying TypeScript types into the API Documentation about diff HOT 9 CLOSED

I would like to take this on!

from diff.

Awesome.

@Ishmam156 Assigning to you.

Also, one more thing. There might be some difficulties getting the Typescript types into jsdoc, be sure to let us know if you face any problem :)

from diff.

Thank you! Will definitely do reach out if I struggle with it - will try to provide an overall response by this weekend :)

from diff.

@Ishmam156 are you still trying to solve this? If not I would like to take a shot at it as well, if that's fine with you @aayushmau5

from diff.

@ron-debajyoti sure, go ahead. Though I did try to fix this issue, but I did not succeed, and to be honest, I don't think this can be done without adding more configuration and including additional JSDoc comments.
But feel free to give it a try, and see what you can come up with. Otherwise, I will close this issue.

from diff.

But feel free to give it a try, and see what you can come up with. Otherwise, I will close this issue.

Give me 2 days nad I will update the status by then @aayushmau5

from diff.

Hey @aayushmau5 ,
I was looking into this and idk maybe this might be leading somewhere and thought to give you an update.

I think one root cause for this problem is that the compiled js obtained after build/tsc can't resolve types. You can try it out yourself by first running the build and then checking out any jsdoc comments in lib/asyncapidiff.js, for example, and they point to unresolved/any.

To solve this I changed the syntax of jsdoc comments. Taking the above example, I tried changing @returns {Array<DiffOutputItem>} to @returns {Array<import('./types').DiffOutputItem>} in src/asyncapidiff.ts. This solves the above problem, but then jsdoc2md got issues parsing this tag.

I'm still gonna try looking into it. Let me know your views on this.

from diff.

@ron-debajyoti Thank you so much for taking this up! I honestly tried following the current instructions of JSDoc but just couldn't get this to work - ofcourse might have missed something so good luck to you! :)

from diff.

🎉 This issue has been resolved in version 0.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

from diff.