@throws

Table of Contents

• Synonyms
• Syntax
• Overview
• Examples

Synonyms

@exception

Syntax

• @throws free-form description
• @throws {<type>}
• @throws {<type>} free-form description

Overview

The @throws tag allows you to document an error that a function might throw. You can include the @throws tag more than once in a single JSDoc comment.

Examples

/**
 * @throws {InvalidArgumentException}
 */
function foo(x) {}

/**
 * @throws Will throw an error if the argument is null.
 */
function bar(x) {}

/**
 * @throws {DivideByZero} Argument x must be non-zero.
 */
function baz(x) {}