@augment-vir/assert 31.0.0 → 31.0.1

package/dist/assertions/boundary.d.ts

@@ -39,20 +39,8 @@ export declare const boundaryGuards: {
          *
          * assert.endsWith('ab', 'b'); // passes
          * assert.endsWith('ab', 'a'); // fails
-         * assert.endsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // passes
-         * assert.endsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // fails
+         * assert.endsWith(['a', 'b'], 'b'); // passes
+         * assert.endsWith(['a', 'b'], 'a'); // fails
          * ```
          *
          * @throws {@link AssertionError} If the parent does not end with the child.
@@ -74,20 +62,8 @@ export declare const boundaryGuards: {
          *
          * assert.endsWithout('ab', 'b'); // fails
          * assert.endsWithout('ab', 'a'); // passes
-         * assert.endsWithout(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // fails
-         * assert.endsWithout(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // passes
+         * assert.endsWithout(['a', 'b'], 'b'); // fails
+         * assert.endsWithout(['a', 'b'], 'a'); // passes
          * ```
          *
          * @throws {@link AssertionError} If the parent ends with the child.
@@ -109,20 +85,8 @@ export declare const boundaryGuards: {
          *
          * assert.startsWith('ab', 'b'); // fails
          * assert.startsWith('ab', 'a'); // passes
-         * assert.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // fails
-         * assert.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // passes
+         * assert.startsWith(['a', 'b'], 'b'); // fails
+         * assert.startsWith(['a', 'b'], 'a'); // passes
          * ```
          *
          * @throws {@link AssertionError} If the parent does not start with the child.
@@ -144,20 +108,8 @@ export declare const boundaryGuards: {
          *
          * assert.startsWith('ab', 'b'); // passes
          * assert.startsWith('ab', 'a'); // fails
-         * assert.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // passes
-         * assert.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // fails
+         * assert.startsWith(['a', 'b'], 'b'); // passes
+         * assert.startsWith(['a', 'b'], 'a'); // fails
          * ```
          *
          * @throws {@link AssertionError} If the parent does start with the child.
@@ -181,20 +133,8 @@ export declare const boundaryGuards: {
          *
          * check.endsWith('ab', 'b'); // returns `true`
          * check.endsWith('ab', 'a'); // returns `false`
-         * check.endsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // returns `true`
-         * check.endsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // returns `false`
+         * check.endsWith(['a', 'b'], 'b'); // returns `true`
+         * check.endsWith(['a', 'b'], 'a'); // returns `false`
          * ```
          *
          * @see
@@ -215,20 +155,8 @@ export declare const boundaryGuards: {
          *
          * check.endsWithout('ab', 'b'); // returns `false`
          * check.endsWithout('ab', 'a'); // returns `true`
-         * check.endsWithout(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // returns `false`
-         * check.endsWithout(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // returns `true`
+         * check.endsWithout(['a', 'b'], 'b'); // returns `false`
+         * check.endsWithout(['a', 'b'], 'a'); // returns `true`
          * ```
          *
          * @see
@@ -249,20 +177,8 @@ export declare const boundaryGuards: {
          *
          * check.startsWith('ab', 'b'); // returns `false`
          * check.startsWith('ab', 'a'); // returns `true`
-         * check.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // returns `false`
-         * check.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // returns `true`
+         * check.startsWith(['a', 'b'], 'b'); // returns `false`
+         * check.startsWith(['a', 'b'], 'a'); // returns `true`
          * ```
          *
          * @see
@@ -283,20 +199,8 @@ export declare const boundaryGuards: {
          *
          * check.startsWith('ab', 'b'); // returns `false`
          * check.startsWith('ab', 'a'); // returns `true`
-         * check.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // returns `false`
-         * check.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // returns `true`
+         * check.startsWith(['a', 'b'], 'b'); // returns `false`
+         * check.startsWith(['a', 'b'], 'a'); // returns `true`
          * ```
          *
          * @see
@@ -319,20 +223,8 @@ export declare const boundaryGuards: {
          *
          * assertWrap.endsWith('ab', 'b'); // returns `'ab'`
          * assertWrap.endsWith('ab', 'a'); // throws an error
-         * assertWrap.endsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // returns `['a', 'b']`
-         * assertWrap.endsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // throws an error
+         * assertWrap.endsWith(['a', 'b'], 'b'); // returns `['a', 'b']`
+         * assertWrap.endsWith(['a', 'b'], 'a'); // throws an error
          * ```
          *
          * @returns The parent value if it does end with the child.
@@ -356,20 +248,8 @@ export declare const boundaryGuards: {
          *
          * assertWrap.endsWithout('ab', 'b'); // throws an error
          * assertWrap.endsWithout('ab', 'a'); // returns `'ab'`
-         * assertWrap.endsWithout(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // throws an error
-         * assertWrap.endsWithout(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // returns `['a', 'b']`
+         * assertWrap.endsWithout(['a', 'b'], 'b'); // throws an error
+         * assertWrap.endsWithout(['a', 'b'], 'a'); // returns `['a', 'b']`
          * ```
          *
          * @returns The parent value if it does not end with the child.
@@ -392,20 +272,8 @@ export declare const boundaryGuards: {
          *
          * assertWrap.startsWith('ab', 'b'); // throws an error
          * assertWrap.startsWith('ab', 'a'); // returns `'ab'`
-         * assertWrap.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // throws an error
-         * assertWrap.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // returns `['a', 'b']`
+         * assertWrap.startsWith(['a', 'b'], 'b'); // throws an error
+         * assertWrap.startsWith(['a', 'b'], 'a'); // returns `['a', 'b']`
          * ```
          *
          * @returns The parent value if it starts with the child.
@@ -428,20 +296,8 @@ export declare const boundaryGuards: {
          *
          * assertWrap.startsWith('ab', 'b'); // returns `'ab'`
          * assertWrap.startsWith('ab', 'a'); // throws an error
-         * assertWrap.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // returns `['a', 'b']`
-         * assertWrap.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // throws an error
+         * assertWrap.startsWith(['a', 'b'], 'b'); // returns `['a', 'b']`
+         * assertWrap.startsWith(['a', 'b'], 'a'); // throws an error
          * ```
          *
          * @returns The parent value if it does not start with the child.
@@ -467,20 +323,8 @@ export declare const boundaryGuards: {
          *
          * checkWrap.endsWith('ab', 'b'); // returns `'ab'`
          * checkWrap.endsWith('ab', 'a'); // returns `undefined`
-         * checkWrap.endsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // returns `['a', 'b']`
-         * checkWrap.endsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // returns `undefined`
+         * checkWrap.endsWith(['a', 'b'], 'b'); // returns `['a', 'b']`
+         * checkWrap.endsWith(['a', 'b'], 'a'); // returns `undefined`
          * ```
          *
          * @returns The first value if the check passes, otherwise `undefined`.
@@ -503,20 +347,8 @@ export declare const boundaryGuards: {
          *
          * checkWrap.endsWithout('ab', 'b'); // returns `undefined`
          * checkWrap.endsWithout('ab', 'a'); // returns `'ab'`
-         * checkWrap.endsWithout(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // returns `undefined`
-         * checkWrap.endsWithout(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // returns `['a', 'b']`
+         * checkWrap.endsWithout(['a', 'b'], 'b'); // returns `undefined`
+         * checkWrap.endsWithout(['a', 'b'], 'a'); // returns `['a', 'b']`
          * ```
          *
          * @returns The first value if the check passes, otherwise `undefined`.
@@ -539,20 +371,8 @@ export declare const boundaryGuards: {
          *
          * checkWrap.startsWith('ab', 'b'); // returns `undefined`
          * checkWrap.startsWith('ab', 'a'); // returns `'ab'`
-         * checkWrap.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // returns `undefined`
-         * checkWrap.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // returns `['a', 'b']`
+         * checkWrap.startsWith(['a', 'b'], 'b'); // returns `undefined`
+         * checkWrap.startsWith(['a', 'b'], 'a'); // returns `['a', 'b']`
          * ```
          *
          * @returns The first value if the check passes, otherwise `undefined`.
@@ -575,20 +395,8 @@ export declare const boundaryGuards: {
          *
          * checkWrap.startsWith('ab', 'b'); // returns `undefined`
          * checkWrap.startsWith('ab', 'a'); // returns `'ab'`
-         * checkWrap.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'b',
-         * ); // returns `undefined`
-         * checkWrap.startsWith(
-         *     [
-         *         'a',
-         *         'b',
-         *     ],
-         *     'a',
-         * ); // returns `['a', 'b']`
+         * checkWrap.startsWith(['a', 'b'], 'b'); // returns `undefined`
+         * checkWrap.startsWith(['a', 'b'], 'a'); // returns `['a', 'b']`
          * ```
          *
          * @returns The first value if the check passes, otherwise `undefined`.
@@ -613,14 +421,8 @@ export declare const boundaryGuards: {
          *
          * await waitUntil.endsWith('b', () => 'ab'); // returns `'ab'`
          * await waitUntil.endsWith('a', () => 'ab'); // throws an error
-         * await waitUntil.endsWith('b', () => [
-         *     'a',
-         *     'b',
-         * ]); // returns `['a', 'b']`
-         * await waitUntil.endsWith('a', () => [
-         *     'a',
-         *     'b',
-         * ]); // throws an error
+         * await waitUntil.endsWith('b', () => ['a', 'b']); // returns `['a', 'b']`
+         * await waitUntil.endsWith('a', () => ['a', 'b']); // throws an error
          * ```
          *
          * @returns The callback output once it passes.
@@ -644,14 +446,8 @@ export declare const boundaryGuards: {
          *
          * await waitUntil.endsWith('b', () => 'ab'); // throws an error
          * await waitUntil.endsWith('a', () => 'ab'); // returns `'ab'`
-         * await waitUntil.endsWith('b', () => [
-         *     'a',
-         *     'b',
-         * ]); // throws an error
-         * await waitUntil.endsWith('a', () => [
-         *     'a',
-         *     'b',
-         * ]); // returns `['a', 'b']`
+         * await waitUntil.endsWith('b', () => ['a', 'b']); // throws an error
+         * await waitUntil.endsWith('a', () => ['a', 'b']); // returns `['a', 'b']`
          * ```
          *
          * @returns The callback output once it passes.
@@ -675,14 +471,8 @@ export declare const boundaryGuards: {
          *
          * await waitUntil.endsWith('b', () => 'ab'); // throws an error
          * await waitUntil.endsWith('a', () => 'ab'); // returns `'ab'`
-         * await waitUntil.endsWith('b', () => [
-         *     'a',
-         *     'b',
-         * ]); // throws an error
-         * await waitUntil.endsWith('a', () => [
-         *     'a',
-         *     'b',
-         * ]); // returns `['a', 'b']`
+         * await waitUntil.endsWith('b', () => ['a', 'b']); // throws an error
+         * await waitUntil.endsWith('a', () => ['a', 'b']); // returns `['a', 'b']`
          * ```
          *
          * @returns The callback output once it passes.
@@ -705,14 +495,8 @@ export declare const boundaryGuards: {
          * ```ts
          * await waitUntil.endsWith('b', () => 'ab'); // returns `'ab'`
          * await waitUntil.endsWith('a', () => 'ab'); // throws an error
-         * await waitUntil.endsWith('b', () => [
-         *     'a',
-         *     'b',
-         * ]); // returns `['a', 'b']`
-         * await waitUntil.endsWith('a', () => [
-         *     'a',
-         *     'b',
-         * ]); // throws an error
+         * await waitUntil.endsWith('b', () => ['a', 'b']); // returns `['a', 'b']`
+         * await waitUntil.endsWith('a', () => ['a', 'b']); // throws an error
          * ```
          *
          * @returns The callback output once it passes.