I often find myself describing function params as labeled tuples. A simple example:
type AddArgs = [a: number, b: number];
function add(...[a, b]: AddArgs): number {
return a + b;
}
Unfortunately, this approach prevents us from attaching tsdocs to the params. The following does not work :/
type AddArgs = [a: number, b: number];
/**
* @param a the first number
* @param b the second number
*/
function add(...[a, b]: AddArgs): number {
return a + b;
}
I propose that one be able to attach tsdocs to labeled tuple elements, just as one does to object keys.
type AddArgs = [
/** the first number */
a: number,
/** the second number */
b: number,
];
I also propose that––when spread in place of function params––these tsdocs are treated as if they were the result of @param annotations on the function declaration.
Suggestion
I often find myself describing function params as labeled tuples. A simple example:
Unfortunately, this approach prevents us from attaching tsdocs to the params. The following does not work :/
I propose that one be able to attach tsdocs to labeled tuple elements, just as one does to object keys.
I also propose that––when spread in place of function params––these tsdocs are treated as if they were the result of
@param
annotations on the function declaration.🔍 Search Terms
Documentation, labeled, tuple, elements, tsdocs, signature
✅ Viability Checklist
My suggestion meets these guidelines: