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

    Interface GenerateDocumentationOptions

    Options for generateDocumentation.

    interface GenerateDocumentationOptions {
        envExample?: { location: string; onExisting?: EnvExampleOnExisting };
        exclude?: string[];
        expiringWithinDays?: number;
        fs: BuildFileSystem;
        include?: string[];
        liveExpirationDates?: LiveExpirationDates;
        location: string;
        packages?: readonly string[];
        root?: string;
        tsconfig?: string | false;
    }
    Index
    envExample? exclude? expiringWithinDays? fs include? liveExpirationDates? location packages? root? tsconfig?
    envExample?: { location: string; onExisting?: EnvExampleOnExisting }

    Also emit a .env.example-style file, relative to root. onExisting controls what happens when a file already exists there -- defaults to "keep-sibling" (never overwrites; see EnvExampleOnExisting and EnvExampleResult).

    Type Declaration

    • location: string

      Output path for the .env.example-style file, relative to root.

    • OptionalonExisting?: EnvExampleOnExisting

      What to do when a file already exists at location. Defaults to "keep-sibling".

    exclude?: string[]

    Glob patterns for files/directories to prune. Defaults to defaultExclude().

    expiringWithinDays?: number

    How many days out counts as "expiring soon". Defaults to 30.

    fs: BuildFileSystem

    The filesystem capability -- ./build never imports node:fs (ADR 0040).

    include?: string[]

    Glob patterns for files to scan. Defaults to defaultInclude().

    liveExpirationDates?: LiveExpirationDates

    Supplies expiration metadata from a live source as a post-discovery override, invoked exactly once with every discovered variable name after linking completes and before rendering. See live-expirations.ts and ADR 0012. Omitted: behavior is unchanged from a purely static expiresAt.

    location: string

    Output path for the Markdown docs artifact, relative to root.

    packages?: readonly string[]

    See GenerateEnvManifestOptions.packages; see ADR 0014.

    root?: string

    Project root schema discovery is relative to. Defaults to process.cwd().

    tsconfig?: string | false

    See GenerateEnvManifestOptions.tsconfig; see ADR 0023.

    Settings
    Member Visibility

    On This Page
    Properties