@mtkruto/node 0.0.971 → 0.0.972

package/{esm/deps/deno.land/std@0.190.0 → script/deps/deno.land/std@0.196.0}/testing/asserts.d.ts

@@ -1,202 +1,178 @@
-export declare class AssertionError extends Error {
-    name: string;
-    constructor(message: string);
-}
 /**
- * Deep equality comparison used in assertions
- * @param c actual value
- * @param d expected value
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/mod.ts` instead.
+ *
+ * A library of assertion functions.
+ * If the assertion is false an `AssertionError` will be thrown which will
+ * result in pretty-printed diff of failing assertion.
+ *
+ * This module is browser compatible, but do not rely on good formatting of
+ * values for AssertionError messages in browsers.
+ *
+ * @module
  */
-export declare function equal(c: unknown, d: unknown): boolean;
-/** Make an assertion, error will be thrown if `expr` does not have truthy value. */
-export declare function assert(expr: unknown, msg?: string): asserts expr;
-/** Make an assertion, error will be thrown if `expr` have truthy value. */
-type Falsy = false | 0 | 0n | "" | null | undefined;
-export declare function assertFalse(expr: unknown, msg?: string): asserts expr is Falsy;
+export { 
 /**
- * Make an assertion that `actual` and `expected` are equal, deeply. If not
- * deeply equal, then throw.
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert.ts` instead.
  *
- * Type parameter can be specified to ensure values under comparison have the same type.
+ * Make an assertion, error will be thrown if `expr` does not have truthy value.
+ */
+assert, 
+/**
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_almost_equals.ts` instead.
+ *
+ * Make an assertion that `actual` and `expected` are almost equal numbers through
+ * a given tolerance. It can be used to take into account IEEE-754 double-precision
+ * floating-point representation limitations.
+ * If the values are not almost equal then throw.
  *
  * @example
  * ```ts
- * import { assertEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
+ * import { assertAlmostEquals, assertThrows } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
  *
- * Deno.test("example", function (): void {
- *   assertEquals("world", "world");
- *   assertEquals({ hello: "world" }, { hello: "world" });
- * });
+ * assertAlmostEquals(0.1, 0.2);
+ *
+ * // Using a custom tolerance value
+ * assertAlmostEquals(0.1 + 0.2, 0.3, 1e-16);
+ * assertThrows(() => assertAlmostEquals(0.1 + 0.2, 0.3, 1e-17));
  * ```
  */
-export declare function assertEquals<T>(actual: T, expected: T, msg?: string): void;
+assertAlmostEquals, 
 /**
- * Make an assertion that `actual` and `expected` are not equal, deeply.
- * If not then throw.
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_array_includes.ts` instead.
+ *
+ * Make an assertion that `actual` includes the `expected` values.
+ * If not then an error will be thrown.
  *
  * Type parameter can be specified to ensure values under comparison have the same type.
  *
  * @example
  * ```ts
- * import { assertNotEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
+ * import { assertArrayIncludes } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
  *
- * assertNotEquals<number>(1, 2)
+ * assertArrayIncludes<number>([1, 2], [2])
  * ```
  */
-export declare function assertNotEquals<T>(actual: T, expected: T, msg?: string): void;
+assertArrayIncludes, 
 /**
- * Make an assertion that `actual` and `expected` are strictly equal. If
- * not then throw.
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_equals.ts` instead.
+ *
+ * Make an assertion that `actual` and `expected` are equal, deeply. If not
+ * deeply equal, then throw.
+ *
+ * Type parameter can be specified to ensure values under comparison have the same type.
  *
  * @example
  * ```ts
- * import { assertStrictEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
- *
- * Deno.test("isStrictlyEqual", function (): void {
- *   const a = {};
- *   const b = a;
- *   assertStrictEquals(a, b);
- * });
+ * import { assertEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
  *
- * // This test fails
- * Deno.test("isNotStrictlyEqual", function (): void {
- *   const a = {};
- *   const b = {};
- *   assertStrictEquals(a, b);
+ * Deno.test("example", function (): void {
+ *   assertEquals("world", "world");
+ *   assertEquals({ hello: "world" }, { hello: "world" });
  * });
  * ```
  */
-export declare function assertStrictEquals<T>(actual: unknown, expected: T, msg?: string): asserts actual is T;
+assertEquals, 
 /**
- * Make an assertion that `actual` and `expected` are not strictly equal.
- * If the values are strictly equal then throw.
- *
- * ```ts
- * import { assertNotStrictEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_exists.ts` instead.
  *
- * assertNotStrictEquals(1, 1)
- * ```
+ * Make an assertion that actual is not null or undefined.
+ * If not then throw.
  */
-export declare function assertNotStrictEquals<T>(actual: T, expected: T, msg?: string): void;
+assertExists, 
 /**
- * Make an assertion that `actual` and `expected` are almost equal numbers through
- * a given tolerance. It can be used to take into account IEEE-754 double-precision
- * floating-point representation limitations.
- * If the values are not almost equal then throw.
- *
- * @example
- * ```ts
- * import { assertAlmostEquals, assertThrows } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_false.ts` instead.
  *
- * assertAlmostEquals(0.1, 0.2);
- *
- * // Using a custom tolerance value
- * assertAlmostEquals(0.1 + 0.2, 0.3, 1e-16);
- * assertThrows(() => assertAlmostEquals(0.1 + 0.2, 0.3, 1e-17));
- * ```
+ * Make an assertion, error will be thrown if `expr` have truthy value.
  */
-export declare function assertAlmostEquals(actual: number, expected: number, tolerance?: number, msg?: string): void;
-type AnyConstructor = new (...args: any[]) => any;
-type GetConstructorType<T extends AnyConstructor> = T extends new (...args: any) => infer C ? C : never;
+assertFalse, 
 /**
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_instance_of.ts` instead.
+ *
  * Make an assertion that `obj` is an instance of `type`.
  * If not then throw.
  */
-export declare function assertInstanceOf<T extends AnyConstructor>(actual: unknown, expectedType: T, msg?: string): asserts actual is GetConstructorType<T>;
-/**
- * Make an assertion that `obj` is not an instance of `type`.
- * If so, then throw.
- */
-export declare function assertNotInstanceOf<A, T>(actual: A, unexpectedType: new (...args: any[]) => T, msg?: string): asserts actual is Exclude<A, T>;
+assertInstanceOf, 
+/** @deprecated (will be removed after 1.0.0) Import from `std/assert/assertion_error.ts` instead. */
+AssertionError, 
 /**
- * Make an assertion that actual is not null or undefined.
- * If not then throw.
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_is_error.ts` instead.
+ *
+ * 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.
  */
-export declare function assertExists<T>(actual: T, msg?: string): asserts actual is NonNullable<T>;
+assertIsError, 
 /**
- * Make an assertion that actual includes expected. If not
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_match.ts` instead.
+ *
+ * Make an assertion that `actual` match RegExp `expected`. If not
  * then throw.
  */
-export declare function assertStringIncludes(actual: string, expected: string, msg?: string): void;
+assertMatch, 
 /**
- * Make an assertion that `actual` includes the `expected` values.
- * If not then an error will be thrown.
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_not_equals.ts` instead.
+ *
+ * Make an assertion that `actual` and `expected` are not equal, deeply.
+ * If not then throw.
  *
  * Type parameter can be specified to ensure values under comparison have the same type.
  *
  * @example
  * ```ts
- * import { assertArrayIncludes } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
+ * import { assertNotEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
  *
- * assertArrayIncludes<number>([1, 2], [2])
+ * assertNotEquals<number>(1, 2)
  * ```
  */
-export declare function assertArrayIncludes<T>(actual: ArrayLike<T>, expected: ArrayLike<T>, msg?: string): void;
-/**
- * Make an assertion that `actual` match RegExp `expected`. If not
- * then throw.
- */
-export declare function assertMatch(actual: string, expected: RegExp, msg?: string): void;
+assertNotEquals, 
 /**
- * Make an assertion that `actual` not match RegExp `expected`. If match
- * then throw.
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_not_instance_of.ts` instead.
+ *
+ * Make an assertion that `obj` is not an instance of `type`.
+ * If so, then throw.
  */
-export declare function assertNotMatch(actual: string, expected: RegExp, msg?: string): void;
+assertNotInstanceOf, 
 /**
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_not_match.ts` instead.
+ *
  * Make an assertion that `actual` object is a subset of `expected` object, deeply.
  * If not, then throw.
  */
-export declare function assertObjectMatch(actual: Record<PropertyKey, any>, expected: Record<PropertyKey, unknown>, msg?: string): void;
-/**
- * Forcefully throws a failed assertion
- */
-export declare function fail(msg?: string): never;
+assertNotMatch, 
 /**
- * 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.
- */
-export declare function assertIsError<E extends Error = Error>(error: unknown, ErrorClass?: new (...args: any[]) => E, msgIncludes?: string, msg?: string): asserts error is E;
-/**
- * Executes a function, expecting it to throw. If it does not, then it
- * throws.
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_not_strict_equals.ts` instead.
  *
- * @example
- * ```ts
- * import { assertThrows } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
+ * Make an assertion that `actual` and `expected` are not strictly equal.
+ * If the values are strictly equal then throw.
  *
- * Deno.test("doesThrow", function (): void {
- *   assertThrows((): void => {
- *     throw new TypeError("hello world!");
- *   });
- * });
+ * ```ts
+ * import { assertNotStrictEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
  *
- * // This test will not pass.
- * Deno.test("fails", function (): void {
- *   assertThrows((): void => {
- *     console.log("Hello world");
- *   });
- * });
+ * assertNotStrictEquals(1, 1)
  * ```
  */
-export declare function assertThrows(fn: () => unknown, msg?: string): unknown;
+assertNotStrictEquals, 
 /**
- * Executes a function, expecting it to throw. If it does not, then it
- * throws. An error class and a string that should be included in the
- * error message can also be asserted.
+ * Make an assertion that `actual` object is a subset of `expected` object, deeply.
+ * If not, then throw.
+ */
+assertObjectMatch, 
+/**
+ * Executes a function which returns a promise, expecting it to reject.
+ * If it does not, then it throws. An error class and a string that should be
+ * included in the error message can also be asserted.
  *
  * @example
- *
  * ```ts
- * import { assertThrows } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
+ * import { assertRejects } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
  *
- * Deno.test("doesThrow", function (): void {
- *   assertThrows((): void => {
+ * Deno.test("doesThrow", async function () {
+ *   await assertRejects(async () => {
  *     throw new TypeError("hello world!");
  *   }, TypeError);
- *   assertThrows(
- *     (): void => {
+ *   await assertRejects(
+ *     async () => {
  *       throw new TypeError("hello world!");
  *     },
  *     TypeError,
@@ -205,18 +181,16 @@ export declare function assertThrows(fn: () => unknown, msg?: string): unknown;
  * });
  *
  * // This test will not pass.
- * Deno.test("fails", function (): void {
- *   assertThrows((): void => {
- *     console.log("Hello world");
- *   });
+ * Deno.test("fails", async function () {
+ *   await assertRejects(
+ *     async () => {
+ *       console.log("Hello world");
+ *     },
+ *   );
  * });
  * ```
- */
-export declare function assertThrows<E extends Error = Error>(fn: () => unknown, ErrorClass: new (...args: any[]) => E, msgIncludes?: string, msg?: string): E;
-/**
- * Executes a function which returns a promise, expecting it to reject.
  *
- * @example
+ *  * @example
  * ```ts
  * import { assertRejects } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
  *
@@ -243,22 +217,56 @@ export declare function assertThrows<E extends Error = Error>(fn: () => unknown,
  * });
  * ```
  */
-export declare function assertRejects(fn: () => PromiseLike<unknown>, msg?: string): Promise<unknown>;
+assertRejects, 
 /**
- * Executes a function which returns a promise, expecting it to reject.
- * If it does not, then it throws. An error class and a string that should be
- * included in the error message can also be asserted.
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_strict_equals.ts` instead.
+ *
+ * Make an assertion that `actual` and `expected` are strictly equal. If
+ * not then throw.
  *
  * @example
  * ```ts
- * import { assertRejects } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
+ * import { assertStrictEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
  *
- * Deno.test("doesThrow", async function () {
- *   await assertRejects(async () => {
+ * Deno.test("isStrictlyEqual", function (): void {
+ *   const a = {};
+ *   const b = a;
+ *   assertStrictEquals(a, b);
+ * });
+ *
+ * // This test fails
+ * Deno.test("isNotStrictlyEqual", function (): void {
+ *   const a = {};
+ *   const b = {};
+ *   assertStrictEquals(a, b);
+ * });
+ * ```
+ */
+assertStrictEquals, 
+/**
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_string_includes.ts` instead.
+ *
+ * Make an assertion that actual includes expected. If not
+ * then throw.
+ */
+assertStringIncludes, 
+/**
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/assert_throws.ts` instead.
+ *
+ * Executes a function, expecting it to throw. If it does not, then it
+ * throws. An error class and a string that should be included in the
+ * error message can also be asserted.
+ *
+ * @example
+ * ```ts
+ * import { assertThrows } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
+ *
+ * Deno.test("doesThrow", function (): void {
+ *   assertThrows((): void => {
  *     throw new TypeError("hello world!");
  *   }, TypeError);
- *   await assertRejects(
- *     async () => {
+ *   assertThrows(
+ *     (): void => {
  *       throw new TypeError("hello world!");
  *     },
  *     TypeError,
@@ -267,18 +275,55 @@ export declare function assertRejects(fn: () => PromiseLike<unknown>, msg?: stri
  * });
  *
  * // This test will not pass.
- * Deno.test("fails", async function () {
- *   await assertRejects(
- *     async () => {
- *       console.log("Hello world");
- *     },
- *   );
+ * Deno.test("fails", function (): void {
+ *   assertThrows((): void => {
+ *     console.log("Hello world");
+ *   });
  * });
  * ```
+ *
+ * @example
+ * ```ts
+ * import { assertThrows } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
+ *
+ * Deno.test("doesThrow", function (): void {
+ *   assertThrows((): void => {
+ *     throw new TypeError("hello world!");
+ *   });
+ * });
+ *
+ * // This test will not pass.
+ * Deno.test("fails", function (): void {
+ *   assertThrows((): void => {
+ *     console.log("Hello world");
+ *   });
+ * });
+ * ```
+ */
+assertThrows, 
+/**
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/equal.ts` instead.
+ *
+ * Deep equality comparison used in assertions
+ * @param c actual value
+ * @param d expected value
+ */
+equal, 
+/**
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/fail.ts` instead.
+ *
+ * Forcefully throws a failed assertion
+ */
+fail, 
+/**
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/unimplemented.ts` instead.
+ *
+ * Use this to stub out methods that will throw when invoked.
+ */
+unimplemented, 
+/**
+ * @deprecated (will be removed after 1.0.0) Import from `std/assert/unreachable.ts` instead.
+ *
+ * Use this to assert unreachable code.
  */
-export declare function assertRejects<E extends Error = Error>(fn: () => PromiseLike<unknown>, ErrorClass: new (...args: any[]) => E, msgIncludes?: string, msg?: string): Promise<E>;
-/** Use this to stub out methods that will throw when invoked. */
-export declare function unimplemented(msg?: string): never;
-/** Use this to assert unreachable code. */
-export declare function unreachable(): never;
-export {};
+unreachable, } from "../assert/mod.js";