docs(internal): add module docs (#4757)

This commit is contained in:
Asher Gomez 2024-05-17 14:59:10 +10:00 committed by GitHub
parent a724d90685
commit 1eeb5f9a6f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -5,6 +5,35 @@
* *
* Note: this module is for internal use only and should not be used directly. * Note: this module is for internal use only and should not be used directly.
* *
* ```ts
* import { diff, diffstr, buildMessage } from "@std/internal";
* import { assertEquals } from "@std/assert/assert-equals";
*
* const a = [1, 2, 3];
* const b = [1, 2, 4];
*
* assertEquals(diff(a, b), [
* { type: "common", value: 1 },
* { type: "common", value: 2 },
* { type: "removed", value: 3 },
* { type: "added", value: 4 },
* ]);
*
* const diffResult = diffstr("Hello, world!", "Hello, world");
*
* console.log(buildMessage(diffResult));
* // [
* // "",
* // "",
* // " [Diff] Actual / Expected",
* // "",
* // "",
* // "- Hello, world!",
* // "+ Hello, world",
* // "",
* // ]
* ```
*
* @module * @module
*/ */
export * from "./build_message.ts"; export * from "./build_message.ts";