The apiExtractorProcessor() reads one or more API Extractor model files and creates partial documents for usage with ::: api containers.

Usage

import {
    Generator,
    apiExtractorProcessor,
} from "@forsakringskassan/docs-generator";

const docs = new Generator(import.meta.url, {
    processors: [
        apiExtractorProcessor({
            apiModel: ["temp/*.api.json"],
        }),
    ],
});

Configuration

apiModel: string | string[] Optional

One or more glob patterns pointing at .api.json files generated by API Extractor.

Rendering

See Documenting TypeScript for details on rendering API symbols.