api-documenter.api.md

API Report File for "@microsoft/api-documenter"

Do not edit this file. It is a report generated by API Extractor.

import type { ApiItem } from '@microsoft/api-extractor-model';
import type { ApiModel } from '@microsoft/api-extractor-model';

// @public
export interface IApiDocumenterPluginManifest {
    features: IFeatureDefinition[];
    manifestVersion: 1000;
}

// @public
export interface IFeatureDefinition {
    featureName: string;
    kind: 'MarkdownDocumenterFeature';
    subclass: {
        new (initialization: PluginFeatureInitialization): MarkdownDocumenterFeature;
    };
}

// @public
export interface IMarkdownDocumenterFeatureOnBeforeWritePageArgs {
    readonly apiItem: ApiItem;
    readonly outputFilename: string;
    pageContent: string;
}

// @public
export interface IMarkdownDocumenterFeatureOnFinishedArgs {
}

// @public
export class MarkdownDocumenterAccessor {
    // Warning: (ae-forgotten-export) The symbol "IMarkdownDocumenterAccessorImplementation" needs to be exported by the entry point index.d.ts
    //
    // @internal
    constructor(implementation: IMarkdownDocumenterAccessorImplementation);
    getLinkForApiItem(apiItem: ApiItem): string | undefined;
}

// @public
export class MarkdownDocumenterFeature extends PluginFeature {
    // (undocumented)
    static [Symbol.hasInstance](instance: object): boolean;
    context: MarkdownDocumenterFeatureContext;
    // @virtual
    onBeforeWritePage(eventArgs: IMarkdownDocumenterFeatureOnBeforeWritePageArgs): void;
    // @virtual
    onFinished(eventArgs: IMarkdownDocumenterFeatureOnFinishedArgs): void;
}

// @public
export class MarkdownDocumenterFeatureContext {
    // @internal
    constructor(options: MarkdownDocumenterFeatureContext);
    readonly apiModel: ApiModel;
    readonly documenter: MarkdownDocumenterAccessor;
    readonly outputFolder: string;
}

// @public
export abstract class PluginFeature {
    // (undocumented)
    static [Symbol.hasInstance](instance: object): boolean;
    // @internal
    constructor(initialization: PluginFeatureInitialization);
    context: PluginFeatureContext;
    // @virtual
    onInitialized(): void;
}

// @public
export class PluginFeatureContext {
}

// @public
export class PluginFeatureInitialization {
    // @internal
    constructor();
    // @internal (undocumented)
    _context: PluginFeatureContext;
}