@augment-vir/assert 30.0.0 → 30.0.1

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

@@ -19,7 +19,7 @@ input: Actual): AssertTypeOf<Actual>;
 /** Uses the expect-type package to assert type matching. */
 declare function tsType<Actual>(): AssertTypeOf<Actual>;
 export declare const tsTypeGuards: {
-    assertions: {
+    assert: {
         /**
          * Check if a value or type matches type expectations. Use this to write type tests.
          *
@@ -36,7 +36,43 @@ export declare const tsTypeGuards: {
          * assert.tsType('hello').equals<string>();
          * ```
          */
+        /**
+         * Asserts within the TypeScript type system that a given type or value matches type
+         * expectations (using the [`expect-type`](https://www.npmjs.com/package/expect-type) package.
+         * Make sure to call a method on the first call to actually assert anything.
+         *
+         * Use this to write type tests. Don't use this in production code. It won't cause issues, but
+         * it's a useless no-op at run-time (it's not even a type guard).
+         *
+         * Performs no type guarding.
+         *
+         * @example
+         *
+         * ```ts
+         * import {assert} from '@augment-vir/assert';
+         *
+         * assert.tsType('hello').equals<string>();
+         * assert.tsType<'hello>().equals<'hello'>();
+         * assert.tsType<'hello>().notEquals<string>();
+         * assert.tsType('hello').notEquals<number>();
+         * ```
+         *
+         * @returns Never returns anything.
+         * @throws Never throws anything.
+         */
         tsType: typeof tsType;
     };
+    assertWrap: {
+        tsType: undefined;
+    };
+    check: {
+        tsType: undefined;
+    };
+    checkWrap: {
+        tsType: undefined;
+    };
+    waitUntil: {
+        tsType: undefined;
+    };
 };
 export {};

package/dist/assertions/equality/ts-type-equality.js

@@ -14,5 +14,17 @@ const assertions = {
     tsType,
 };
 export const tsTypeGuards = {
-    assertions,
+    assert: assertions,
+    assertWrap: {
+        tsType: undefined,
+    },
+    check: {
+        tsType: undefined,
+    },
+    checkWrap: {
+        tsType: undefined,
+    },
+    waitUntil: {
+        tsType: undefined,
+    },
 };