Skip to content

type-diff is a library to diff two strings, useful for showing for typing games (like monkeytype) or for showing differences between two strings. It is a simple library that is easy to use and has no dependencies. It is also very fast and lightweight.

License

Notifications You must be signed in to change notification settings

techboy-coder/typer-diff

Repository files navigation

Typer Diff

Typer Diff Demo

typer-diff is a library to diff two strings, useful for showing for typing games (like monkeytype) or for showing differences between two strings. It is a simple library that is easy to use and has no dependencies. It is also very fast and lightweight.

Check out a demo at typer-diff.vercel.app.

Usage

Usage:

import { diff } from "typer-diff";

// ...
return diff(text.original, text.text);
// ...

Types:

type DiffItem = {
    value: string;
    type: "correct" | "extra" | "missing" | "wrong" | "untouched" | "spacer";
};
type DiffResult = {
    diff: DiffItem[];
    end: boolean;
};
declare const diff: (originalText: string, typedText: string) => DiffResult;

export { type DiffItem, type DiffResult, diff };

About

type-diff is a library to diff two strings, useful for showing for typing games (like monkeytype) or for showing differences between two strings. It is a simple library that is easy to use and has no dependencies. It is also very fast and lightweight.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published