1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.// This module is browser compatible.import { AssertionError } from "./assertion_error.ts";import { stripAnsiCode } from "../fmt/colors.ts";
/** * Make an assertion that `error` is an `Error`. * If not then an error will be thrown. * An error class and a string that should be included in the * error message can also be asserted. * * @example * ```ts * import { assertIsError } from "https://deno.land/std@$STD_VERSION/assert/assert_is_error.ts"; * * assertIsError(null); // Throws * assertIsError(new RangeError("Out of range")); // Doesn't throw * assertIsError(new RangeError("Out of range"), SyntaxError); // Throws * assertIsError(new RangeError("Out of range"), SyntaxError, "Out of range"); // Doesn't throw * assertIsError(new RangeError("Out of range"), SyntaxError, "Within range"); // Throws * ``` */export function assertIsError<E extends Error = Error>(  error: unknown,  // deno-lint-ignore no-explicit-any  ErrorClass?: new (...args: any[]) => E,  msgMatches?: string | RegExp,  msg?: string,): asserts error is E {  const msgSuffix = msg ? `: ${msg}` : ".";  if (!(error instanceof Error)) {    throw new AssertionError(      `Expected "error" to be an Error object${msgSuffix}}`,    );  }  if (ErrorClass && !(error instanceof ErrorClass)) {    msg = `Expected error to be instance of "${ErrorClass.name}", but was "${      typeof error === "object" ? error?.constructor?.name : "[not an object]"    }"${msgSuffix}`;    throw new AssertionError(msg);  }  let msgCheck;  if (typeof msgMatches === "string") {    msgCheck = stripAnsiCode(error.message).includes(      stripAnsiCode(msgMatches),    );  }  if (msgMatches instanceof RegExp) {    msgCheck = msgMatches.test(stripAnsiCode(error.message));  }
  if (msgMatches && !msgCheck) {    msg = `Expected error message to include ${      msgMatches instanceof RegExp        ? msgMatches.toString()        : JSON.stringify(msgMatches)    }, but got ${      error instanceof Error        ? JSON.stringify(error.message)        : '"[not an Error]"' // TODO(kt3k): show more useful information    }${msgSuffix}`;    throw new AssertionError(msg);  }}