Member Junction
    Preparing search index...

    Interface AutoDocPluginConfigEntry

    One entry in the config file's plugins array.

    interface AutoDocPluginConfigEntry {
        Enabled?: boolean;
        Module?: string;
        Name: string;
        Options?: { [key: string]: AutoDocPluginJSONValue };
        Priority?: number;
    }
    Index

    Properties

    Enabled? Module? Name Options? Priority?

    Properties

    Enabled?: boolean

    Defaults to true. Set false to turn a plugin (including a built-in one) off.

    Module?: string

    Module to load before looking the plugin up: an npm package name or a file path (relative paths resolve from the current working directory). Omit for built-in plugins.

    Name: string

    Registration key the plugin class was registered under (@RegisterClass(BaseAutoDocPlugin, Name)).

    Options?: { [key: string]: AutoDocPluginJSONValue }

    Plugin-specific options, passed to the plugin unchanged.

    Priority?: number

    Lower runs first. Defaults to 100.

    Settings

    Member Visibility

    On This Page

    Properties