DocumentationSignaturescomponent
DocumentationSignatures({ signatures }: DocumentationSignaturesProps): ReactNode| Param | Type | |
|---|---|---|
props | DocumentationSignaturesProps | Props for DocumentationSignatures — the type signatures to render, one block per overload. required |
.signatures | ImmutableArray<string> | Type signatures to render — one block per overload. readonly |
| Return | |
|---|---|
ReactNode | One <Preformatted> block per signature, or null when there are none. |
Render a documented symbol's signature(s) as monospace code blocks — one <Preformatted> per overload.
- Shared by
DocumentationCardandDocumentationPageso signatures render identically in both (calm code
blocks, not a shouty heading). - Renders nothing when there are no signatures.
Examples
<DocumentationSignatures signatures={["getArray<T>(arr: T[]): T"]} />