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

    Interface ContractModelContract

    One createEnv() contract's full statically-discoverable contract, active or not.

    interface ContractModelContract {
        active: boolean;
        auditRequired: boolean | undefined;
        category: string | undefined;
        contractName: string;
        dataResidency: string | readonly string[] | undefined;
        declaration: SourcePosition;
        documentation: SourcePosition | undefined;
        documented: boolean;
        exclusiveGroup: string | undefined;
        expiresAt: string | undefined;
        exportName: string;
        file: string;
        legalBasis: string | undefined;
        metadata: Readonly<Record<string, unknown>> | undefined;
        owner: string | undefined;
        packageOrigin: PackageOrigin | undefined;
        purpose: string | undefined;
        retention: string | undefined;
        sensitivity: string | undefined;
        variables: readonly ContractModelVariable[];
    }

    Hierarchy

    • EnvGovernanceFields
      • ContractModelContract
    Index
    active auditRequired category contractName dataResidency declaration documentation documented exclusiveGroup expiresAt exportName file legalBasis metadata owner packageOrigin purpose retention sensitivity variables
    active: boolean
    auditRequired: boolean | undefined
    category: string | undefined
    contractName: string
    dataResidency: string | readonly string[] | undefined
    declaration: SourcePosition

    Where this contract's createEnv(...) call is declared. Always present. See ADR 0036.

    documentation: SourcePosition | undefined

    Where this contract's documentEnv(...) call is declared, if one exists. See ADR 0036.

    documented: boolean
    exclusiveGroup: string | undefined
    expiresAt: string | undefined
    exportName: string
    file: string

    Root-relative, POSIX-separated -- matches DiscoveredContractSummary.file.

    legalBasis: string | undefined
    metadata: Readonly<Record<string, unknown>> | undefined
    owner: string | undefined
    packageOrigin: PackageOrigin | undefined
    purpose: string | undefined
    retention: string | undefined
    sensitivity: string | undefined
    variables: readonly ContractModelVariable[]

    Settings
    Member Visibility

    On This Page
    Properties