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

    Interface DiscoveredVariableDocs

    One variable's statically-extracted documentEnv() documentation, as declared in that call's variables entry for this key -- governance fields (owner .. metadata) are EnvGovernanceFields, resolved from static literals.

    interface DiscoveredVariableDocs {
        auditRequired: boolean | undefined;
        authenticatorType: string | undefined;
        dataResidency: string | readonly string[] | undefined;
        deprecated: boolean | undefined;
        deprecatedReason: string | undefined;
        description: string | undefined;
        evidence: DiscoveredVariableEvidence | undefined;
        expiresAt: string | undefined;
        key: string;
        lastRotatedAt: string | undefined;
        legalBasis: string | undefined;
        metadata: Readonly<Record<string, unknown>> | undefined;
        owner: 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;
    }

    Hierarchy

    • EnvGovernanceFields
      • DiscoveredVariableDocs
    Index
    auditRequired authenticatorType dataResidency deprecated deprecatedReason description evidence expiresAt key lastRotatedAt legalBasis metadata owner purpose refreshInstructions removeBy renamedFrom required retention rotationPeriod rotationTriggerEvents sensitivity setupInstructions
    auditRequired: boolean | undefined
    authenticatorType: string | undefined

    Statically-resolved authenticatorType, if set to a string literal.

    dataResidency: string | readonly string[] | undefined
    deprecated: boolean | undefined

    Statically-resolved deprecated, if set to a boolean literal.

    deprecatedReason: string | undefined

    Statically-resolved deprecatedReason, if set to a string literal.

    description: string | undefined

    Statically-resolved description, if set to a string literal.

    evidence: DiscoveredVariableEvidence | undefined

    Statically-extracted evidence sub-object -- the re-verified-every-run half of a variable's documentation, kept structurally apart from the declared-only fields above. undefined when the declaration has no evidence key at all. See runtime.VariableEvidenceDocs and ADR 0037.

    expiresAt: string | undefined
    key: string

    The environment variable name this documentation applies to.

    lastRotatedAt: string | undefined

    Statically-resolved lastRotatedAt, if set to a string literal.

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

    Statically-resolved refreshInstructions, if set to a string literal.

    removeBy: string | undefined

    Statically-resolved removeBy, if set to a string literal.

    renamedFrom: string | undefined

    Statically-resolved renamedFrom, if set to a string literal.

    required: boolean | undefined

    Statically-resolved required, if set to a boolean literal.

    retention: string | undefined
    rotationPeriod: string | undefined

    Statically-resolved rotationPeriod, if set to a string literal.

    rotationTriggerEvents: readonly string[] | undefined

    Statically-resolved rotationTriggerEvents, if set to an array of string literals.

    sensitivity: string | undefined
    setupInstructions: string | undefined

    Statically-resolved setupInstructions, if set to a string literal.

    Settings
    Member Visibility

    On This Page
    Properties