std/assert/assert_not_instance_of.ts
2024-04-29 11:57:30 +09:00

28 lines
866 B
TypeScript

// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
// This module is browser compatible.
import { assertFalse } from "./assert_false.ts";
/**
* Make an assertion that `obj` is not an instance of `type`.
* If so, then throw.
*
* @example
* ```ts
* import { assertNotInstanceOf } from "@std/assert/assert-not-instance-of";
*
* assertNotInstanceOf(new Date(), Number); // Doesn't throw
* assertNotInstanceOf(new Date(), Date); // Throws
* ```
*/
export function assertNotInstanceOf<A, T>(
actual: A,
// deno-lint-ignore no-explicit-any
unexpectedType: new (...args: any[]) => T,
msg?: string,
): asserts actual is Exclude<A, T> {
const msgSuffix = msg ? `: ${msg}` : ".";
msg =
`Expected object to not be an instance of "${typeof unexpectedType}"${msgSuffix}`;
assertFalse(actual instanceof unexpectedType, msg);
}