Document overload functions/methods

Question

I've been trying to document an overload function in JS using JSDoc:

There's 2 use cases:

assignSlave(ticket, userid);
assignSlave(ticket, firstname, lastname);

I'd like to have it look like this in VSCode:

Case 1
Case 2

And so on...

I tried the solution given in Document overloaded function in JSDoc but it didn't work for me:

/**
 * Test
 *
 * @function assignSlave
 * @param {String} ticket
 * @param {String} userid
 *//**
 * Test2
 *
 * @function assignSlave
 * @param {String} ticket
 * @param {String} firstname
 * @param {String} lastname
 */
function assignSlave(a, b, c){}
assignSlave()

I get this:

this

Is there a way to achieve what I'm trying to do?

I read this article but am not sure how it works in my case.

Have a look at this: austingil.com/typescript-function-overloads-with-jsdoc — Cerbrus
– Cerbrus, Commented Jun 30, 2022 at 10:32
@Cerbrus From this article, @type and @template didn't worked for me — Martin
– Martin, Commented Jun 30, 2022 at 10:37

asportnoy · Accepted Answer · 2023-05-31 16:24:05Z

10

In TypeScript 5, you can use the new @overload tag:

/**
 * @overload
 * @param {string} ticket
 * @param {string} userId
 *//**
 * @overload
 * @param {string} ticket
 * @param {string} firstname
 * @param {string} lastname
 *//**
 * @param {string} a
 * @param {string} b
 * @param {string} c
 */
function assignSlave(a, b, c) {}

For reference: https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#overload-support-in-jsdoc

edited May 31, 2023 at 16:24

asportnoy

2,5793 gold badges22 silver badges36 bronze badges

answered Feb 19, 2023 at 18:19

Tomasz Lenarcik

4,92021 silver badges31 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

lepsch · Accepted Answer · 2022-08-16 08:40:43Z

3

Do it like the following snippet. Change from function to an arrow function and set its type accordingly. The last thing is to assign a default value to trailing arguments so the overload types are compatible with each other.

/**
 * @type  {{
 *   (ticket: string, userid: string): void;
 *   (ticket: string, firstname: string, lastname: string): void;
 * }}
 */
 const assignSlave = (a, b, c = '') => {}
 assignSlave('ticket', 'userid')
 assignSlave('ticket', 'firstname', 'lastname')

This way the function is recognized with 2 overloads:

Overload 1

Overload 2

answered Aug 16, 2022 at 8:40

lepsch

10.5k5 gold badges33 silver badges48 bronze badges

4 Comments

Martin Over a year ago

Thank you so much !! It works exactly like I wanted to !

Martin Over a year ago

I don't know how to do, I don't see the chcek button ;_; Never mind, I'm dumb

Mark Over a year ago

While this works, you should note that you unfortunately lose typing on the anonymous inner function. In the above example, the types of a, b, and c are all any. Similarly that function can return whatever it likes and is not constricted to void.

JPC Over a year ago

@Mark You don't actually, you just have to remember to also add @param fields just like you would normally. The type just takes care of when you use it elsewhere.

Collectives™ on Stack Overflow

Document overload functions/methods

2 Answers 2

Comments

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related