Function formattedDiffStrings

  • formattedDiffStrings(originalStr, modifiedStr, extension): Promise<{
        diff: string;
        diffCommand: string;
        directory: string;
    }>

  • Parameters

    • originalStr: string

      the original string to diff

    • modifiedStr: string

      the modified string to diff

    • extension: string

      the extension to use for the tmp files, used for formatting

    Returns Promise<{
        diff: string;
        diffCommand: string;
        directory: string;
    }>

    the return value contains the path to the directory for further inspection, the terminal-printable diff (output of git diff) which can be printed to the console, and the diffCommand to generate the diff for use in other tooling

Settings

Member Visibility

Theme

Generated using TypeDoc