@maverickcer/env-cap
    Preparing search index...

    Interface GenerateDocumentationResult

    The result of a completed generateDocumentation run.

    interface GenerateDocumentationResult {
        catalog: readonly CatalogContract[];
        contracts: readonly DiscoveredContractSummary[];
        docsPath: string;
        documentation: DocumentationFindings;
        envExample: EnvExampleResult | undefined;
        parseWarnings: readonly ParseWarning[];
    }
    Index
    catalog contracts docsPath documentation envExample parseWarnings
    catalog: readonly CatalogContract[]

    Same descriptive content as the generated Markdown Catalog, reshaped for programmatic consumers -- see buildCatalog() in docs.ts.

    contracts: readonly DiscoveredContractSummary[]

    Root-relative summary of every discovered contract, active or not.

    docsPath: string

    Absolute path the Markdown docs artifact was written to.

    documentation: DocumentationFindings

    Everything found that isn't fully documented or up to date.

    envExample: EnvExampleResult | undefined

    Set only when options.envExample was passed.

    parseWarnings: readonly ParseWarning[]

    Parse-time warnings collected across every analyzed file (including allow-listed package resolution).

    Settings
    Member Visibility

    On This Page
    Properties