@augment-vir/assert 31.0.0 → 31.0.1

package/dist/assertions/boolean.d.ts

@@ -1,5 +1,4 @@
 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';
 /**
  * All falsy values in JavaScript. This does not include `NaN` because there is no dedicated type
@@ -52,10 +51,6 @@ export type Falsy<T> = NarrowToExpected<T, FalsyValue>;
  * @package [`@augment-vir/assert`](https://www.npmjs.com/package/@augment-vir/assert)
  */
 export type Truthy<T> = Exclude<T, FalsyValue>;
-declare function isFalsy(input: unknown, failureMessage?: string | undefined): asserts input is FalsyValue;
-declare function isTruthy<const Actual>(input: Actual, failureMessage?: string | undefined): asserts input is Truthy<Actual>;
-declare function isTrue(input: unknown, failureMessage?: string | undefined): asserts input is true;
-declare function isFalse(input: unknown, failureMessage?: string | undefined): asserts input is false;
 export declare const booleanGuards: {
     assert: {
         /**
@@ -79,7 +74,7 @@ export declare const booleanGuards: {
          * - {@link assert.isTrue} : the opposite assertion.
          * - {@link assert.isFalsy} : a less exact assertion.
          */
-        isFalse: typeof isFalse;
+        isFalse(this: void, input: unknown, failureMessage?: string | undefined): asserts input is false;
         /**
          * Asserts that a value is falsy.
          *
@@ -101,7 +96,7 @@ export declare const booleanGuards: {
          * - {@link assert.isTruthy} : the opposite assertion.
          * - {@link assert.isFalse} : a more exact assertion.
          */
-        isFalsy: typeof isFalsy;
+        isFalsy(this: void, input: unknown, failureMessage?: string | undefined): asserts input is FalsyValue;
         /**
          * Asserts that a value is exactly `true`.
          *
@@ -123,7 +118,7 @@ export declare const booleanGuards: {
          * - {@link assert.isFalse} : the opposite assertion.
          * - {@link assert.isTruthy} : a less exact assertion.
          */
-        isTrue: typeof isTrue;
+        isTrue(this: void, input: unknown, failureMessage?: string | undefined): asserts input is true;
         /**
          * Asserts that a value is truthy.
          *
@@ -145,7 +140,7 @@ export declare const booleanGuards: {
          * - {@link assert.isFalsy} : the opposite assertion.
          * - {@link assert.isTrue} : a more exact assertion.
          */
-        isTruthy: typeof isTruthy;
+        isTruthy<const Actual>(this: void, input: Actual, failureMessage?: string | undefined): asserts input is Truthy<Actual>;
     };
     check: {
         /**
@@ -168,7 +163,7 @@ export declare const booleanGuards: {
          * - {@link check.isTrue} : the opposite check.
          * - {@link check.isFalsy} : a less exact check.
          */
-        isFalse: typeof autoGuardSymbol;
+        isFalse(this: void, input: unknown): input is false;
         /**
          * Checks that a value is falsy.
          *
@@ -189,7 +184,7 @@ export declare const booleanGuards: {
          * - {@link check.isTruthy} : the opposite check.
          * - {@link check.isFalse} : a more exact check.
          */
-        isFalsy: typeof autoGuardSymbol;
+        isFalsy(this: void, input: unknown): input is FalsyValue;
         /**
          * Checks that a value is exactly `true`.
          *
@@ -210,7 +205,7 @@ export declare const booleanGuards: {
          * - {@link check.isFalse} : the opposite check.
          * - {@link check.isTruthy} : a less exact check.
          */
-        isTrue: typeof autoGuardSymbol;
+        isTrue(this: void, input: unknown): input is true;
         /**
          * Checks that a value is truthy.
          *
@@ -231,7 +226,7 @@ export declare const booleanGuards: {
          * - {@link check.isFalsy} : the opposite check.
          * - {@link check.isTrue} : a more exact check.
          */
-        isTruthy: <T>(input: T) => input is Truthy<T>;
+        isTruthy<T>(this: void, input: T): input is Truthy<T>;
     };
     assertWrap: {
         /**
@@ -256,7 +251,7 @@ export declare const booleanGuards: {
          * - {@link assertWrap.isTrue} : the opposite assertion.
          * - {@link assertWrap.isFalsy} : a less exact assertion.
          */
-        isFalse: typeof autoGuardSymbol;
+        isFalse(this: void, input: unknown, failureMessage?: undefined | string): false;
         /**
          * Asserts that a value is falsy. Returns the value if the assertion passes.
          *
@@ -279,7 +274,7 @@ export declare const booleanGuards: {
          * - {@link assertWrap.isTruthy} : the opposite assertion.
          * - {@link assertWrap.isFalse} : a more exact assertion.
          */
-        isFalsy: <T>(input: T, failureMessage?: string | undefined) => Falsy<T>;
+        isFalsy<T>(this: void, input: T, failureMessage?: undefined | string): Falsy<T>;
         /**
          * Asserts that a value is exactly `true`. Returns the value if the assertion passes.
          *
@@ -302,7 +297,7 @@ export declare const booleanGuards: {
          * - {@link assertWrap.isFalse} : the opposite assertion.
          * - {@link assertWrap.isTruthy} : a less exact assertion.
          */
-        isTrue: typeof autoGuardSymbol;
+        isTrue(this: void, input: unknown, failureMessage?: undefined | string): true;
         /**
          * Asserts that a value is truthy. Returns the value if the assertion passes.
          *
@@ -325,7 +320,7 @@ export declare const booleanGuards: {
          * - {@link assertWrap.isFalsy} : the opposite assertion.
          * - {@link assertWrap.isTrue} : a more exact assertion.
          */
-        isTruthy: <T>(input: T, failureMessage?: string | undefined) => Truthy<T>;
+        isTruthy<T>(this: void, input: T, failureMessage?: undefined | string): Truthy<T>;
     };
     checkWrap: {
         /**
@@ -350,7 +345,7 @@ export declare const booleanGuards: {
          * - {@link checkWrap.isTrue} : the opposite check.
          * - {@link checkWrap.isFalsy} : a less exact check.
          */
-        isFalse: typeof autoGuardSymbol;
+        isFalse(this: void, input: unknown): false | undefined;
         /**
          * Checks that a value is falsy. Returns the value if the check passes, otherwise
          * `undefined`.
@@ -373,7 +368,7 @@ export declare const booleanGuards: {
          * - {@link checkWrap.isTruthy} : the opposite check.
          * - {@link checkWrap.isFalse} : a more exact check.
          */
-        isFalsy: <T>(input: T) => Falsy<T> | undefined;
+        isFalsy<T>(this: void, input: T): Falsy<T> | undefined;
         /**
          * Checks that a value is exactly `true`. Returns the value if the check passes, otherwise
          * `undefined`.
@@ -396,7 +391,7 @@ export declare const booleanGuards: {
          * - {@link checkWrap.isFalse} : the opposite check.
          * - {@link checkWrap.isTruthy} : a less exact check.
          */
-        isTrue: typeof autoGuardSymbol;
+        isTrue(this: void, input: unknown): true | undefined;
         /**
          * Checks that a value is truthy. Returns the value if the check passes, otherwise
          * `undefined`.
@@ -419,7 +414,7 @@ export declare const booleanGuards: {
          * - {@link checkWrap.isFalsy} : the opposite check.
          * - {@link checkWrap.isTrue} : a more exact check.
          */
-        isTruthy: <T>(input: T) => Truthy<T> | undefined;
+        isTruthy<T>(this: void, input: T): Truthy<T> | undefined;
     };
     waitUntil: {
         /**
@@ -445,7 +440,7 @@ export declare const booleanGuards: {
          * - {@link waitUntil.isTrue} : the opposite assertion.
          * - {@link waitUntil.isFalsy} : a less exact assertion.
          */
-        isFalse: typeof autoGuardSymbol;
+        isFalse: (this: void, callback: () => MaybePromise<unknown>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<false>;
         /**
          * Repeatedly calls a callback until its output is falsy. Once the callback output passes,
          * it is returned. If the attempts time out, an error is thrown.
@@ -469,7 +464,7 @@ export declare const booleanGuards: {
          * - {@link waitUntil.isTruthy} : the opposite assertion.
          * - {@link waitUntil.isFalse} : a more exact assertion.
          */
-        isFalsy: <Actual>(callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Falsy<Actual>>;
+        isFalsy: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Falsy<Actual>>;
         /**
          * Repeatedly calls a callback until its output is exactly `true`. Once the callback output
          * passes, it is returned. If the attempts time out, an error is thrown.
@@ -493,7 +488,7 @@ export declare const booleanGuards: {
          * - {@link waitUntil.isFalse} : the opposite assertion.
          * - {@link waitUntil.isTruthy} : a less exact assertion.
          */
-        isTrue: typeof autoGuardSymbol;
+        isTrue: (this: void, callback: () => MaybePromise<unknown>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<true>;
         /**
          * Repeatedly calls a callback until its output is truthy. Once the callback output passes,
          * it is returned. If the attempts time out, an error is thrown.
@@ -517,7 +512,6 @@ export declare const booleanGuards: {
          * - {@link waitUntil.isFalsy} : the opposite assertion.
          * - {@link waitUntil.isTrue} : a more exact assertion.
          */
-        isTruthy: <Actual>(callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Truthy<Actual>>;
+        isTruthy: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Truthy<Actual>>;
     };
 };
-export {};

package/dist/assertions/boolean.js

@@ -1,31 +1,111 @@
 import { stringify } from '@augment-vir/core';
 import { AssertionError } from '../augments/assertion.error.js';
-import { autoGuard, autoGuardSymbol } from '../guard-types/guard-override.js';
-function isFalsy(input, failureMessage) {
-    if (input) {
-        throw new AssertionError(`'${stringify(input)}' is not truthy.`, failureMessage);
-    }
-}
-function isTruthy(input, failureMessage) {
-    if (!input) {
-        throw new AssertionError(`'${stringify(input)}' is not truthy.`, failureMessage);
-    }
-}
-function isTrue(input, failureMessage) {
-    if (input !== true) {
-        throw new AssertionError(`'${stringify(input)}' is not true.`, failureMessage);
-    }
-}
-function isFalse(input, failureMessage) {
-    if (input !== false) {
-        throw new AssertionError(`'${stringify(input)}' is not false.`, failureMessage);
-    }
-}
+import { createWaitUntil } from '../guard-types/wait-until-function.js';
 const assertions = {
-    isFalse,
-    isFalsy,
-    isTrue,
-    isTruthy,
+    /**
+     * Asserts that a value is exactly `false`.
+     *
+     * Type guards the value.
+     *
+     * @example
+     *
+     * ```ts
+     * import {assert} from '@augment-vir/assert';
+     *
+     * assert.isFalse(true); // fails
+     * assert.isFalse(false); // passes
+     * assert.isFalse(1); // fails
+     * assert.isFalse(0); // fails
+     * ```
+     *
+     * @throws {@link AssertionError} If the value is not `false`.
+     * @see
+     * - {@link assert.isTrue} : the opposite assertion.
+     * - {@link assert.isFalsy} : a less exact assertion.
+     */
+    isFalse(input, failureMessage) {
+        if (input !== false) {
+            throw new AssertionError(`'${stringify(input)}' is not false.`, failureMessage);
+        }
+    },
+    /**
+     * Asserts that a value is falsy.
+     *
+     * Type guards the value when possible.
+     *
+     * @example
+     *
+     * ```ts
+     * import {assert} from '@augment-vir/assert';
+     *
+     * assert.isFalsy(true); // fails
+     * assert.isFalsy(false); // passes
+     * assert.isFalsy(1); // fails
+     * assert.isFalsy(0); // passes
+     * ```
+     *
+     * @throws {@link AssertionError} If the value is not falsy.
+     * @see
+     * - {@link assert.isTruthy} : the opposite assertion.
+     * - {@link assert.isFalse} : a more exact assertion.
+     */
+    isFalsy(input, failureMessage) {
+        if (input) {
+            throw new AssertionError(`'${stringify(input)}' is not falsy.`, failureMessage);
+        }
+    },
+    /**
+     * Asserts that a value is exactly `true`.
+     *
+     * Type guards the value.
+     *
+     * @example
+     *
+     * ```ts
+     * import {assert} from '@augment-vir/assert';
+     *
+     * assert.isTrue(true); // passes
+     * assert.isTrue(false); // fails
+     * assert.isTrue(1); // fails
+     * assert.isTrue(0); // fails
+     * ```
+     *
+     * @throws {@link AssertionError} If the value is not `true`.
+     * @see
+     * - {@link assert.isFalse} : the opposite assertion.
+     * - {@link assert.isTruthy} : a less exact assertion.
+     */
+    isTrue(input, failureMessage) {
+        if (input !== true) {
+            throw new AssertionError(`'${stringify(input)}' is not true.`, failureMessage);
+        }
+    },
+    /**
+     * Asserts that a value is truthy.
+     *
+     * Type guards the value.
+     *
+     * @example
+     *
+     * ```ts
+     * import {assert} from '@augment-vir/assert';
+     *
+     * assert.isTruthy(true); // passes
+     * assert.isTruthy(false); // fails
+     * assert.isTruthy(1); // passes
+     * assert.isTruthy(0); // fails
+     * ```
+     *
+     * @throws {@link AssertionError} If the value is not truthy.
+     * @see
+     * - {@link assert.isFalsy} : the opposite assertion.
+     * - {@link assert.isTrue} : a more exact assertion.
+     */
+    isTruthy(input, failureMessage) {
+        if (!input) {
+            throw new AssertionError(`'${stringify(input)}' is not truthy.`, failureMessage);
+        }
+    },
 };
 export const booleanGuards = {
     assert: assertions,
@@ -50,7 +130,9 @@ export const booleanGuards = {
          * - {@link check.isTrue} : the opposite check.
          * - {@link check.isFalsy} : a less exact check.
          */
-        isFalse: autoGuardSymbol,
+        isFalse(input) {
+            return input === false;
+        },
         /**
          * Checks that a value is falsy.
          *
@@ -71,7 +153,9 @@ export const booleanGuards = {
          * - {@link check.isTruthy} : the opposite check.
          * - {@link check.isFalse} : a more exact check.
          */
-        isFalsy: autoGuardSymbol,
+        isFalsy(input) {
+            return !input;
+        },
         /**
          * Checks that a value is exactly `true`.
          *
@@ -92,7 +176,9 @@ export const booleanGuards = {
          * - {@link check.isFalse} : the opposite check.
          * - {@link check.isTruthy} : a less exact check.
          */
-        isTrue: autoGuardSymbol,
+        isTrue(input) {
+            return input === true;
+        },
         /**
          * Checks that a value is truthy.
          *
@@ -113,7 +199,9 @@ export const booleanGuards = {
          * - {@link check.isFalsy} : the opposite check.
          * - {@link check.isTrue} : a more exact check.
          */
-        isTruthy: autoGuard(),
+        isTruthy(input) {
+            return !!input;
+        },
     },
     assertWrap: {
         /**
@@ -138,7 +226,14 @@ export const booleanGuards = {
          * - {@link assertWrap.isTrue} : the opposite assertion.
          * - {@link assertWrap.isFalsy} : a less exact assertion.
          */
-        isFalse: autoGuardSymbol,
+        isFalse(input, failureMessage) {
+            if (input === false) {
+                return input;
+            }
+            else {
+                throw new AssertionError(`'${stringify(input)}' is not false.`, failureMessage);
+            }
+        },
         /**
          * Asserts that a value is falsy. Returns the value if the assertion passes.
          *
@@ -161,7 +256,14 @@ export const booleanGuards = {
          * - {@link assertWrap.isTruthy} : the opposite assertion.
          * - {@link assertWrap.isFalse} : a more exact assertion.
          */
-        isFalsy: autoGuard(),
+        isFalsy(input, failureMessage) {
+            if (input) {
+                throw new AssertionError(`'${stringify(input)}' is not falsy.`, failureMessage);
+            }
+            else {
+                return input;
+            }
+        },
         /**
          * Asserts that a value is exactly `true`. Returns the value if the assertion passes.
          *
@@ -184,7 +286,14 @@ export const booleanGuards = {
          * - {@link assertWrap.isFalse} : the opposite assertion.
          * - {@link assertWrap.isTruthy} : a less exact assertion.
          */
-        isTrue: autoGuardSymbol,
+        isTrue(input, failureMessage) {
+            if (input === true) {
+                return input;
+            }
+            else {
+                throw new AssertionError(`'${stringify(input)}' is not true.`, failureMessage);
+            }
+        },
         /**
          * Asserts that a value is truthy. Returns the value if the assertion passes.
          *
@@ -207,7 +316,14 @@ export const booleanGuards = {
          * - {@link assertWrap.isFalsy} : the opposite assertion.
          * - {@link assertWrap.isTrue} : a more exact assertion.
          */
-        isTruthy: autoGuard(),
+        isTruthy(input, failureMessage) {
+            if (input) {
+                return input;
+            }
+            else {
+                throw new AssertionError(`'${stringify(input)}' is not truthy.`, failureMessage);
+            }
+        },
     },
     checkWrap: {
         /**
@@ -232,7 +348,14 @@ export const booleanGuards = {
          * - {@link checkWrap.isTrue} : the opposite check.
          * - {@link checkWrap.isFalsy} : a less exact check.
          */
-        isFalse: autoGuardSymbol,
+        isFalse(input) {
+            if (input === false) {
+                return input;
+            }
+            else {
+                return undefined;
+            }
+        },
         /**
          * Checks that a value is falsy. Returns the value if the check passes, otherwise
          * `undefined`.
@@ -255,7 +378,14 @@ export const booleanGuards = {
          * - {@link checkWrap.isTruthy} : the opposite check.
          * - {@link checkWrap.isFalse} : a more exact check.
          */
-        isFalsy: autoGuard(),
+        isFalsy(input) {
+            if (input) {
+                return undefined;
+            }
+            else {
+                return input;
+            }
+        },
         /**
          * Checks that a value is exactly `true`. Returns the value if the check passes, otherwise
          * `undefined`.
@@ -278,7 +408,14 @@ export const booleanGuards = {
          * - {@link checkWrap.isFalse} : the opposite check.
          * - {@link checkWrap.isTruthy} : a less exact check.
          */
-        isTrue: autoGuardSymbol,
+        isTrue(input) {
+            if (input === true) {
+                return input;
+            }
+            else {
+                return undefined;
+            }
+        },
         /**
          * Checks that a value is truthy. Returns the value if the check passes, otherwise
          * `undefined`.
@@ -301,7 +438,14 @@ export const booleanGuards = {
          * - {@link checkWrap.isFalsy} : the opposite check.
          * - {@link checkWrap.isTrue} : a more exact check.
          */
-        isTruthy: autoGuard(),
+        isTruthy(input) {
+            if (input) {
+                return input;
+            }
+            else {
+                return undefined;
+            }
+        },
     },
     waitUntil: {
         /**
@@ -327,7 +471,7 @@ export const booleanGuards = {
          * - {@link waitUntil.isTrue} : the opposite assertion.
          * - {@link waitUntil.isFalsy} : a less exact assertion.
          */
-        isFalse: autoGuardSymbol,
+        isFalse: createWaitUntil(assertions.isFalse),
         /**
          * Repeatedly calls a callback until its output is falsy. Once the callback output passes,
          * it is returned. If the attempts time out, an error is thrown.
@@ -351,7 +495,7 @@ export const booleanGuards = {
          * - {@link waitUntil.isTruthy} : the opposite assertion.
          * - {@link waitUntil.isFalse} : a more exact assertion.
          */
-        isFalsy: autoGuard(),
+        isFalsy: createWaitUntil(assertions.isFalsy),
         /**
          * Repeatedly calls a callback until its output is exactly `true`. Once the callback output
          * passes, it is returned. If the attempts time out, an error is thrown.
@@ -375,7 +519,7 @@ export const booleanGuards = {
          * - {@link waitUntil.isFalse} : the opposite assertion.
          * - {@link waitUntil.isTruthy} : a less exact assertion.
          */
-        isTrue: autoGuardSymbol,
+        isTrue: createWaitUntil(assertions.isTrue),
         /**
          * Repeatedly calls a callback until its output is truthy. Once the callback output passes,
          * it is returned. If the attempts time out, an error is thrown.
@@ -399,6 +543,6 @@ export const booleanGuards = {
          * - {@link waitUntil.isFalsy} : the opposite assertion.
          * - {@link waitUntil.isTrue} : a more exact assertion.
          */
-        isTruthy: autoGuard(),
+        isTruthy: createWaitUntil(assertions.isTruthy),
     },
 };