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

    Interface DiscoveredContractSummary

    Root-relative projection of a DiscoveredContract, as returned by generateEnvManifest/generateDocumentation.

    interface DiscoveredContractSummary {
        active: boolean;
        contractName: string;
        documented: boolean;
        exportName: string;
        file: string;
        variableCount: number;
    }
    Index
    active contractName documented exportName file variableCount
    active: boolean

    Whether this contract was included in the generated manifest (active defaults to true).

    contractName: string

    Resolved display name (see DiscoveredContract.contractName).

    documented: boolean

    Whether a documentEnv() call is linked to this contract.

    exportName: string

    The binding name the createEnv() result is exported as.

    file: string

    Root-relative, POSIX-separated file path.

    variableCount: number

    Number of variables declared in this contract's schema.

    Settings
    Member Visibility

    On This Page
    Properties