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

    Interface GenerateUsageReportOptions

    Options for generateUsageReport.

    interface GenerateUsageReportOptions {
        exclude?: string[];
        fs: BuildFileSystem;
        include?: string[];
        packages?: readonly string[];
        report?: { location: string };
        root?: string;
        tsconfig?: string | false;
    }
    Index
    exclude? fs include? packages? report? root? tsconfig?
    exclude?: string[]

    Glob patterns to exclude, for both schema discovery and the usage scan. Defaults to node_modules/dist/.git.

    fs: BuildFileSystem

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

    include?: string[]

    Schema-discovery glob, for the contract graph -- self-sufficient like the other two generator functions.

    packages?: readonly string[]

    See GenerateEnvManifestOptions.packages; see ADR 0014.

    report?: { location: string }

    Also write the rendered Markdown report to this path, relative to root. Omitted: the report is only returned, not written.

    Type Declaration

    • location: string

      Output path for the report, relative to root.

    root?: string

    Directory glob patterns are resolved against. Defaults to process.cwd().

    tsconfig?: string | false

    See GenerateEnvManifestOptions.tsconfig; see ADR 0023.

    Settings
    Member Visibility

    On This Page
    Properties