Interface AutoDocPluginContext

Everything a plugin hook receives.

interface AutoDocPluginContext {
    Config: DBAutoDocConfig;
    Driver?: BaseAutoDocDriver;
    Hook: AutoDocPluginHook;
    Log: (message: string) => void;
    Options: { [key: string]: AutoDocPluginJSONValue };
    RunFolder: string;
    State: DatabaseDocumentation;
}

Index

Properties

Config Driver? Hook Log Options RunFolder State

Properties

Config

Config: DBAutoDocConfig

`Optional`Driver

Driver?: BaseAutoDocDriver

The open database connection. Present for every hook except PreRun.

Hook

Hook: AutoDocPluginHook

Log

Log: (message: string) => void

Options

Options: { [key: string]: AutoDocPluginJSONValue }

This plugin's options from the config file (empty object when none).

RunFolder

RunFolder: string

Folder the current run writes its outputs to.

State

State: DatabaseDocumentation