Introduction to Diffex

Diffex is a powerful tool designed to streamline the process of comparing and visualizing differences between various data sets or code versions.

API Examples

Below are some useful Diffex API examples that will empower your development process.

Create a Diff

  
    diffex.createDiff('string1', 'string2');
  

This example shows how to create a diff between two strings. This simple yet critical function allows for quick comparisons and visual reviews.

Apply a Diff

  
    diffex.applyDiff(originalString, diff);
  

This API applies the computed diff to the original string, effectively updating it to match the final version.

Get Diff Metadata

  
    diffex.getDiffMetadata(diff);
  

Retrieve detailed metadata about the computed diff, useful for logging and auditing purposes.

Format Diff for Display

  
    diffex.formatDiffForDisplay(diff);
  

Convert the diff data into a user-friendly format suitable for display in a UI or report.

Export Diff to File

  
    diffex.exportDiffToFile(diff, 'diff.txt');
  

Output the diff to a file, allowing further analysis or sharing with team members.

App Example Using Diffex

Here’s a simple example of an application that uses the introduced APIs.

App Code

  
    const string1 = 'Hello World';
    const string2 = 'Hello Diffex World';
    
    const diff = diffex.createDiff(string1, string2);
    const formattedDiff = diffex.formatDiffForDisplay(diff);

    console.log('Diff: ', formattedDiff);

    const updatedString = diffex.applyDiff(string1, diff);
    console.log('Updated String: ', updatedString);

    diffex.exportDiffToFile(diff, 'exampleDiff.txt');
  

Hash: 8b439c2e1efd365a22d6a90ebce7018c3d9b4a2cf3f871135eaabcadf0d605cf