createTypedocContext
functionfunction createTypedocContext(
packages: ApiPackage[],
options: TypedocContextOptions,
typeRefs?: Map<ApiExport, Type>
): Promise<TypedocContext>;Create a TypedocContext from pre-parsed packages.
This is the low-level API -- use loadTypedocContext for the common case
of loading TypeDoc JSON files from disk.
The function is async because it eagerly pre-renders all markdown fields
(descriptions, remarks, examples) through a unified pipeline so that
getLinkedExport() can return fully-rendered HTML synchronously.
PARAMETERS
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| packages | ApiPackage[] | — |
| options | TypedocContextOptions | — |
| typeRefs? | Map<ApiExport, Type> | — |
RETURNS
Promise<TypedocContext>