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

    Interface DiscoveredContractDocs

    The documentEnv() contract-level documentation, resolved from static literals at the parse stage. Its governance fields (owner .. metadata) are EnvGovernanceFields.

    interface DiscoveredContractDocs {
        active: boolean;
        auditRequired: boolean | undefined;
        category: string | undefined;
        dataResidency: string | readonly string[] | undefined;
        deprecated: boolean | undefined;
        deprecatedReason: string | undefined;
        exclusiveGroup: string | undefined;
        expiresAt: string | undefined;
        legalBasis: string | undefined;
        metadata: Readonly<Record<string, unknown>> | undefined;
        name: string | undefined;
        owner: string | undefined;
        purpose: string | undefined;
        retention: string | undefined;
        sensitivity: string | undefined;
        variables: ReadonlyMap<string, DiscoveredVariableDocs>;
    }

    Hierarchy

    • EnvGovernanceFields
      • DiscoveredContractDocs
    Index
    active auditRequired category dataResidency deprecated deprecatedReason exclusiveGroup expiresAt legalBasis metadata name owner purpose retention sensitivity variables
    active: boolean

    Defaults to true when the call's active field is absent or not statically resolvable.

    auditRequired: boolean | undefined
    category: string | undefined

    Statically-resolved category, 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.

    exclusiveGroup: string | undefined

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

    expiresAt: string | undefined
    legalBasis: string | undefined
    metadata: Readonly<Record<string, unknown>> | undefined
    name: string | undefined

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

    owner: string | undefined
    purpose: string | undefined
    retention: string | undefined
    sensitivity: string | undefined
    variables: ReadonlyMap<string, DiscoveredVariableDocs>

    Per-variable documentation, keyed by variable name.

    Settings
    Member Visibility

    On This Page
    Properties