std/assert/unreachable.ts
2023-12-07 04:13:38 +11:00

17 lines
416 B
TypeScript

// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
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(): never {
throw new AssertionError("unreachable");
}