Skip to content

computeOverviewSignature

The raw code signature shown on a type-overview page’s OG card, for the kinds that render a single signature line (function / type alias / variable). Classes, interfaces and enums render member tables instead, so they get no signature block.

Import:

import { computeOverviewSignature } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-page-generation';

Signature:

function computeOverviewSignature(name: string, info: TypeInfo): string | undefined

Parameters:

Parameter Type Description
name string The type’s name.
info TypeInfo The documented type.

Returns: string | undefined — The signature, or undefined for a kind that renders member tables instead.