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

    Interface LinkResult

    The full result of linkFiles: every linked contract, plus every category of thing that didn't link cleanly.

    interface LinkResult {
        contracts: readonly DiscoveredContract[];
        staleDocEntries: readonly { exportName: string; file: string; key: string }[];
        undocumentedContracts: readonly { exportName: string; file: string }[];
        undocumentedVariables: readonly {
            exportName: string;
            file: string;
            key: string;
        }[];
        unresolvedLinks: readonly UnresolvedLink[];
        warnings: readonly ParseWarning[];
    }
    Index
    contracts staleDocEntries undocumentedContracts undocumentedVariables unresolvedLinks warnings
    contracts: readonly DiscoveredContract[]

    Every createEnv() contract found, merged with its documentation.

    staleDocEntries: readonly { exportName: string; file: string; key: string }[]

    Documented variable entries with no matching schema variable (the schema key was removed or renamed).

    undocumentedContracts: readonly { exportName: string; file: string }[]

    Contracts with no linked documentEnv() call at all.

    undocumentedVariables: readonly {
        exportName: string;
        file: string;
        key: string;
    }[]

    Schema variables with no matching entry in their contract's linked documentation.

    unresolvedLinks: readonly UnresolvedLink[]

    documentEnv() calls that couldn't be statically linked to a schema.

    warnings: readonly ParseWarning[]

    Parse-time warnings collected across every analyzed file.

    Settings
    Member Visibility

    On This Page
    Properties