@lou.codes/test/dist/stringifyDifference.d.ts

✅ Equality test with enforced readability

import type { Difference } from "./Difference.js";
/**
 * Takes a `Difference` object and returns a string using `stringifyDifferenceDictionary`.
 *
 * @category Output
 * @example
 * ```typescript
 * stringifyDifference({
 * 	kind: "DELETE",
 * 	left: "🟢",
 * 	path: ["🟢", "🟩"],
 * }); // "🟢.🟩 is missing."
 *
 * stringifyDifference({
 * 	kind: 8,
 * 	error: "❌",
 * }); // "there was an uncaught error: ❌."
 * ```
 * @param difference Difference object.
 * @returns Formatted string.
 */
export declare const stringifyDifference: ({ kind, ...difference }: Difference) => string;