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

    Interface DiscoveredVariable

    One schema variable merged with its linked documentEnv() documentation. Its governance fields (owner .. metadata) are EnvGovernanceFields -- each an individual-variable override of the contract's own value, from the linked documentEnv() call's matching variables entry, or undefined.

    interface DiscoveredVariable {
        auditRequired: boolean | undefined;
        authenticatorType: string | undefined;
        context: string | undefined;
        dataResidency: string | readonly string[] | undefined;
        declaration: SourcePosition;
        defaultValue: { ok: true; value: unknown } | { ok: false } | undefined;
        deprecated: boolean | undefined;
        deprecatedReason: string | undefined;
        description: string | undefined;
        documented: boolean;
        evidence: DiscoveredVariableEvidence | undefined;
        expiresAt: string | undefined;
        hasDefault: boolean;
        hasProcessor: boolean;
        hasValidator: boolean;
        key: string;
        lastRotatedAt: string | undefined;
        legalBasis: string | undefined;
        metadata: Readonly<Record<string, unknown>> | undefined;
        owner: string | undefined;
        processorReturnType: string | undefined;
        processorSource: string | undefined;
        purpose: string | undefined;
        refreshInstructions: string | undefined;
        removeBy: string | undefined;
        renamedFrom: string | undefined;
        required: boolean | undefined;
        retention: string | undefined;
        rotationPeriod: string | undefined;
        rotationTriggerEvents: readonly string[] | undefined;
        sensitivity: string | undefined;
        setupInstructions: string | undefined;
        validatorSource: string | undefined;
    }

    Hierarchy (View Summary)

    Index
    auditRequired authenticatorType context dataResidency declaration defaultValue deprecated deprecatedReason description documented evidence expiresAt hasDefault hasProcessor hasValidator key lastRotatedAt legalBasis metadata owner processorReturnType processorSource purpose refreshInstructions removeBy renamedFrom required retention rotationPeriod rotationTriggerEvents sensitivity setupInstructions validatorSource
    auditRequired: boolean | undefined
    authenticatorType: string | undefined

    From the linked documentEnv() call's matching variables entry, if any.

    context: string | undefined

    The variable's statically-resolved context, if set to a non-empty string literal (see ADR 0022). undefined when absent, non-literal, or empty.

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

    Where this variable's own schema property (e.g. SESSION_SECRET: z.string()) is declared -- distinct from the contract's declaration/documentation (link.ts); every variable has exactly one of these, always. See ADR 0036.

    defaultValue: { ok: true; value: unknown } | { ok: false } | undefined

    The default's statically-evaluated literal value, if hasDefault and it was a literal we could evaluate -- { ok: false } when present but not statically resolvable, undefined when absent.

    Type Declaration

    • { ok: true; value: unknown }
      • ok: true

        Always true in this branch.

      • value: unknown

        The evaluated literal value.

    • { ok: false }
      • ok: false

        Always false in this branch: present but not statically resolvable.

    • undefined
    deprecated: boolean | undefined

    From the linked documentEnv() call's matching variables entry, if any.

    deprecatedReason: string | undefined

    From the linked documentEnv() call's matching variables entry, if any.

    description: string | undefined

    From the linked documentEnv() call's matching variables entry, if any.

    documented: boolean

    Whether this specific key had a matching entry in the linked documentEnv() call, if any.

    evidence: DiscoveredVariableEvidence | undefined

    The linked documentEnv() entry's evidence sub-object -- the re-verified-every-run half of this variable's documentation, deliberately not flattened in alongside the declared-only fields above. See runtime.VariableEvidenceDocs and ADR 0037.

    expiresAt: string | undefined
    hasDefault: boolean

    Whether the entry declares a default.

    hasProcessor: boolean

    Whether the entry declares a processor.

    hasValidator: boolean

    Whether the entry declares a validator.

    key: string

    The environment variable name (the schema's object key).

    lastRotatedAt: string | undefined

    From the linked documentEnv() call's matching variables entry, if any.

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

    Only present when the processor has an explicit : T return type annotation -- the one thing we treat as provable.

    processorSource: string | undefined

    The processor function's source text, normalized to single-line, if hasProcessor.

    purpose: string | undefined
    refreshInstructions: string | undefined

    From the linked documentEnv() call's matching variables entry, if any.

    removeBy: string | undefined

    From the linked documentEnv() call's matching variables entry, if any.

    renamedFrom: string | undefined

    From the linked documentEnv() call's matching variables entry, if any -- the previous variable name this one renames, if this declaration is the result of a rename.

    required: boolean | undefined

    From the linked documentEnv() call's matching variables entry, if any.

    retention: string | undefined
    rotationPeriod: string | undefined

    From the linked documentEnv() call's matching variables entry, if any.

    rotationTriggerEvents: readonly string[] | undefined

    From the linked documentEnv() call's matching variables entry, if any.

    sensitivity: string | undefined
    setupInstructions: string | undefined

    From the linked documentEnv() call's matching variables entry, if any.

    validatorSource: string | undefined

    The validator function's source text, normalized to single-line, if hasValidator.

    Settings
    Member Visibility

    On This Page
    Properties