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

    Interface RenderDocsOptions

    Options for renderDocs.

    interface RenderDocsOptions {
        expiringWithinDays: number;
        generatedAt: Date;
        previousContent: string | undefined;
        undocumentedContracts: readonly UndocumentedContractRef[];
        undocumentedVariables: readonly UndocumentedVariableRef[];
    }
    Index
    expiringWithinDays generatedAt previousContent undocumentedContracts undocumentedVariables
    expiringWithinDays: number

    How many days out counts as "expiring soon" in the lifecycle report and security review.

    generatedAt: Date

    Timestamp rendered into the header and used for expiry/days-remaining math.

    previousContent: string | undefined

    Content already at docs.location, if any -- used only for the "changes since last report" summary.

    undocumentedContracts: readonly UndocumentedContractRef[]

    Contracts with no linked documentEnv() call at all. file must be root-relative, POSIX-separated -- matching contracts' own ContractModel convention, since this is matched against it by identity.

    undocumentedVariables: readonly UndocumentedVariableRef[]

    Schema variables with no matching entry in their contract's linked documentation. Only how many there are is rendered (the security-review counter), so file is not matched against anything.

    Settings
    Member Visibility

    On This Page
    Properties