API/rehype-typedoc/buildSymbolsFromDocuments

buildSymbolsFromDocuments

function
function buildSymbolsFromDocuments(
  documents: TypeDocDocument[],
  buildUrl: (packageSlug: string, symbolSlug?: string) => string
): Map<string, SymbolEntry>;

Build a symbols map from TypeDoc JSON documents using the TypeDoc Deserializer.

Deserializes each document into a full ProjectReflection, then walks
the top-level declarations to extract symbol metadata. This approach
is more robust than raw JSON walking because it uses TypeDoc's own
model for kind classification and source resolution.

When multiple packages export the same symbol name, the map stores an
array of entries. The rehype-typedoc plugin filters out re-exports to
resolve ambiguity, and throws only if genuinely ambiguous definitions remain.

PARAMETERS

NAMETYPEDESCRIPTION
documentsTypeDocDocument[]—
buildUrl(packageSlug: string, symbolSlug?: string) => string—

RETURNS

Map<string, SymbolEntry>