data-cap
    Preparing search index...

    Interface GenerateDocumentationOptions

    Options for generateDocumentation.

    interface GenerateDocumentationOptions {
        changes?: ManifestChangeReport;
        edges?: readonly DependencyEdge[];
        evidencePath?: string;
        expiringWithinDays?: number;
        generatedAt?: Date;
        inventory: CapabilityInventory;
        location: string;
        root: string;
    }
    Index
    changes? edges? evidencePath? expiringWithinDays? generatedAt? inventory location root
    changes?: ManifestChangeReport

    Manifest changes since the last report, rendered as a "changes since last report" section when present.

    edges?: readonly DependencyEdge[]

    Proven usage edges, when the caller already ran the usage scan (--ownership/--flow) -- renders exact file:line:column consumption sites per field when supplied. Omit when no usage scan ran; the catalog still renders, just without that column populated.

    evidencePath?: string

    This same run's own --evidence output path, when requested -- named in the generated banner's Evidence Model note.

    expiringWithinDays?: number

    How many days out counts as "expiring soon" in the rendered Lifecycle section. Defaults to DEFAULT_EXPIRING_WITHIN_DAYS (30), matching env-cap's own default.

    generatedAt?: Date

    The instant daysRemaining is measured from. Defaults to the wall clock at call time; generateDataArtifacts passes its own single run-wide instant, so the catalog and the published Evidence Model can never report a different "12d remaining" for the same field.

    inventory: CapabilityInventory

    The inventory to render documentation from.

    location: string

    Output path for the rendered documentation catalog.

    root: string

    Discovery root every rendered path displays relative to.

    Settings
    Member Visibility

    On This Page
    Properties