Function overloading

[niksy]

It seems there still isn’t possible to fully describe function overload with JSDoc.

There were some attempts, but they either haven’t worked properly or don’t work anymore.

How do you deal with describing functions with different argument types and outputs?

My current half-approach is to ts-ignore output and explictly define return type in comments.

[wooorm]

Here’s how I get them to work: https://github.com/micromark/micromark/blob/2b1fafb5f3ad0d1c9329ffbc80be1cbd411f5468/packages/micromark/dev/index.js#L12-L30.

[niksy]

Oh, I just checked it on my codebase and it works! It’s a nice workaround for sure! Do you know why this works? Is this something related to closure?

[wooorm]

fnA & fnB merges signatures. In that example they’re typed inline, but you can also use a @callback syntax. I think that if you use predefined functions rather then typing them inline, two levels of nesting and no “closure” is fine, but you’d have to check that.