DocumentationThrowscomponent
DocumentationThrows({ throws }: DocumentationThrowsProps): ReactNode| Param | Type | |
|---|---|---|
props | DocumentationThrowsProps | Props for DocumentationThrows — the @throws entries to render, one row each. required |
.throws | ImmutableArray<DocumentationThrow> | Throw entries to render — one row per documented thrown type. readonly |
| Return | |
|---|---|
ReactNode | A <Section> containing the throws table, or null when there are none. |
Render a documented symbol's @throws entries as a scrollable table — one row per thrown type.
- Self-contained: pulls its own copy of the tree map from
useTreeMap()so theTypecolumn can link each type to its documented page viaTreeLink(exact-match only; compound or builtin types stay plain text). - A row with no hand-written description falls back to the referenced type's own
description. - Renders nothing when there are no throw entries.
Examples
<DocumentationThrows throws={throws} />