@throws

Tag Kind

Block

TSDoc Reference

@throws

The @throws tag can be used to document an exception that can be thrown by a function or method.

Example

/**
 * @throws {@link UserError} if `max < min`
 */
export function rand(min: number, max: number): number;