Method match

src/error.ts:81–92

Use in tests to check if a thrown error is the error you expected.

(
    error: unknown,
    {message, exitCode, print}: {message?: RegExp | string; exitCode?: number; print?: boolean} = {}
  )

  /** Use in tests to check if a thrown error is the error you expected. */
  static match(
    error: unknown,
    {message, exitCode, print}: {message?: RegExp | string; exitCode?: number; print?: boolean} = {}
  ): error is CliError {
    if (!(error instanceof Error)) return false;
    if (!(error instanceof CliError)) return false;
    if (message !== undefined && typeof message === "string" && error.message !== message) return false;
    if (message !== undefined && message instanceof RegExp && !message.test(error.message)) return false;
    if (exitCode !== undefined && error.exitCode !== exitCode) return false;
    if (print !== undefined && error.print !== print) return false;
    return true;
  }
}