Skip to content

ThrowsData

Represents the parsed result of @throws tags in JSDoc. Used to describe exception information that can occur in functions.

Signature

typescript
interface ThrowsData { type: string; name?: string; description: string }

Parameters

  • typeRequired · string

    Type of the exception

  • name · string

    Optional name of the exception

  • descriptionRequired · string

    Exception occurrence conditions and description

Released under the MIT License.