@augment-vir/assert 30.0.0 → 30.0.1

package/dist/assertions/primitive.js

@@ -1,6 +1,6 @@
 import { stringify } from '@augment-vir/core';
 import { AssertionError } from '../augments/assertion.error.js';
-import { autoGuard } from '../guard-types/guard-override.js';
+import { autoGuard, autoGuardSymbol } from '../guard-types/guard-override.js';
 /** Asserts that the given value is a primitive. */
 function isPrimitive(input, failureMessage) {
     /**
@@ -42,21 +42,367 @@ const assertions = {
     isNotPrimitive,
 };
 export const primitiveGuards = {
-    assertions,
-    checkOverrides: {
+    assert: assertions,
+    check: {
+        /**
+         * Checks that a value is a valid `PropertyKey`. `PropertyKey` is a built-in TypeScript type
+         * which refers to all possible key types for a JavaScript object.
+         *
+         * Type guards the value.
+         *
+         * @example
+         *
+         * ```ts
+         * import {check} from '@augment-vir/assert';
+         *
+         * check.isPropertyKey('key'); // returns `true`
+         * check.isPropertyKey(true); // returns `false`
+         * check.isPropertyKey({}); // returns `false`
+         * ```
+         *
+         * @see
+         * - {@link check.isNotPropertyKey} : the opposite check.
+         */
         isNotPrimitive: autoGuard(),
+        /**
+         * 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.
+         *
+         * Type guards the value.
+         *
+         * @example
+         *
+         * ```ts
+         * import {check} from '@augment-vir/assert';
+         *
+         * check.isNotPropertyKey('key'); // returns `false`
+         * check.isNotPropertyKey(true); // returns `true`
+         * check.isNotPropertyKey({}); // returns `true`
+         * ```
+         *
+         * @see
+         * - {@link check.isPropertyKey} : the opposite check.
+         */
         isNotPropertyKey: autoGuard(),
+        /**
+         * Checks that a value is a JavaScript
+         * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive).
+         *
+         * Type guards the value.
+         *
+         * @example
+         *
+         * ```ts
+         * import {check} from '@augment-vir/assert';
+         *
+         * check.isPrimitive('key'); // returns `true`
+         * check.isPrimitive(true); // returns `true`
+         * check.isPrimitive({}); // returns `false`
+         * ```
+         *
+         * @see
+         * - {@link check.isNotPrimitive} : the opposite check.
+         */
+        isPrimitive: autoGuardSymbol,
+        /**
+         * Checks that a value is _not_ a JavaScript
+         * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive).
+         *
+         * Type guards the value.
+         *
+         * @example
+         *
+         * ```ts
+         * import {check} from '@augment-vir/assert';
+         *
+         * check.isPrimitive('key'); // returns `false`
+         * check.isPrimitive(true); // returns `false`
+         * check.isPrimitive({}); // returns `true`
+         * ```
+         *
+         * @see
+         * - {@link check.isPrimitive} : the opposite check.
+         */
+        isPropertyKey: autoGuardSymbol,
     },
-    assertWrapOverrides: {
+    assertWrap: {
+        /**
+         * Asserts that a value is a valid `PropertyKey`. `PropertyKey` is a built-in TypeScript
+         * type which refers to all possible key types for a JavaScript object. Returns the value if
+         * the assertion passes.
+         *
+         * Type guards the value.
+         *
+         * @example
+         *
+         * ```ts
+         * import {assertWrap} from '@augment-vir/assert';
+         *
+         * assertWrap.isPropertyKey('key'); // returns `'key'`
+         * assertWrap.isPropertyKey(true); // throws an error
+         * assertWrap.isPropertyKey({}); // throws an error
+         * ```
+         *
+         * @returns The value if the assertion passes.
+         * @throws {@link AssertionError} If the assertion fails.
+         * @see
+         * - {@link assertWrap.isNotPropertyKey} : the opposite assertion.
+         */
         isNotPrimitive: autoGuard(),
+        /**
+         * 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
+         * the value if the assertion passes.
+         *
+         * Type guards the value.
+         *
+         * @example
+         *
+         * ```ts
+         * import {assertWrap} from '@augment-vir/assert';
+         *
+         * assertWrap.isNotPropertyKey('key'); // throws an error
+         * assertWrap.isNotPropertyKey(true); // returns `true`
+         * assertWrap.isNotPropertyKey({}); // returns `{}`
+         * ```
+         *
+         * @returns The value if the assertion passes.
+         * @throws {@link AssertionError} If the assertion fails.
+         * @see
+         * - {@link assertWrap.isPropertyKey} : the opposite assertion.
+         */
         isNotPropertyKey: autoGuard(),
+        /**
+         * Asserts that a value is a JavaScript
+         * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive). Returns the value if
+         * the assertion passes.
+         *
+         * Type guards the value.
+         *
+         * @example
+         *
+         * ```ts
+         * import {assertWrap} from '@augment-vir/assert';
+         *
+         * assertWrap.isPrimitive('key'); // returns `'key'`
+         * assertWrap.isPrimitive(true); // returns `true`
+         * assertWrap.isPrimitive({}); // throws an error
+         * ```
+         *
+         * @returns The value if the assertion passes.
+         * @throws {@link AssertionError} If the assertion fails.
+         * @see
+         * - {@link assertWrap.isNotPrimitive} : the opposite assertion.
+         */
+        isPrimitive: autoGuardSymbol,
+        /**
+         * Asserts that a value is _not_ a JavaScript
+         * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive). Returns the value if
+         * the assertion passes.
+         *
+         * Type guards the value.
+         *
+         * @example
+         *
+         * ```ts
+         * import {assertWrap} from '@augment-vir/assert';
+         *
+         * assertWrap.isPrimitive('key'); // throws an error
+         * assertWrap.isPrimitive(true); // throws an error
+         * assertWrap.isPrimitive({}); // returns `{}`
+         * ```
+         *
+         * @returns The value if the assertion passes.
+         * @throws {@link AssertionError} If the assertion fails.
+         * @see
+         * - {@link assertWrap.isPrimitive} : the opposite assertion.
+         */
+        isPropertyKey: autoGuardSymbol,
     },
-    checkWrapOverrides: {
+    checkWrap: {
+        /**
+         * Checks that a value is a valid `PropertyKey`. `PropertyKey` is a built-in TypeScript type
+         * which refers to all possible key types for a JavaScript object. Returns the value if the
+         * check passes, otherwise `undefined`.
+         *
+         * Type guards the value.
+         *
+         * @example
+         *
+         * ```ts
+         * import {checkWrap} from '@augment-vir/assert';
+         *
+         * checkWrap.isPropertyKey('key'); // returns `'key'`
+         * checkWrap.isPropertyKey(true); // returns `undefined`
+         * checkWrap.isPropertyKey({}); // returns `undefined`
+         * ```
+         *
+         * @returns The value if the check passes, otherwise `undefined`.
+         * @see
+         * - {@link checkWrap.isNotPropertyKey} : the opposite check.
+         */
         isNotPrimitive: autoGuard(),
+        /**
+         * 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
+         * the value if the check passes, otherwise `undefined`.
+         *
+         * Type guards the value.
+         *
+         * @example
+         *
+         * ```ts
+         * import {checkWrap} from '@augment-vir/assert';
+         *
+         * checkWrap.isNotPropertyKey('key'); // returns `undefined`
+         * checkWrap.isNotPropertyKey(true); // returns `true`
+         * checkWrap.isNotPropertyKey({}); // returns `{}`
+         * ```
+         *
+         * @returns The value if the check passes, otherwise `undefined`.
+         * @see
+         * - {@link checkWrap.isPropertyKey} : the opposite check.
+         */
         isNotPropertyKey: autoGuard(),
+        /**
+         * Checks that a value is a JavaScript
+         * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive). Returns the value if
+         * the check passes, otherwise `undefined`.
+         *
+         * Type guards the value.
+         *
+         * @example
+         *
+         * ```ts
+         * import {checkWrap} from '@augment-vir/assert';
+         *
+         * checkWrap.isPrimitive('key'); // returns `'key'`
+         * checkWrap.isPrimitive(true); // returns `true`
+         * checkWrap.isPrimitive({}); // returns `undefined`
+         * ```
+         *
+         * @returns The value if the check passes, otherwise `undefined`.
+         * @see
+         * - {@link checkWrap.isNotPrimitive} : the opposite check.
+         */
+        isPrimitive: autoGuardSymbol,
+        /**
+         * Checks that a value is _not_ a JavaScript
+         * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive). Returns the value if
+         * the check passes, otherwise `undefined`.
+         *
+         * Type guards the value.
+         *
+         * @example
+         *
+         * ```ts
+         * import {checkWrap} from '@augment-vir/assert';
+         *
+         * checkWrap.isPrimitive('key'); // returns `undefined`
+         * checkWrap.isPrimitive(true); // returns `undefined`
+         * checkWrap.isPrimitive({}); // returns `{}`
+         * ```
+         *
+         * @returns The value if the check passes, otherwise `undefined`.
+         * @see
+         * - {@link checkWrap.isPrimitive} : the opposite check.
+         */
+        isPropertyKey: autoGuardSymbol,
     },
-    waitUntilOverrides: {
+    waitUntil: {
+        /**
+         * Repeatedly calls a callback until its output is a valid `PropertyKey`. `PropertyKey` is a
+         * built-in TypeScript type which refers to all possible key types for a JavaScript object.
+         * 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.isPropertyKey('key'); // returns `'key'`
+         * await waitUntil.isPropertyKey(true); // throws an error
+         * await waitUntil.isPropertyKey({}); // throws an error
+         * ```
+         *
+         * @returns The callback output once it passes.
+         * @throws {@link AssertionError} If the assertion fails.
+         * @see
+         * - {@link waitUntil.isNotPropertyKey} : the opposite assertion.
+         */
         isNotPrimitive: autoGuard(),
+        /**
+         * 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
+         * JavaScript object. 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.isNotPropertyKey('key'); // throws an error
+         * await waitUntil.isNotPropertyKey(true); // returns `true`
+         * await waitUntil.isNotPropertyKey({}); // returns `{}`
+         * ```
+         *
+         * @returns The callback output once it passes.
+         * @throws {@link AssertionError} If the assertion fails.
+         * @see
+         * - {@link waitUntil.isPropertyKey} : the opposite assertion.
+         */
         isNotPropertyKey: autoGuard(),
+        /**
+         * Repeatedly calls a callback until its output is a JavaScript
+         * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive). 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.isPrimitive('key'); // returns `'key'`
+         * await waitUntil.isPrimitive(true); // returns `true`
+         * await waitUntil.isPrimitive({}); // throws an error
+         * ```
+         *
+         * @returns The callback output once it passes.
+         * @throws {@link AssertionError} If the assertion fails.
+         * @see
+         * - {@link waitUntil.isNotPrimitive} : the opposite assertion.
+         */
+        isPrimitive: autoGuardSymbol,
+        /**
+         * Repeatedly calls a callback until its output is _not_ a JavaScript
+         * [primitive](https://developer.mozilla.org/docs/Glossary/Primitive). 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.isPrimitive('key'); // throws an error
+         * await waitUntil.isPrimitive(true); // throws an error
+         * await waitUntil.isPrimitive({}); // returns `{}`
+         * ```
+         *
+         * @returns The callback output once it passes.
+         * @throws {@link AssertionError} If the assertion fails.
+         * @see
+         * - {@link waitUntil.isPrimitive} : the opposite assertion.
+         */
+        isPropertyKey: autoGuardSymbol,
     },
 };