@augment-vir/assert 30.8.4 → 31.0.1

package/dist/assertions/output.d.ts

@@ -2,9 +2,8 @@ import { type AnyFunction } from '@augment-vir/core';
 import type { IsAny } from 'type-fest';
 import { type WaitUntilOptions } from '../guard-types/wait-until-function.js';
 /**
- * A customer asserter for `.output` guards (`assert.output`, `check.output`, etc.). This is
- * typically not necessary, as the `.output` guards already perform deep equality checks by
- * default.
+ * A custom asserter for `.output` guards (`assert.output`, `check.output`, etc.). This is typically
+ * not necessary, as the `.output` guards already perform deep equality checks by default.
  *
  * @category Assert : Util
  * @category Package : @augment-vir/assert

package/dist/assertions/output.js

@@ -23,13 +23,7 @@ function extractOutputArgs(functionToCallOrAsserter, inputsOrFunctionToCall, exp
     const failureMessage = usingCustomAsserter
         ? emptyOrFailureMessage
         : failureMessageOrExpectedOutput;
-    return [
-        asserter,
-        functionToCall,
-        inputs,
-        expectedOutput,
-        failureMessage,
-    ];
+    return [asserter, functionToCall, inputs, expectedOutput, failureMessage];
 }
 function innerAssertOutput(asserter, functionToCall, inputs, expectedOutput, failureMessage, shouldReturnResult) {
     const result = functionToCall(...inputs);

package/dist/assertions/primitive.d.ts

@@ -1,14 +1,7 @@
 import { type MaybePromise } from '@augment-vir/core';
 import { type Primitive } from 'type-fest';
-import { autoGuardSymbol } from '../guard-types/guard-override.js';
 import { type WaitUntilOptions } from '../guard-types/wait-until-function.js';
-export type { Primitive } from 'type-fest';
-/** Asserts that the given value is a primitive. */
-declare function isPrimitive(input: unknown, failureMessage?: string | undefined): asserts input is Primitive;
-declare function isNotPrimitive<const Actual>(input: Actual, failureMessage?: string | undefined): asserts input is Exclude<Actual, Primitive>;
-/** Asserts that the given value is a PropertyKey ( string | number | symbol). */
-declare function isPropertyKey(input: unknown, failureMessage?: string | undefined): asserts input is PropertyKey;
-declare function isNotPropertyKey<const Actual>(input: Actual, failureMessage?: string | undefined): asserts input is Exclude<Actual, PropertyKey>;
+export { type Primitive } from 'type-fest';
 export declare const primitiveGuards: {
     assert: {
         /**
@@ -31,7 +24,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link assert.isNotPropertyKey} : the opposite assertion.
          */
-        isPropertyKey: typeof isPropertyKey;
+        isPropertyKey(this: void, actual: unknown, failureMessage?: string | undefined): asserts actual is PropertyKey;
         /**
          * Asserts that a value is _not_ a valid `PropertyKey`. `PropertyKey` is a built-in TypeScript
          * type which refers to all possible key types for a JavaScript object.
@@ -52,7 +45,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link assert.isPropertyKey} : the opposite assertion.
          */
-        isNotPropertyKey: typeof isNotPropertyKey;
+        isNotPropertyKey<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, PropertyKey>;
         /**
          * Asserts that a value is a JavaScript
          * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive).
@@ -73,7 +66,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link assert.isNotPrimitive} : the opposite assertion.
          */
-        isPrimitive: typeof isPrimitive;
+        isPrimitive(this: void, actual: unknown, failureMessage?: string | undefined): asserts actual is Primitive;
         /**
          * Asserts that a value is _not_ a JavaScript
          * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive).
@@ -94,7 +87,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link assert.isPrimitive} : the opposite assertion.
          */
-        isNotPrimitive: typeof isNotPrimitive;
+        isNotPrimitive<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): asserts actual is Exclude<Actual, Primitive>;
     };
     check: {
         /**
@@ -108,15 +101,15 @@ export declare const primitiveGuards: {
          * ```ts
          * import {check} from '@augment-vir/assert';
          *
-         * check.isPropertyKey('key'); // returns `true`
-         * check.isPropertyKey(true); // returns `false`
-         * check.isPropertyKey({}); // returns `false`
+         * check.isNotPrimitive('key'); // returns `false`
+         * check.isNotPrimitive(true); // returns `false`
+         * check.isNotPrimitive({}); // returns `true`
          * ```
          *
          * @see
-         * - {@link check.isNotPropertyKey} : the opposite check.
+         * - {@link check.isPrimitive} : the opposite check.
          */
-        isNotPrimitive: <const Actual>(input: Actual) => input is Exclude<Actual, Primitive>;
+        isNotPrimitive<Actual>(this: void, actual: Actual): actual is Exclude<Actual, Primitive>;
         /**
          * Checks that a value is _not_ a valid `PropertyKey`. `PropertyKey` is a built-in
          * TypeScript type which refers to all possible key types for a JavaScript object.
@@ -136,7 +129,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link check.isPropertyKey} : the opposite check.
          */
-        isNotPropertyKey: <const Actual>(input: Actual) => input is Exclude<Actual, PropertyKey>;
+        isNotPropertyKey<Actual>(this: void, actual: Actual): actual is Exclude<Actual, PropertyKey>;
         /**
          * Checks that a value is a JavaScript
          * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive).
@@ -156,7 +149,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link check.isNotPrimitive} : the opposite check.
          */
-        isPrimitive: typeof autoGuardSymbol;
+        isPrimitive(this: void, actual: unknown): actual is Primitive;
         /**
          * Checks that a value is _not_ a JavaScript
          * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive).
@@ -168,15 +161,15 @@ export declare const primitiveGuards: {
          * ```ts
          * import {check} from '@augment-vir/assert';
          *
-         * check.isPrimitive('key'); // returns `false`
-         * check.isPrimitive(true); // returns `false`
-         * check.isPrimitive({}); // returns `true`
+         * check.isPropertyKey('key'); // returns `true`
+         * check.isPropertyKey(true); // returns `false`
+         * check.isPropertyKey({}); // returns `false`
          * ```
          *
          * @see
-         * - {@link check.isPrimitive} : the opposite check.
+         * - {@link check.isNotPropertyKey} : the opposite check.
          */
-        isPropertyKey: typeof autoGuardSymbol;
+        isPropertyKey<Actual>(this: void, actual: Actual): actual is Extract<PropertyKey, Actual>;
     };
     assertWrap: {
         /**
@@ -201,7 +194,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link assertWrap.isNotPropertyKey} : the opposite assertion.
          */
-        isNotPrimitive: <const Actual>(input: Actual, failureMessage?: string | undefined) => Exclude<Actual, Primitive>;
+        isNotPrimitive<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Exclude<Actual, Primitive>;
         /**
          * Asserts that a value is _not_ a valid `PropertyKey`. `PropertyKey` is a built-in
          * TypeScript type which refers to all possible key types for a JavaScript object. Returns
@@ -224,7 +217,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link assertWrap.isPropertyKey} : the opposite assertion.
          */
-        isNotPropertyKey: <const Actual>(input: Actual, failureMessage?: string | undefined) => Exclude<Actual, PropertyKey>;
+        isNotPropertyKey<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Exclude<Actual, PropertyKey>;
         /**
          * Asserts that a value is a JavaScript
          * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive). Returns the value if
@@ -247,7 +240,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link assertWrap.isNotPrimitive} : the opposite assertion.
          */
-        isPrimitive: typeof autoGuardSymbol;
+        isPrimitive<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Extract<Actual, Primitive>;
         /**
          * Asserts that a value is _not_ a JavaScript
          * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive). Returns the value if
@@ -270,7 +263,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link assertWrap.isPrimitive} : the opposite assertion.
          */
-        isPropertyKey: typeof autoGuardSymbol;
+        isPropertyKey<Actual>(this: void, actual: Actual, failureMessage?: string | undefined): Extract<Actual, PropertyKey>;
     };
     checkWrap: {
         /**
@@ -285,16 +278,16 @@ export declare const primitiveGuards: {
          * ```ts
          * import {checkWrap} from '@augment-vir/assert';
          *
-         * checkWrap.isPropertyKey('key'); // returns `'key'`
-         * checkWrap.isPropertyKey(true); // returns `undefined`
-         * checkWrap.isPropertyKey({}); // returns `undefined`
+         * checkWrap.isNotPrimitive('key'); // returns `undefined`
+         * checkWrap.isNotPrimitive(true); // returns `undefined`
+         * checkWrap.isNotPrimitive({}); // returns `{}`
          * ```
          *
          * @returns The value if the check passes, otherwise `undefined`.
          * @see
-         * - {@link checkWrap.isNotPropertyKey} : the opposite check.
+         * - {@link checkWrap.isPrimitive} : the opposite check.
          */
-        isNotPrimitive: <const Actual>(input: Actual) => Exclude<Actual, Primitive> | undefined;
+        isNotPrimitive<Actual>(this: void, actual: Actual): Exclude<Actual, Primitive> | undefined;
         /**
          * Checks that a value is _not_ a valid `PropertyKey`. `PropertyKey` is a built-in
          * TypeScript type which refers to all possible key types for a JavaScript object. Returns
@@ -316,7 +309,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link checkWrap.isPropertyKey} : the opposite check.
          */
-        isNotPropertyKey: <const Actual>(input: Actual) => Exclude<Actual, PropertyKey> | undefined;
+        isNotPropertyKey<Actual>(this: void, actual: Actual): Exclude<Actual, PropertyKey> | undefined;
         /**
          * Checks that a value is a JavaScript
          * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive). Returns the value if
@@ -338,7 +331,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link checkWrap.isNotPrimitive} : the opposite check.
          */
-        isPrimitive: typeof autoGuardSymbol;
+        isPrimitive<Actual>(this: void, actual: Actual): Extract<Actual, Primitive> | undefined;
         /**
          * Checks that a value is _not_ a JavaScript
          * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive). Returns the value if
@@ -360,7 +353,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link checkWrap.isPrimitive} : the opposite check.
          */
-        isPropertyKey: typeof autoGuardSymbol;
+        isPropertyKey<Actual>(this: void, actual: Actual): Extract<PropertyKey, Actual> | undefined;
     };
     waitUntil: {
         /**
@@ -386,7 +379,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link waitUntil.isNotPropertyKey} : the opposite assertion.
          */
-        isNotPrimitive: <const Actual>(callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, Primitive>>;
+        isNotPrimitive: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, Primitive>>;
         /**
          * Repeatedly calls a callback until its output is _not_ a valid `PropertyKey`.
          * `PropertyKey` is a built-in TypeScript type which refers to all possible key types for a
@@ -410,7 +403,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link waitUntil.isPropertyKey} : the opposite assertion.
          */
-        isNotPropertyKey: <const Actual>(callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, PropertyKey>>;
+        isNotPropertyKey: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, PropertyKey>>;
         /**
          * Repeatedly calls a callback until its output is a JavaScript
          * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive). Once the callback
@@ -433,7 +426,7 @@ export declare const primitiveGuards: {
          * @see
          * - {@link waitUntil.isNotPrimitive} : the opposite assertion.
          */
-        isPrimitive: typeof autoGuardSymbol;
+        isPrimitive: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Extract<Actual, Primitive>>;
         /**
          * Repeatedly calls a callback until its output is _not_ a JavaScript
          * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive). Once the callback
@@ -456,6 +449,6 @@ export declare const primitiveGuards: {
          * @see
          * - {@link waitUntil.isPrimitive} : the opposite assertion.
          */
-        isPropertyKey: typeof autoGuardSymbol;
+        isPropertyKey: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Extract<Actual, PropertyKey>>;
     };
 };