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

    Interface DiscoveredContract

    One createEnv() contract, merged with its linked documentEnv() documentation (if any). Its governance fields (owner .. metadata) are EnvGovernanceFields -- contract-level defaults that individual variables may override.

    interface DiscoveredContract {
        active: boolean;
        auditRequired: boolean | undefined;
        category: string | undefined;
        contractName: string;
        dataResidency: string | readonly string[] | undefined;
        declaration: SourcePosition;
        deprecated: boolean | undefined;
        deprecatedReason: string | undefined;
        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 DiscoveredVariable[];
    }

    Hierarchy

    • EnvGovernanceFields
      • DiscoveredContract
    Index
    active auditRequired category contractName dataResidency declaration deprecated deprecatedReason documentation documented exclusiveGroup expiresAt exportName file legalBasis metadata owner packageOrigin purpose retention sensitivity variables
    active: boolean

    From the linked documentEnv()'s active option. Defaults to true when omitted or undocumented.

    auditRequired: boolean | undefined
    category: string | undefined

    From the linked documentEnv() call, if any.

    contractName: string

    Resolved display name: linked documentEnv()'s name, else createEnv()'s own name option, else exportName.

    dataResidency: string | readonly string[] | undefined
    declaration: SourcePosition

    Where this contract's createEnv(...) call is declared. Always present -- every discovered contract has one, by definition. See ADR 0036.

    deprecated: boolean | undefined

    From the linked documentEnv() call, if any.

    deprecatedReason: string | undefined

    From the linked documentEnv() call, if any.

    documentation: SourcePosition | undefined

    Where this contract's documentEnv(...) call is declared, if one exists. Undefined for a contract that's never been documented. See ADR 0036.

    documented: boolean

    Whether any documentEnv() call is linked to this contract at all.

    exclusiveGroup: string | undefined

    From the linked documentEnv() call, if any -- see runtime.ContractDocs.exclusiveGroup.

    expiresAt: string | undefined
    exportName: string

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

    file: string

    Absolute path of the file declaring the createEnv() call.

    legalBasis: string | undefined
    metadata: Readonly<Record<string, unknown>> | undefined
    owner: string | undefined
    packageOrigin: PackageOrigin | undefined

    Set when this contract was discovered via an allow-listed package's declared schema entry point rather than local discovery -- the bare package name renderManifest() must import from instead of computing a relative path to the (analysis-only) resolved file. See ADR 0014.

    purpose: string | undefined
    retention: string | undefined
    sensitivity: string | undefined
    variables: readonly DiscoveredVariable[]

    Every variable declared in the schema, merged with its linked documentation.

    Settings
    Member Visibility

    On This Page
    Properties