typer-diff
v1.1.1
Published
typer-diff is a library to diff two strings, useful for showing for typing games 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.
Downloads
1,966
Maintainers
Readme
Typer Diff
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 };