DocumentationReturnscomponent
DocumentationReturns({ returns }: DocumentationReturnsProps): ReactNode| Param | Type | |
|---|---|---|
props | DocumentationReturnsProps | Props for DocumentationReturns — the @returns entries to render, one row each. required |
.returns | ImmutableArray<DocumentationReturn> | Return entries to render — one row per documented return type. readonly |
| Return | |
|---|---|
ReactNode | A <Section> containing the returns table, or null when there are none. |
Render a documented symbol's @returns entries as a scrollable table — one row per return 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 return entries.
Examples
<DocumentationReturns returns={returns} />