Interface AutoDocExporter

An export format contributed by a plugin, selected with export --format <Format>.

interface AutoDocExporter {
    Description: string;
    Format: string;
    Generate(
        state: DatabaseDocumentation,
        options: AutoDocExporterOptions,
    ): AutoDocExportFile[];
}

Index

Properties

Description Format

Methods

Properties

Description

Description: string

Format

Format: string

Methods

Generate

Generate(
state: DatabaseDocumentation,
options: AutoDocExporterOptions,
): AutoDocExportFile[]
Parameters
- state: DatabaseDocumentation
- options: AutoDocExporterOptions
Returns AutoDocExportFile[]
- Defined in packages/DBAutoDoc/src/plugins/types.ts:96