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

    Interface EnvExampleResult

    The result of a completed writeEnvExample call.

    interface EnvExampleResult {
        skippedExistingPath: string | undefined;
        staleVariables: readonly string[];
        variablesToAdd: readonly string[];
        variablesToComment: readonly string[];
        writtenPath: string | undefined;
    }
    Index
    skippedExistingPath staleVariables variablesToAdd variablesToComment writtenPath
    skippedExistingPath: string | undefined

    Set when a file already existed at the requested location and was left untouched: with the default "keep-sibling", writtenPath is a fresh timestamped sibling instead; with "skip", this is the only outcome and writtenPath is undefined. Always undefined with "overwrite".

    staleVariables: readonly string[]

    Variable names (live or already commented-out) in an existing example file that no discovered contract declares anymore.

    variablesToAdd: readonly string[]

    Variables the current (active) configuration requires that aren't yet a live entry in an existing example file.

    variablesToComment: readonly string[]

    Variables live in an existing example file whose feature is no longer active, and that no other active feature still needs -- safe to comment out.

    writtenPath: string | undefined

    Where the example file actually got written. undefined only when onExisting: "skip" left an existing file untouched and nothing was written.

    Settings
    Member Visibility

    On This Page
    Properties