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

    Interface ContractModelVariable

    One variable's full statically-discoverable contract: schema-shaped facts plus linked documentation.

    • DependencyModelVariable -- this same declared variable's access status.
    • OwnershipModelVariable -- this same declared variable's effective owner.
    • LifecycleModelVariable -- this same declared variable's lifecycle data.
    • CatalogVariable (docs.ts) -- this same declared variable, reshaped for the generated docs catalog/JSON. Plain reference, not {@link}: CatalogVariable is intentionally not part of the public surface (see typedoc.json's intentionallyNotExported).
    interface ContractModelVariable {
        auditRequired: boolean | undefined;
        context: string | undefined;
        dataResidency: string | readonly string[] | undefined;
        declaration: SourcePosition;
        defaultValue: { ok: true; value: unknown } | { ok: false } | undefined;
        description: string | undefined;
        documented: boolean;
        evidence: DiscoveredVariableEvidence | undefined;
        expiresAt: string | undefined;
        hasDefault: boolean;
        hasProcessor: boolean;
        hasValidator: boolean;
        key: string;
        legalBasis: string | undefined;
        metadata: Readonly<Record<string, unknown>> | undefined;
        owner: string | undefined;
        processorReturnType: string | undefined;
        processorSource: string | undefined;
        purpose: string | undefined;
        refreshInstructions: string | undefined;
        required: boolean | undefined;
        retention: string | undefined;
        sensitivity: string | undefined;
        setupInstructions: string | undefined;
        validatorSource: string | undefined;
    }

    Hierarchy

    • EnvGovernanceFields
      • ContractModelVariable
    Index
    auditRequired context dataResidency declaration defaultValue description documented evidence expiresAt hasDefault hasProcessor hasValidator key legalBasis metadata owner processorReturnType processorSource purpose refreshInstructions required retention sensitivity setupInstructions validatorSource
    auditRequired: boolean | undefined
    context: string | undefined
    dataResidency: string | readonly string[] | undefined
    declaration: SourcePosition

    Where this variable's own schema property is declared. See ADR 0036.

    defaultValue: { ok: true; value: unknown } | { ok: false } | undefined
    description: string | undefined
    documented: boolean
    evidence: DiscoveredVariableEvidence | undefined

    The evidence sub-object from this variable's linked documentation -- re-verified every run, unlike every declared-only field above. See runtime.VariableEvidenceDocs and ADR 0037.

    expiresAt: string | undefined
    hasDefault: boolean
    hasProcessor: boolean
    hasValidator: boolean
    key: string
    legalBasis: string | undefined
    metadata: Readonly<Record<string, unknown>> | undefined
    owner: string | undefined
    processorReturnType: string | undefined
    processorSource: string | undefined
    purpose: string | undefined
    refreshInstructions: string | undefined
    required: boolean | undefined
    retention: string | undefined
    sensitivity: string | undefined
    setupInstructions: string | undefined
    validatorSource: string | undefined

    Settings
    Member Visibility

    On This Page
    Properties