typedoc/dist/lib/output/plugins/NavigationPlugin.js

Create api documentation for TypeScript projects.

import * as Path from "path";
import { RendererComponent } from "../components.js";
import { RendererEvent } from "../events.js";
import { writeFile } from "../../utils/index.js";
import { DefaultTheme } from "../themes/default/DefaultTheme.js";
import { compressJson } from "../../utils/compress.js";
export class NavigationPlugin extends RendererComponent {
    constructor(owner) {
        super(owner);
        this.owner.on(RendererEvent.BEGIN, this.onRendererBegin.bind(this));
    }
    onRendererBegin(_event) {
        if (!(this.owner.theme instanceof DefaultTheme)) {
            return;
        }
        this.owner.preRenderAsyncJobs.push((event) => this.buildNavigationIndex(event));
    }
    async buildNavigationIndex(event) {
        const navigationJs = Path.join(event.outputDirectory, "assets", "navigation.js");
        const nav = this.owner.theme.getNavigation(event.project);
        await writeFile(navigationJs, `window.navigationData = "${await compressJson(nav)}"`);
    }
}