BREAKING(assert): make unreachable() consistent with @std/assert (#…

…4943) * BREAKING(assert): make `unreachable()` consistent with `@std/assert` * fix * fix
denoland · Jun 3, 2024 · c2b5460 · c2b5460
1 parent e34245b
commit c2b5460
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/assert/unreachable.ts b/assert/unreachable.ts
@@ -12,9 +12,10 @@ import { AssertionError } from "./assertion_error.ts";
  * unreachable(); // Throws
  * ```
  *
- * @param reason The reason why the code should be unreachable.
+ * @param msg Optional message to include in the error.
  * @returns Never returns, always throws.
  */
-export function unreachable(reason?: string): never {
-  throw new AssertionError(reason ?? "unreachable");
+export function unreachable(msg?: string): never {
+  const msgSuffix = msg ? `: ${msg}` : ".";
+  throw new AssertionError(`Unreachable${msgSuffix}`);
 }
diff --git a/assert/unreachable_test.ts b/assert/unreachable_test.ts
@@ -2,10 +2,10 @@
 import { AssertionError, assertThrows, unreachable } from "./mod.ts";
 
 Deno.test("unreachable()", () => {
-  assertThrows(() => unreachable(), AssertionError, "unreachable");
+  assertThrows(() => unreachable(), AssertionError, "Unreachable.");
   assertThrows(
     () => unreachable("custom message"),
     AssertionError,
-    "custom message",
+    "Unreachable: custom message",
   );
 });