@augment-vir/assert
Version:
A collection of assertions for test and production code alike.
194 lines (193 loc) • 7.26 kB
TypeScript
import { type MaybePromise } from '@augment-vir/core';
import { type WaitUntilOptions } from '../guard-types/wait-until-function.js';
export declare const nullishGuards: {
assert: {
/**
* Asserts that a value is defined (not `null` and not `undefined`).
*
* Type guards the value.
*
* @example
*
* ```ts
* import {assert} from '@augment-vir/assert';
*
* assert.isDefined(0); // passes
* assert.isDefined(''); // passes
* assert.isDefined(null); // fails
* assert.isDefined(undefined); // fails
* ```
*
* @throws {@link AssertionError} If the assertion fails.
* @see
* - {@link assert.isNullish} : the opposite assertion.
*/
isDefined<const Actual>(this: void, input: Actual, failureMessage?: string | undefined): asserts input is Exclude<Actual, undefined | null>;
/**
* Asserts that a value is nullish (`null` or `undefined`).
*
* Type guards the value.
*
* @example
*
* ```ts
* import {assert} from '@augment-vir/assert';
*
* assert.isNullish(0); // fails
* assert.isNullish(''); // fails
* assert.isNullish(null); // passes
* assert.isNullish(undefined); // passes
* ```
*
* @throws {@link AssertionError} If the assertion fails.
* @see
* - {@link assert.isDefined} : the opposite assertion.
*/
isNullish(this: void, input: unknown, failureMessage?: string | undefined): asserts input is null | undefined;
};
check: {
/**
* Checks that a value is defined (not `null` and not `undefined`).
*
* Type guards the value.
*
* @example
*
* ```ts
* import {check} from '@augment-vir/assert';
*
* check.isDefined(0); // returns `true`
* check.isDefined(''); // returns `true`
* check.isDefined(null); // returns `false`
* check.isDefined(undefined); // returns `false`
* ```
*
* @see
* - {@link check.isNullish} : the opposite check.
*/
isDefined<Actual>(this: void, input: Actual): input is Exclude<Actual, undefined | null>;
/**
* Checks that a value is nullish (`null` or `undefined`).
*
* Type guards the value.
*
* @example
*
* ```ts
* import {check} from '@augment-vir/assert';
*
* check.isNullish(0); // returns `false`
* check.isNullish(''); // returns `false`
* check.isNullish(null); // returns `true`
* check.isNullish(undefined); // returns `true`
* ```
*
* @see
* - {@link check.isDefined} : the opposite check.
*/
isNullish(this: void, input: unknown): input is null | undefined;
};
assertWrap: {
/**
* Asserts that a value is defined (not `null` and not `undefined`). Returns the value if
* the assertion passes.
*
* Type guards the value.
*
* @example
*
* ```ts
* import {assertWrap} from '@augment-vir/assert';
*
* assertWrap.isDefined(0); // returns `0`
* assertWrap.isDefined(''); // returns `''`
* assertWrap.isDefined(null); // fails
* assertWrap.isDefined(undefined); // fails
* ```
*
* @returns The value if the assertion passes.
* @throws {@link AssertionError} If the assertion fails.
* @see
* - {@link assertWrap.isNullish} : the opposite assertion.
*/
isDefined<Actual>(this: void, input: Actual, failureMessage?: string | undefined): Exclude<Actual, undefined | null>;
/**
* Asserts that a value is nullish (`null` or `undefined`). Returns the value if the
* assertion passes.
*
* Type guards the value.
*
* @example
*
* ```ts
* import {assertWrap} from '@augment-vir/assert';
*
* assertWrap.isNullish(0); // fails
* assertWrap.isNullish(''); // fails
* assertWrap.isNullish(null); // returns `null`
* assertWrap.isNullish(undefined); // returns `undefined`
* ```
*
* @returns The value if the assertion passes.
* @throws {@link AssertionError} If the assertion fails.
* @see
* - {@link assertWrap.isDefined} : the opposite assertion.
*/
isNullish<Actual>(this: void, input: Actual, failureMessage?: string | undefined): Extract<Actual, undefined | null>;
};
/** Nullish checks don't make any sense on `checkWrap`. */
checkWrap: {
isDefined: undefined;
isNullish: undefined;
};
waitUntil: {
/**
* Repeatedly calls a callback until its output is a value that is defined (not `null` and
* not `undefined`). Once the callback output passes, it is returned. If the attempts time
* out, an error is thrown.
*
* Type guards the value.
*
* @example
*
* ```ts
* import {waitUntil} from '@augment-vir/assert';
*
* await waitUntil.isDefined(() => 0); // returns `0`
* await waitUntil.isDefined(() => ''); // returns `''`
* await waitUntil.isDefined(() => null); // throws an error
* await waitUntil.isDefined(() => undefined); // throws an error
* ```
*
* @returns The callback output once it passes.
* @throws {@link AssertionError} On timeout.
* @see
* - {@link waitUntil.isNullish} : the opposite assertion.
*/
isDefined: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Exclude<Actual, undefined | null>>;
/**
* Repeatedly calls a callback until its output is a value that is nullish (`null` or
* `undefined`). Once the callback output passes, it is returned. If the attempts time out,
* an error is thrown.
*
* Type guards the value.
*
* @example
*
* ```ts
* import {waitUntil} from '@augment-vir/assert';
*
* await waitUntil.isNullish(() => 0); // throws an error
* await waitUntil.isNullish(() => ''); // throws an error
* await waitUntil.isNullish(() => null); // returns `null`
* await waitUntil.isNullish(() => undefined); // returns `undefined`
* ```
*
* @returns The callback output once it passes.
* @throws {@link AssertionError} On timeout.
* @see
* - {@link waitUntil.isDefined} : the opposite assertion.
*/
isNullish: <Actual>(this: void, callback: () => MaybePromise<Actual>, options?: WaitUntilOptions | undefined, failureMessage?: string | undefined) => Promise<Extract<Actual, undefined | null>>;
};
};