std/assert/unreachable.ts

18 lines
479 B
TypeScript

// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
// This module is browser compatible.
import { AssertionError } from "./assertion_error.ts";
/**
* Use this to assert unreachable code.
*
* @example
* ```ts
* import { unreachable } from "https://deno.land/std@$STD_VERSION/assert/unreachable.ts";
*
* unreachable(); // Throws
* ```
*/
export function unreachable(reason?: string): never {
throw new AssertionError(reason ?? "unreachable");
}