@augment-vir/assert 30.0.4 → 30.1.0

package/dist/guard-types/wait-until-function.d.ts

@@ -1,6 +1,6 @@
 import type { AnyFunction, MaybePromise, NarrowToExpected, PartialWithUndefined, RemoveFirstTupleEntry, RemoveLastTupleEntry, RequiredAndNotNull } from '@augment-vir/core';
-import { ExtractKeysWithMatchingValues, Overwrite } from '@augment-vir/core';
-import { AnyDuration } from '@date-vir/duration';
+import { type ExtractKeysWithMatchingValues, type Overwrite } from '@augment-vir/core';
+import { type AnyDuration } from '@date-vir/duration';
 import type { AssertFunction } from './assert-function.js';
 import { autoGuardSymbol } from './guard-override.js';
 /**
@@ -37,7 +37,7 @@ export type WaitUntilFunction<Assert extends AssertFunction<any>> = Assert exten
     options?: WaitUntilOptions | undefined,
     failureMessage?: string | undefined
 ]) => Promise<NarrowToExpected<Input, Guard>> : never;
-type WaitUntilGroup<Asserts extends Readonly<Record<string, AssertFunction<any>>>, WaitUntilOverrides extends WaitUntilOverridesBase> = Omit<Overwrite<{
+export type WaitUntilGroup<Asserts extends Readonly<Record<string, AssertFunction<any>>>, WaitUntilOverrides extends WaitUntilOverridesBase> = Omit<Overwrite<{
     [Name in keyof Asserts as Asserts[Name] extends AssertFunction<any> ? Name : never]: WaitUntilFunction<Asserts[Name]>;
 }, {
     [Name in keyof WaitUntilOverrides]: WaitUntilOverrides[Name] extends typeof autoGuardSymbol ? Name extends keyof Asserts ? Asserts[Name] extends AssertFunction<any> ? WaitUntilFunction<Asserts[Name]> : never : never : WaitUntilOverrides[Name];
@@ -65,4 +65,3 @@ export declare function parseWaitUntilArgs(rawArgs: unknown[]): {
     failureMessage: string | undefined;
 };
 export declare function parseWaitUntilOptions(rawOptions: WaitUntilOptions | undefined): RequiredAndNotNull<WaitUntilOptions>;
-export {};

package/dist/index.d.ts

@@ -6,4 +6,4 @@ export * from './augments/guards/check-wrap.js';
 export * from './augments/guards/check.js';
 export * from './augments/guards/wait-until.js';
 export * from './augments/if-equals.js';
-export type { WaitUntilOptions } from './guard-types/wait-until-function.js';
+export { type WaitUntilOptions } from './guard-types/wait-until-function.js';

package/dist/test-timeout.mock.d.ts

@@ -1,3 +1,3 @@
-import { RequiredAndNotNull } from '@augment-vir/core';
-import type { WaitUntilOptions } from './guard-types/wait-until-function.js';
+import { type RequiredAndNotNull } from '@augment-vir/core';
+import { type WaitUntilOptions } from './guard-types/wait-until-function.js';
 export declare const waitUntilTestOptions: RequiredAndNotNull<WaitUntilOptions>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/assert",
-    "version": "30.0.4",
+    "version": "30.1.0",
     "description": "A collection of assertions for test and production code alike.",
     "keywords": [
         "augment",
@@ -41,7 +41,7 @@
         "test:update": "npm test"
     },
     "dependencies": {
-        "@augment-vir/core": "^30.0.4",
+        "@augment-vir/core": "^30.1.0",
         "@date-vir/duration": "^6.0.0",
         "deep-eql": "^5.0.2",
         "expect-type": "^0.20.0",

package/dist/assertions/output.example.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/assertions/output.example.js

@@ -1,13 +0,0 @@
-import { assert, AssertionError } from '@augment-vir/assert';
-function myFunctionToTest(name) {
-    return `Hello there ${name}`;
-}
-const myCustomAsserter = (actual, expected, failureMessage) => {
-    // Write your assertion in an `if`.
-    if (!actual.startsWith('hello there') || actual.endsWith(expected)) {
-        // Throw an `AssertionError` if the `if` fails.
-        throw new AssertionError('', failureMessage);
-    }
-};
-// Use your custom asserter as the first input to any `.output` guard.
-assert.output(myCustomAsserter, myFunctionToTest, ['John'], 'John', 'Name insertion failed');

package/dist/assertions/runtime-type.example.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/assertions/runtime-type.example.js

@@ -1,3 +0,0 @@
-import { getRuntimeType } from '@augment-vir/assert';
-getRuntimeType(['a']); // RuntimeType.Array
-getRuntimeType({ a: 'a' }); // RuntimeType.Object

package/dist/assertions/throws.example.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/assertions/throws.example.js

@@ -1,11 +0,0 @@
-import { assert } from '@augment-vir/assert';
-// define the options
-const matchOptions = {
-    matchConstructor: Error,
-    matchMessage: 'some error',
-};
-assert.throws(() => {
-    throw new Error('some error');
-}, 
-// use the options
-matchOptions); // this assertion will pass

package/dist/augments/assertion.error.example.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/augments/assertion.error.example.js

@@ -1,3 +0,0 @@
-import { AssertionError } from '@augment-vir/assert';
-// the message from this error will be: `'User defined message: The assertion failed.'`
-throw new AssertionError('The assertion failed.', 'User defined message.');

package/dist/augments/guards/assert-wrap.example.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/augments/guards/assert-wrap.example.js

@@ -1,9 +0,0 @@
-import { assertWrap } from '@augment-vir/assert';
-// `result1` will be `['a']`
-const result1 = assertWrap.deepEquals(['a'], ['a']);
-const value = 'some value';
-// `result2` will be `'some value'` and it will have the type of `string`
-const result2 = assertWrap.isString(value);
-const value2 = 'some value';
-// this will throw an error
-const result3 = assertWrap.isNumber(value2);

package/dist/augments/guards/assert.example.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/augments/guards/assert.example.js

@@ -1,4 +0,0 @@
-import { assert } from '@augment-vir/assert';
-const value = 'some value';
-assert.isString(value);
-// `value` will now be typed as a `string`

package/dist/augments/guards/check-wrap.example.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/augments/guards/check-wrap.example.js

@@ -1,9 +0,0 @@
-import { checkWrap } from '@augment-vir/assert';
-// `result1` will be `['a']`
-const result1 = checkWrap.deepEquals(['a'], ['a']);
-const value = 'some value';
-// `result2` will be `'some value'` and it will have the type of `string`
-const result2 = checkWrap.isString(value);
-const value2 = 'some value';
-// `result` will be `undefined`
-const result3 = checkWrap.isNumber(value2);

package/dist/augments/guards/check.example.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/augments/guards/check.example.js

@@ -1,5 +0,0 @@
-import { check } from '@augment-vir/assert';
-const value = 'some value';
-if (check.isString(value)) {
-    // `value` will now be typed as a `string` in here
-}

package/dist/augments/guards/wait-until.example.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/augments/guards/wait-until.example.js

@@ -1,13 +0,0 @@
-import { waitUntil } from '@augment-vir/assert';
-// `result` will eventually be `'123'`
-const result = await waitUntil.isString(() => {
-    if (Math.random() < 0.5) {
-        return 123;
-    }
-    else {
-        return '123';
-    }
-}, {
-    interval: { milliseconds: 100 },
-    timeout: { seconds: 10 },
-});