@augment-vir/assert 31.0.0 → 31.1.0

package/dist/assertions/equality/simple-equality.d.ts

@@ -1,12 +1,6 @@
 import { type MaybePromise, type NarrowToExpected } from '@augment-vir/core';
-import { autoGuardSymbol } from '../../guard-types/guard-override.js';
-import { type WaitUntilOptions } from '../../guard-types/wait-until-function.js';
-export declare function strictEquals<const Actual, const Expected extends Actual>(actual: Actual, expected: Expected, failureMessage?: string | undefined): asserts actual is Expected;
-declare function notStrictEquals(actual: unknown, expected: unknown, failureMessage?: string | undefined): void;
-declare function looseEquals(actual: unknown, expected: unknown, failureMessage?: string | undefined): void;
-declare function notLooseEquals(actual: unknown, expected: unknown, failureMessage?: string | undefined): void;
-export declare function deepEquals<const Actual, const Expected extends Actual>(actual: Actual, expected: Expected, failureMessage?: string | undefined): asserts actual is NarrowToExpected<Actual, Expected>;
-declare function notDeepEquals(actual: unknown, expected: unknown, failureMessage?: string | undefined): void;
+import { WaitUntilOptions } from '../../guard-types/wait-until-function.js';
+export declare const deepEquals: <const Actual, const Expected extends Actual>(this: void, actual: Actual, expected: Expected, failureMessage?: string | undefined) => asserts actual is NarrowToExpected<Actual, Expected>;
 export declare const simpleEqualityGuards: {
     assert: {
         /**
@@ -35,7 +29,7 @@ export declare const simpleEqualityGuards: {
          * - {@link assert.notStrictEquals} : the opposite assertion.
          * - {@link assert.looseEquals} : the loose equality assertion.
          */
-        strictEquals: typeof strictEquals;
+        strictEquals<const Actual, const Expected extends Actual>(this: void, actual: Actual, expected: Expected, failureMessage?: string | undefined): asserts actual is Expected;
         /**
          * Asserts that two values are _not_ strictly equal (using
          * [`===`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#strict_equality_using)).
@@ -62,7 +56,7 @@ export declare const simpleEqualityGuards: {
          * - {@link assert.strictEquals} : the opposite assertion.
          * - {@link assert.notLooseEquals} : the loose equality assertion.
          */
-        notStrictEquals: typeof notStrictEquals;
+        notStrictEquals(this: void, actual: unknown, expected: unknown, failureMessage?: string | undefined): void;
         /**
          * Asserts that two values are loosely equal (using
          * [`==`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#loose_equality_using)).
@@ -89,7 +83,7 @@ export declare const simpleEqualityGuards: {
          * - {@link assert.notLooseEquals} : the opposite assertion.
          * - {@link assert.strictEquals} : the strict equality assertion.
          */
-        looseEquals: typeof looseEquals;
+        looseEquals(this: void, actual: unknown, expected: unknown, failureMessage?: string | undefined): void;
         /**
          * Asserts that two values are _not_ loosely equal (using
          * [`==`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#loose_equality_using)).
@@ -116,7 +110,7 @@ export declare const simpleEqualityGuards: {
          * - {@link assert.looseEquals} : the opposite assertion.
          * - {@link assert.strictEquals} : the strict equality assertion.
          */
-        notLooseEquals: typeof notLooseEquals;
+        notLooseEquals(this: void, actual: unknown, expected: unknown, failureMessage?: string | undefined): void;
         /**
          * Asserts that two values are deeply equal using the
          * [deep-eql](https://www.npmjs.com/package/deep-eql) package.
@@ -147,7 +141,7 @@ export declare const simpleEqualityGuards: {
          * - {@link assert.entriesEqual} : a less expensive (but less thorough) deep equality assertion.
          * - {@link assert.jsonEquals} : a less expensive (but less thorough) deep equality assertion.
          */
-        deepEquals: typeof deepEquals;
+        deepEquals<const Actual, const Expected extends Actual>(this: void, actual: Actual, expected: Expected, failureMessage?: string | undefined): asserts actual is NarrowToExpected<Actual, Expected>;
         /**
          * Asserts that two values are _not_ deeply equal using the
          * [deep-eql](https://www.npmjs.com/package/deep-eql) package.
@@ -162,23 +156,23 @@ export declare const simpleEqualityGuards: {
          * ```ts
          * import {assert} from '@augment-vir/assert';
          *
-         * assert.deepEquals('a', 'a'); // false
+         * assert.notDeepEquals('a', 'a'); // false
          *
-         * assert.deepEquals('1', 1); // passes
+         * assert.notDeepEquals('1', 1); // passes
          *
-         * assert.deepEquals({a: 'a'}, {a: 'a'}); // fails
+         * assert.notDeepEquals({a: 'a'}, {a: 'a'}); // fails
          *
          * const objectExample = {a: 'a'};
-         * assert.deepEquals(objectExample, objectExample); // fails
+         * assert.notDeepEquals(objectExample, objectExample); // fails
          * ```
          *
          * @throws {@link AssertionError} If both inputs are deeply equal.
          * @see
-         * - {@link assert.notDeepEquals} : the opposite assertion.
-         * - {@link assert.entriesEqual} : a less expensive (but less thorough) deep equality assertion.
-         * - {@link assert.jsonEquals} : a less expensive (but less thorough) deep equality assertion.
+         * - {@link assert.deepEquals} : the opposite assertion.
+         * - {@link assert.notEntriesEqual} : a less expensive (but less thorough) deep equality assertion.
+         * - {@link assert.notJsonEquals} : a less expensive (but less thorough) deep equality assertion.
          */
-        notDeepEquals: typeof notDeepEquals;
+        notDeepEquals(this: void, actual: unknown, expected: unknown, failureMessage?: string | undefined): void;
     };
     check: {
         /**
@@ -206,7 +200,7 @@ export declare const simpleEqualityGuards: {
          * - {@link check.notStrictEquals} : the opposite check.
          * - {@link check.looseEquals} : the loose equality check.
          */
-        strictEquals: <Actual, Expected extends Actual>(actual: Actual, expected: Expected) => actual is Expected;
+        strictEquals<Actual, Expected extends Actual>(this: void, actual: Actual, expected: Expected): actual is NarrowToExpected<Actual, Expected>;
         /**
          * Checks that two values are _not_ strictly equal (using
          * [`===`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#strict_equality_using)).
@@ -232,7 +226,7 @@ export declare const simpleEqualityGuards: {
          * - {@link check.strictEquals} : the opposite check.
          * - {@link check.notLooseEquals} : the loose equality check.
          */
-        notStrictEquals: typeof autoGuardSymbol;
+        notStrictEquals(this: void, actual: unknown, expected: unknown): boolean;
         /**
          * Checks that two values are loosely equal (using
          * [`==`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#loose_equality_using)).
@@ -258,7 +252,7 @@ export declare const simpleEqualityGuards: {
          * - {@link check.notLooseEquals} : the opposite check.
          * - {@link check.strictEquals} : the strict equality check.
          */
-        looseEquals: typeof autoGuardSymbol;
+        looseEquals(this: void, actual: unknown, expected: unknown): boolean;
         /**
          * Checks that two values are _not_ loosely equal (using
          * [`==`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#loose_equality_using)).
@@ -284,7 +278,7 @@ export declare const simpleEqualityGuards: {
          * - {@link check.looseEquals} : the opposite check.
          * - {@link check.strictEquals} : the strict equality check.
          */
-        notLooseEquals: typeof autoGuardSymbol;
+        notLooseEquals(this: void, actual: unknown, expected: unknown): boolean;
         /**
          * Checks that two values are deeply equal using the
          * [deep-eql](https://www.npmjs.com/package/deep-eql) package.
@@ -314,7 +308,7 @@ export declare const simpleEqualityGuards: {
          * - {@link check.entriesEqual} : a less expensive (but less thorough) deep equality check.
          * - {@link check.jsonEquals} : a less expensive (but less thorough) deep equality check.
          */
-        deepEquals: <Actual, Expected extends Actual>(actual: Actual, expected: Expected) => actual is Expected;
+        deepEquals<Actual, Expected extends Actual>(this: void, actual: Actual, expected: Expected): actual is NarrowToExpected<Actual, Expected>;
         /**
          * Checks that two values are _not_ deeply equal using the
          * [deep-eql](https://www.npmjs.com/package/deep-eql) package.
@@ -344,7 +338,7 @@ export declare const simpleEqualityGuards: {
          * - {@link check.entriesEqual} : a less expensive (but less thorough) deep equality check.
          * - {@link check.jsonEquals} : a less expensive (but less thorough) deep equality check.
          */
-        notDeepEquals: typeof autoGuardSymbol;
+        notDeepEquals(this: void, actual: unknown, expected: unknown): boolean;
     };
     assertWrap: {
         /**
@@ -374,7 +368,7 @@ export declare const simpleEqualityGuards: {
          * - {@link assertWrap.notStrictEquals} : the opposite assertion.
          * - {@link assertWrap.looseEquals} : the loose equality assertion.
          */
-        strictEquals: <Actual, Expected extends Actual>(actual: Actual, expected: Expected, failureMessage?: string | undefined) => NarrowToExpected<Actual, Expected>;
+        strictEquals<Actual, Expected extends Actual>(this: void, actual: Actual, expected: Expected, failureMessage?: string | undefined): NarrowToExpected<Actual, Expected>;
         /**
          * Asserts that two values are _not_ strictly equal (using
          * [`===`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#strict_equality_using)).
@@ -402,7 +396,7 @@ export declare const simpleEqualityGuards: {
          * - {@link assertWrap.strictEquals} : the opposite assertion.
          * - {@link assertWrap.notLooseEquals} : the loose equality assertion.
          */
-        notStrictEquals: typeof autoGuardSymbol;
+        notStrictEquals<Actual>(this: void, actual: Actual, expected: unknown, failureMessage?: string | undefined): Actual;
         /**
          * Asserts that two values are loosely equal (using
          * [`==`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#loose_equality_using)).
@@ -430,7 +424,7 @@ export declare const simpleEqualityGuards: {
          * - {@link assertWrap.notLooseEquals} : the opposite assertion.
          * - {@link assertWrap.strictEquals} : the strict equality assertion.
          */
-        looseEquals: typeof autoGuardSymbol;
+        looseEquals<Actual>(this: void, actual: Actual, expected: unknown, failureMessage?: string | undefined): Actual;
         /**
          * Asserts that two values are _not_ loosely equal (using
          * [`==`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#loose_equality_using)).
@@ -458,7 +452,7 @@ export declare const simpleEqualityGuards: {
          * - {@link assertWrap.looseEquals} : the opposite assertion.
          * - {@link assertWrap.strictEquals} : the strict equality assertion.
          */
-        notLooseEquals: typeof autoGuardSymbol;
+        notLooseEquals<Actual>(this: void, actual: Actual, expected: unknown, failureMessage?: string | undefined): Actual;
         /**
          * Asserts that two values are deeply equal using the
          * [deep-eql](https://www.npmjs.com/package/deep-eql) package. Returns the first value if
@@ -490,7 +484,7 @@ export declare const simpleEqualityGuards: {
          * - {@link assertWrap.entriesEqual} : a less expensive (but less thorough) deep equality assertion.
          * - {@link assertWrap.jsonEquals} : a less expensive (but less thorough) deep equality assertion.
          */
-        deepEquals: <Actual, Expected extends Actual>(actual: Actual, expected: Expected, failureMessage?: string | undefined) => NarrowToExpected<Actual, Expected>;
+        deepEquals<Actual, Expected extends Actual>(this: void, actual: Actual, expected: Expected, failureMessage?: string | undefined): NarrowToExpected<Actual, Expected>;
         /**
          * Asserts that two values are _not_ deeply equal using the
          * [deep-eql](https://www.npmjs.com/package/deep-eql) package. Returns the first value if
@@ -522,7 +516,7 @@ export declare const simpleEqualityGuards: {
          * - {@link assertWrap.entriesEqual} : a less expensive (but less thorough) deep equality assertion.
          * - {@link assertWrap.jsonEquals} : a less expensive (but less thorough) deep equality assertion.
          */
-        notDeepEquals: typeof autoGuardSymbol;
+        notDeepEquals<Actual>(this: void, actual: Actual, expected: unknown, failureMessage?: string | undefined): Actual;
     };
     checkWrap: {
         /**
@@ -552,7 +546,7 @@ export declare const simpleEqualityGuards: {
          * - {@link checkWrap.notStrictEquals} : the opposite check.
          * - {@link checkWrap.looseEquals} : the loose equality check.
          */
-        strictEquals: <Actual, Expected extends Actual>(actual: Actual, expected: Expected) => Expected | undefined;
+        strictEquals<Actual, Expected extends Actual>(this: void, actual: Actual, expected: Expected): NarrowToExpected<Actual, Expected> | undefined;
         /**
          * Checks that two values are _not_ strictly equal (using
          * [`===`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#strict_equality_using)).
@@ -580,7 +574,7 @@ export declare const simpleEqualityGuards: {
          * - {@link checkWrap.strictEquals} : the opposite check.
          * - {@link checkWrap.notLooseEquals} : the loose equality check.
          */
-        notStrictEquals: typeof autoGuardSymbol;
+        notStrictEquals<Actual>(this: void, actual: Actual, expected: unknown): Actual | undefined;
         /**
          * Checks that two values are loosely equal (using
          * [`==`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#loose_equality_using)).
@@ -608,7 +602,7 @@ export declare const simpleEqualityGuards: {
          * - {@link checkWrap.notLooseEquals} : the opposite check.
          * - {@link checkWrap.strictEquals} : the strict equality check.
          */
-        looseEquals: typeof autoGuardSymbol;
+        looseEquals<Actual>(this: void, actual: Actual, expected: unknown): Actual | undefined;
         /**
          * Checks that two values are _not_ loosely equal (using
          * [`==`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#loose_equality_using)).
@@ -636,7 +630,7 @@ export declare const simpleEqualityGuards: {
          * - {@link checkWrap.looseEquals} : the opposite check.
          * - {@link checkWrap.strictEquals} : the strict equality check.
          */
-        notLooseEquals: typeof autoGuardSymbol;
+        notLooseEquals<Actual>(this: void, actual: Actual, expected: unknown): Actual | undefined;
         /**
          * Checks that two values are deeply equal using the
          * [deep-eql](https://www.npmjs.com/package/deep-eql) package. Returns the first value if
@@ -668,7 +662,7 @@ export declare const simpleEqualityGuards: {
          * - {@link checkWrap.entriesEqual} : a less expensive (but less thorough) deep equality check.
          * - {@link checkWrap.jsonEquals} : a less expensive (but less thorough) deep equality check.
          */
-        deepEquals: <Actual, Expected extends Actual>(actual: Actual, expected: Expected) => NarrowToExpected<Actual, Expected> | undefined;
+        deepEquals<Actual, Expected extends Actual>(this: void, actual: Actual, expected: Expected): NarrowToExpected<Actual, Expected> | undefined;
         /**
          * Checks that two values are _not_ deeply equal using the
          * [deep-eql](https://www.npmjs.com/package/deep-eql) package. Returns the first value if
@@ -700,7 +694,7 @@ export declare const simpleEqualityGuards: {
          * - {@link checkWrap.entriesEqual} : a less expensive (but less thorough) deep equality check.
          * - {@link checkWrap.jsonEquals} : a less expensive (but less thorough) deep equality check.
          */
-        notDeepEquals: typeof autoGuardSymbol;
+        notDeepEquals<Actual>(this: void, actual: Actual, expected: unknown): Actual | undefined;
     };
     waitUntil: {
         /**
@@ -734,7 +728,7 @@ export declare const simpleEqualityGuards: {
          * - {@link waitUntil.notStrictEquals} : the opposite assertion.
          * - {@link waitUntil.looseEquals} : the loose equality assertion.
          */
-        strictEquals: <Actual, Expected extends Actual>(expected: Expected, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Actual, Expected>>;
+        strictEquals: <Actual, Expected extends Actual>(this: void, expected: Expected, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Actual, Expected>>;
         /**
          * Repeatedly calls a callback until its output does _not_ strictly equal (using
          * [`===`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#strict_equality_using))
@@ -766,7 +760,7 @@ export declare const simpleEqualityGuards: {
          * - {@link waitUntil.strictEquals} : the opposite assertion.
          * - {@link waitUntil.notLooseEquals} : the loose equality assertion.
          */
-        notStrictEquals: typeof autoGuardSymbol;
+        notStrictEquals: <Actual>(this: void, expected: unknown, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Actual>;
         /**
          * Repeatedly calls a callback until its output loosely equals (using
          * [`==`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#loose_equality_using))
@@ -798,7 +792,7 @@ export declare const simpleEqualityGuards: {
          * - {@link waitUntil.notLooseEquals} : the opposite assertion.
          * - {@link waitUntil.strictEquals} : the strict equality assertion.
          */
-        looseEquals: typeof autoGuardSymbol;
+        looseEquals: <Actual>(this: void, expected: unknown, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Actual>;
         /**
          * Repeatedly calls a callback until its output does _not_ loosely equal (using
          * [`==`](https://developer.mozilla.org/docs/Web/JavaScript/Equality_comparisons_and_sameness#loose_equality_using))
@@ -830,7 +824,7 @@ export declare const simpleEqualityGuards: {
          * - {@link waitUntil.looseEquals} : the opposite assertion.
          * - {@link waitUntil.notStrictEquals} : the strict equality assertion.
          */
-        notLooseEquals: typeof autoGuardSymbol;
+        notLooseEquals: <Actual>(this: void, expected: unknown, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Actual>;
         /**
          * Repeatedly calls a callback until its output deeply equals (using the
          * [deep-eql](https://www.npmjs.com/package/deep-eql) package) the first input. Once the
@@ -865,7 +859,7 @@ export declare const simpleEqualityGuards: {
          * - {@link waitUntil.entriesEqual} : a less expensive (but less thorough) deep equality assertion.
          * - {@link waitUntil.jsonEquals} : a less expensive (but less thorough) deep equality assertion.
          */
-        deepEquals: <Actual, Expected extends Actual>(expected: Expected, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Actual, Expected>>;
+        deepEquals: <Actual, Expected extends Actual>(this: void, expected: Expected, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<NarrowToExpected<Actual, Expected>>;
         /**
          * Repeatedly calls a callback until its output does _not_ deeply equal (using the
          * [deep-eql](https://www.npmjs.com/package/deep-eql) package) the first input. Once the
@@ -900,7 +894,6 @@ export declare const simpleEqualityGuards: {
          * - {@link waitUntil.entriesEqual} : a less expensive (but less thorough) deep equality assertion.
          * - {@link waitUntil.jsonEquals} : a less expensive (but less thorough) deep equality assertion.
          */
-        notDeepEquals: typeof autoGuardSymbol;
+        notDeepEquals: <Actual>(this: void, expected: unknown, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Actual>;
     };
 };
-export {};