@overload

Tag Kind
Modifier
TSDoc Reference
TypeDoc specific

The @overload tag is recognized for use in JavaScript projects which can use it to declare overloads since TypeScript 5.0. It is automatically removed from the rendered documentation with the --excludeTags option

Example

/**
* @overload
* @param {string} value first signature
* @return {void}
*/


/**
* @overload
* @param {number} value second signature
* @param {number} [maximumFractionDigits]
* @return {void}
*/


/**
* @param {string | number} value
* @param {number} [maximumFractionDigits]
*/

function printValue(value, maximumFractionDigits) {}

See Also