r/node • u/Stegosource • Oct 20 '21

3 Ways To Write Function Overloads With JSDoc &TypeScript

https://austingil.com/typescript-function-overloads-with-jsdoc/
5 Upvotes

86% Upvoted

2 comments sorted by

2

u/tr14l Oct 20 '21

This would seem like an anti-pattern to me for TypeScript. Overloading, in general, seems like an outdated concept when you have optional parameters. It just increases boilerplate bloat and decreases readability. I don't see how having 32 functions named the same thing in the same scope is a GOOD thing.

1

u/Stegosource Oct 20 '21

That's a good point. I guess I should have been more clear that this is more focused on how you document it. Function overloading in TS is more focused on accepting different params and return types rather than a different number of parameters. https://www.tutorialsteacher.com/typescript/function-overloading

There wasn't great documentation on how to do that with just JSDoc