ts-data-forge 5.1.0 → 6.0.0

package/dist/collections/stack.d.mts

@@ -40,18 +40,18 @@ export type Stack<T> = Readonly<{
      * ```ts
      * const stack = createStack<string>();
      *
-     * assert.ok(stack.isEmpty);
+     * assert.isTrue(stack.isEmpty);
      *
-     * assert(stack.size === 0);
+     * assert.isTrue(stack.size === 0);
      *
      * stack.push('first');
      *
      * // eslint-disable-next-line unicorn/prefer-single-call
      * stack.push('second');
      *
-     * assert.notOk(stack.isEmpty);
+     * assert.isFalse(stack.isEmpty);
      *
-     * assert(stack.size === 2);
+     * assert.isTrue(stack.size === 2);
      *
      * assert.deepStrictEqual(stack.pop(), Optional.some('second'));
      *
@@ -61,7 +61,7 @@ export type Stack<T> = Readonly<{
      *
      * const seededStack = createStack([10, 20, 30]);
      *
-     * assert(seededStack.size === 3);
+     * assert.isTrue(seededStack.size === 3);
      *
      * assert.deepStrictEqual(seededStack.pop(), Optional.some(30));
      * ```
@@ -75,18 +75,18 @@ export type Stack<T> = Readonly<{
      * ```ts
      * const stack = createStack<string>();
      *
-     * assert.ok(stack.isEmpty);
+     * assert.isTrue(stack.isEmpty);
      *
-     * assert(stack.size === 0);
+     * assert.isTrue(stack.size === 0);
      *
      * stack.push('first');
      *
      * // eslint-disable-next-line unicorn/prefer-single-call
      * stack.push('second');
      *
-     * assert.notOk(stack.isEmpty);
+     * assert.isFalse(stack.isEmpty);
      *
-     * assert(stack.size === 2);
+     * assert.isTrue(stack.size === 2);
      *
      * assert.deepStrictEqual(stack.pop(), Optional.some('second'));
      *
@@ -96,7 +96,7 @@ export type Stack<T> = Readonly<{
      *
      * const seededStack = createStack([10, 20, 30]);
      *
-     * assert(seededStack.size === 3);
+     * assert.isTrue(seededStack.size === 3);
      *
      * assert.deepStrictEqual(seededStack.pop(), Optional.some(30));
      * ```
@@ -110,18 +110,18 @@ export type Stack<T> = Readonly<{
      * ```ts
      * const stack = createStack<string>();
      *
-     * assert.ok(stack.isEmpty);
+     * assert.isTrue(stack.isEmpty);
      *
-     * assert(stack.size === 0);
+     * assert.isTrue(stack.size === 0);
      *
      * stack.push('first');
      *
      * // eslint-disable-next-line unicorn/prefer-single-call
      * stack.push('second');
      *
-     * assert.notOk(stack.isEmpty);
+     * assert.isFalse(stack.isEmpty);
      *
-     * assert(stack.size === 2);
+     * assert.isTrue(stack.size === 2);
      *
      * assert.deepStrictEqual(stack.pop(), Optional.some('second'));
      *
@@ -131,7 +131,7 @@ export type Stack<T> = Readonly<{
      *
      * const seededStack = createStack([10, 20, 30]);
      *
-     * assert(seededStack.size === 3);
+     * assert.isTrue(seededStack.size === 3);
      *
      * assert.deepStrictEqual(seededStack.pop(), Optional.some(30));
      * ```
@@ -148,18 +148,18 @@ export type Stack<T> = Readonly<{
      * ```ts
      * const stack = createStack<string>();
      *
-     * assert.ok(stack.isEmpty);
+     * assert.isTrue(stack.isEmpty);
      *
-     * assert(stack.size === 0);
+     * assert.isTrue(stack.size === 0);
      *
      * stack.push('first');
      *
      * // eslint-disable-next-line unicorn/prefer-single-call
      * stack.push('second');
      *
-     * assert.notOk(stack.isEmpty);
+     * assert.isFalse(stack.isEmpty);
      *
-     * assert(stack.size === 2);
+     * assert.isTrue(stack.size === 2);
      *
      * assert.deepStrictEqual(stack.pop(), Optional.some('second'));
      *
@@ -169,7 +169,7 @@ export type Stack<T> = Readonly<{
      *
      * const seededStack = createStack([10, 20, 30]);
      *
-     * assert(seededStack.size === 3);
+     * assert.isTrue(seededStack.size === 3);
      *
      * assert.deepStrictEqual(seededStack.pop(), Optional.some(30));
      * ```
@@ -207,18 +207,18 @@ export type Stack<T> = Readonly<{
  * ```ts
  * const stack = createStack<string>();
  *
- * assert.ok(stack.isEmpty);
+ * assert.isTrue(stack.isEmpty);
  *
- * assert(stack.size === 0);
+ * assert.isTrue(stack.size === 0);
  *
  * stack.push('first');
  *
  * // eslint-disable-next-line unicorn/prefer-single-call
  * stack.push('second');
  *
- * assert.notOk(stack.isEmpty);
+ * assert.isFalse(stack.isEmpty);
  *
- * assert(stack.size === 2);
+ * assert.isTrue(stack.size === 2);
  *
  * assert.deepStrictEqual(stack.pop(), Optional.some('second'));
  *
@@ -228,7 +228,7 @@ export type Stack<T> = Readonly<{
  *
  * const seededStack = createStack([10, 20, 30]);
  *
- * assert(seededStack.size === 3);
+ * assert.isTrue(seededStack.size === 3);
  *
  * assert.deepStrictEqual(seededStack.pop(), Optional.some(30));
  * ```

package/dist/collections/stack.mjs

@@ -171,18 +171,18 @@ class StackClass {
  * ```ts
  * const stack = createStack<string>();
  *
- * assert.ok(stack.isEmpty);
+ * assert.isTrue(stack.isEmpty);
  *
- * assert(stack.size === 0);
+ * assert.isTrue(stack.size === 0);
  *
  * stack.push('first');
  *
  * // eslint-disable-next-line unicorn/prefer-single-call
  * stack.push('second');
  *
- * assert.notOk(stack.isEmpty);
+ * assert.isFalse(stack.isEmpty);
  *
- * assert(stack.size === 2);
+ * assert.isTrue(stack.size === 2);
  *
  * assert.deepStrictEqual(stack.pop(), Optional.some('second'));
  *
@@ -192,7 +192,7 @@ class StackClass {
  *
  * const seededStack = createStack([10, 20, 30]);
  *
- * assert(seededStack.size === 3);
+ * assert.isTrue(seededStack.size === 3);
  *
  * assert.deepStrictEqual(seededStack.pop(), Optional.some(30));
  * ```

package/dist/functional/match.d.mts

@@ -31,7 +31,7 @@
  *   published: 'Complete',
  * });
  *
- * assert(message === 'Work in progress');
+ * assert.isTrue(message === 'Work in progress');
  * ```
  *
  * @param target - The value to match against

package/dist/functional/optional/impl/optional-expect-to-be.d.mts

@@ -8,13 +8,13 @@ import { type Unwrap } from './types.mjs';
  * ```ts
  * const optionalValue = Optional.some('data');
  *
- * assert(Optional.expectToBe(optionalValue, 'value expected') === 'data');
+ * assert.isTrue(Optional.expectToBe(optionalValue, 'value expected') === 'data');
  *
  * const expectValue = Optional.expectToBe<string>('missing optional');
  *
  * assert.throws(() => expectValue(Optional.none), /missing optional/u);
  *
- * assert(expectValue(Optional.some('present')) === 'present');
+ * assert.isTrue(expectValue(Optional.some('present')) === 'present');
  * ```
  *
  * @template O The `UnknownOptional` type to unwrap.

package/dist/functional/optional/impl/optional-is-none.d.mts

@@ -9,7 +9,7 @@ import { type NarrowToNone } from './types.mjs';
  *
  * if (Optional.isNone(optionalValue)) {
  *   // Type narrowed to None
- *   assert.ok(true); // optionalValue is None
+ *   assert.isTrue(true); // optionalValue is None
  * }
  * ```
  *

package/dist/functional/optional/impl/optional-is-none.mjs

@@ -10,7 +10,7 @@ import { NoneTypeTagName } from './tag.mjs';
  *
  * if (Optional.isNone(optionalValue)) {
  *   // Type narrowed to None
- *   assert.ok(true); // optionalValue is None
+ *   assert.isTrue(true); // optionalValue is None
  * }
  * ```
  *

package/dist/functional/optional/impl/optional-is-optional.d.mts

@@ -8,9 +8,9 @@
  *
  * const notOptional = { $$tag: 'ts-data-forge::Optional.some' };
  *
- * assert.ok(Optional.isOptional(maybeOptional));
+ * assert.isTrue(Optional.isOptional(maybeOptional));
  *
- * assert.notOk(Optional.isOptional(notOptional));
+ * assert.isFalse(Optional.isOptional(notOptional));
  * ```
  *
  * @param maybeOptional The value to check.

package/dist/functional/optional/impl/optional-is-optional.mjs

@@ -11,9 +11,9 @@ import { SomeTypeTagName, NoneTypeTagName } from './tag.mjs';
  *
  * const notOptional = { $$tag: 'ts-data-forge::Optional.some' };
  *
- * assert.ok(Optional.isOptional(maybeOptional));
+ * assert.isTrue(Optional.isOptional(maybeOptional));
  *
- * assert.notOk(Optional.isOptional(notOptional));
+ * assert.isFalse(Optional.isOptional(notOptional));
  * ```
  *
  * @param maybeOptional The value to check.

package/dist/functional/optional/impl/optional-is-some.d.mts

@@ -10,7 +10,7 @@ import { type NarrowToSome } from './types.mjs';
  * if (Optional.isSome(optionalNumber)) {
  *   const value: number = optionalNumber.value;
  *
- *   assert(value === 42);
+ *   assert.isTrue(value === 42);
  * }
  * ```
  *

package/dist/functional/optional/impl/optional-is-some.mjs

@@ -11,7 +11,7 @@ import { SomeTypeTagName } from './tag.mjs';
  * if (Optional.isSome(optionalNumber)) {
  *   const value: number = optionalNumber.value;
  *
- *   assert(value === 42);
+ *   assert.isTrue(value === 42);
  * }
  * ```
  *

package/dist/functional/optional/impl/optional-none.d.mts

@@ -9,9 +9,9 @@
  *
  * const noneValue = Optional.none;
  *
- * assert.ok(Optional.isSome(someValue));
+ * assert.isTrue(Optional.isSome(someValue));
  *
- * assert.ok(Optional.isNone(noneValue));
+ * assert.isTrue(Optional.isNone(noneValue));
  * ```
  */
 export declare const none: None;

package/dist/functional/optional/impl/optional-none.mjs

@@ -11,9 +11,9 @@ import { NoneTypeTagName } from './tag.mjs';
  *
  * const noneValue = Optional.none;
  *
- * assert.ok(Optional.isSome(someValue));
+ * assert.isTrue(Optional.isSome(someValue));
  *
- * assert.ok(Optional.isNone(noneValue));
+ * assert.isTrue(Optional.isNone(noneValue));
  * ```
  */
 const none = { $$tag: NoneTypeTagName };

package/dist/functional/optional/impl/optional-some.d.mts

@@ -8,9 +8,9 @@
  *
  * const noneValue = Optional.none;
  *
- * assert.ok(Optional.isSome(someValue));
+ * assert.isTrue(Optional.isSome(someValue));
  *
- * assert.ok(Optional.isNone(noneValue));
+ * assert.isTrue(Optional.isNone(noneValue));
  * ```
  *
  * @template S The type of the value.

package/dist/functional/optional/impl/optional-some.mjs

@@ -10,9 +10,9 @@ import { SomeTypeTagName } from './tag.mjs';
  *
  * const noneValue = Optional.none;
  *
- * assert.ok(Optional.isSome(someValue));
+ * assert.isTrue(Optional.isSome(someValue));
  *
- * assert.ok(Optional.isNone(noneValue));
+ * assert.isTrue(Optional.isNone(noneValue));
  * ```
  *
  * @template S The type of the value.

package/dist/functional/optional/impl/optional-to-nullable.d.mts

@@ -16,9 +16,9 @@ import { type Unwrap } from './types.mjs';
  *
  * const noneNumber = Optional.none as Optional<number>;
  *
- * assert(Optional.toNullable(someNumber) === 42);
+ * assert.isTrue(Optional.toNullable(someNumber) === 42);
  *
- * assert(Optional.toNullable(noneNumber) === undefined);
+ * assert.isTrue(Optional.toNullable(noneNumber) === undefined);
  * ```
  *
  * @template O The `UnknownOptional` type to convert.

package/dist/functional/optional/impl/optional-to-nullable.mjs

@@ -18,9 +18,9 @@ import { unwrap } from './optional-unwrap.mjs';
  *
  * const noneNumber = Optional.none as Optional<number>;
  *
- * assert(Optional.toNullable(someNumber) === 42);
+ * assert.isTrue(Optional.toNullable(someNumber) === 42);
  *
- * assert(Optional.toNullable(noneNumber) === undefined);
+ * assert.isTrue(Optional.toNullable(noneNumber) === undefined);
  * ```
  *
  * @template O The `UnknownOptional` type to convert.

package/dist/functional/optional/impl/optional-unwrap-or.d.mts

@@ -14,15 +14,15 @@ import { type Unwrap } from './types.mjs';
  *
  * const withoutValue = Optional.none as Optional<number>;
  *
- * assert(Optional.unwrapOr(withValue, 0) === 5);
+ * assert.isTrue(Optional.unwrapOr(withValue, 0) === 5);
  *
- * assert(Optional.unwrapOr(withoutValue, 0) === 0);
+ * assert.isTrue(Optional.unwrapOr(withoutValue, 0) === 0);
  *
  * const unwrapWithDefault = Optional.unwrapOr(10);
  *
- * assert(unwrapWithDefault(Optional.some(3)) === 3);
+ * assert.isTrue(unwrapWithDefault(Optional.some(3)) === 3);
  *
- * assert(unwrapWithDefault(Optional.none) === 10);
+ * assert.isTrue(unwrapWithDefault(Optional.none) === 10);
  * ```
  *
  * @template O The `UnknownOptional` type to unwrap.

package/dist/functional/optional/impl/optional-unwrap-throw.d.mts

@@ -12,7 +12,7 @@ import { type Unwrap } from './types.mjs';
  * ```ts
  * const present = Optional.some('available');
  *
- * assert(Optional.unwrapThrow(present) === 'available');
+ * assert.isTrue(Optional.unwrapThrow(present) === 'available');
  *
  * assert.throws(
  *   () => Optional.unwrapThrow(Optional.none),

package/dist/functional/optional/impl/optional-unwrap-throw.mjs

@@ -13,7 +13,7 @@ import { isSome } from './optional-is-some.mjs';
  * ```ts
  * const present = Optional.some('available');
  *
- * assert(Optional.unwrapThrow(present) === 'available');
+ * assert.isTrue(Optional.unwrapThrow(present) === 'available');
  *
  * assert.throws(
  *   () => Optional.unwrapThrow(Optional.none),

package/dist/functional/optional/impl/optional-unwrap.d.mts

@@ -16,9 +16,9 @@ import { type Unwrap } from './types.mjs';
  *
  * const noneString = Optional.none as Optional<string>;
  *
- * assert(Optional.unwrap(someString) === 'text');
+ * assert.isTrue(Optional.unwrap(someString) === 'text');
  *
- * assert(Optional.unwrap(noneString) === undefined);
+ * assert.isTrue(Optional.unwrap(noneString) === undefined);
  * ```
  *
  * @template O The `UnknownOptional` type to unwrap.

package/dist/functional/optional/impl/optional-zip.d.mts

@@ -7,7 +7,7 @@
  * ```ts
  * const zipped = Optional.zip(Optional.some('left'), Optional.some(1));
  *
- * assert.ok(Optional.isSome(zipped));
+ * assert.isTrue(Optional.isSome(zipped));
  *
  * if (Optional.isSome(zipped)) {
  *   const expected: readonly [string, number] = ['left', 1];

package/dist/functional/optional/impl/optional-zip.mjs

@@ -11,7 +11,7 @@ import { some } from './optional-some.mjs';
  * ```ts
  * const zipped = Optional.zip(Optional.some('left'), Optional.some(1));
  *
- * assert.ok(Optional.isSome(zipped));
+ * assert.isTrue(Optional.isSome(zipped));
  *
  * if (Optional.isSome(zipped)) {
  *   const expected: readonly [string, number] = ['left', 1];

package/dist/functional/pipe.d.mts

@@ -65,7 +65,7 @@ type PipeBase<A> = Readonly<{
      *   value.toUpperCase(),
      * );
      *
-     * assert(empty.value === undefined);
+     * assert.isTrue(empty.value === undefined);
      * ```
      *
      * @template B The type of the transformed value.
@@ -100,7 +100,7 @@ type PipeWithMapOptional<A extends UnknownOptional> = MergeIntersection<PipeBase
      *   (value) => value * 2,
      * );
      *
-     * assert.ok(Optional.isNone(empty.value));
+     * assert.isTrue(Optional.isNone(empty.value));
      * ```
      *
      * @template B The type of the transformed inner value.

package/dist/functional/result/impl/result-err.d.mts

@@ -16,7 +16,7 @@
  *   value: { id: 1 },
  * });
  *
- * assert.ok(Result.isErr(failure));
+ * assert.isTrue(Result.isErr(failure));
  * ```
  *
  * @template E The type of the error value.

package/dist/functional/result/impl/result-err.mjs

@@ -18,7 +18,7 @@ import { ErrTypeTagName } from './tag.mjs';
  *   value: { id: 1 },
  * });
  *
- * assert.ok(Result.isErr(failure));
+ * assert.isTrue(Result.isErr(failure));
  * ```
  *
  * @template E The type of the error value.

package/dist/functional/result/impl/result-expect-to-be.d.mts

@@ -8,13 +8,13 @@ import { type UnwrapOk } from './types.mjs';
  * ```ts
  * const okValue = Result.ok('data');
  *
- * assert(Result.expectToBe(okValue, 'should have value') === 'data');
+ * assert.isTrue(Result.expectToBe(okValue, 'should have value') === 'data');
  *
  * const expectResult = Result.expectToBe<string>('missing result');
  *
  * assert.throws(() => expectResult(Result.err('boom')), /missing result/u);
  *
- * assert(expectResult(Result.ok('value')) === 'value');
+ * assert.isTrue(expectResult(Result.ok('value')) === 'value');
  * ```
  *
  * @template R The `UnknownResult` type to unwrap.

package/dist/functional/result/impl/result-from-promise.d.mts

@@ -23,7 +23,7 @@ type UnwrapPromise<P extends Promise<unknown>> = P extends Promise<infer V> ? V
  *
  * assert.deepStrictEqual(resolved, Result.ok('ok'));
  *
- * assert.ok(Result.isErr(rejected));
+ * assert.isTrue(Result.isErr(rejected));
  * ```
  *
  * @template P The type of the input Promise.

package/dist/functional/result/impl/result-from-promise.mjs

@@ -20,7 +20,7 @@ import { ok } from './result-ok.mjs';
  *
  * assert.deepStrictEqual(resolved, Result.ok('ok'));
  *
- * assert.ok(Result.isErr(rejected));
+ * assert.isTrue(Result.isErr(rejected));
  * ```
  *
  * @template P The type of the input Promise.

package/dist/functional/result/impl/result-from-throwable.d.mts

@@ -19,7 +19,7 @@
  *
  * assert.deepStrictEqual(success, Result.ok(2));
  *
- * assert.ok(Result.isErr(failure));
+ * assert.isTrue(Result.isErr(failure));
  * ```
  *
  * @template T The return type of the function.

package/dist/functional/result/impl/result-from-throwable.mjs

@@ -24,7 +24,7 @@ import { ok } from './result-ok.mjs';
  *
  * assert.deepStrictEqual(success, Result.ok(2));
  *
- * assert.ok(Result.isErr(failure));
+ * assert.isTrue(Result.isErr(failure));
  * ```
  *
  * @template T The return type of the function.

package/dist/functional/result/impl/result-is-err.d.mts

@@ -12,10 +12,10 @@ import { type NarrowToErr } from './types.mjs';
  * if (Result.isOk(operation)) {
  *   const value: number = operation.value;
  *
- *   assert(value === 3);
+ *   assert.isTrue(value === 3);
  * }
  *
- * assert.ok(Result.isErr(failure));
+ * assert.isTrue(Result.isErr(failure));
  * ```
  */
 export declare const isErr: <R extends UnknownResult>(result: R) => result is NarrowToErr<R>;

package/dist/functional/result/impl/result-is-err.mjs

@@ -13,10 +13,10 @@ import { ErrTypeTagName } from './tag.mjs';
  * if (Result.isOk(operation)) {
  *   const value: number = operation.value;
  *
- *   assert(value === 3);
+ *   assert.isTrue(value === 3);
  * }
  *
- * assert.ok(Result.isErr(failure));
+ * assert.isTrue(Result.isErr(failure));
  * ```
  */
 const isErr = (result) => result.$$tag === ErrTypeTagName;

package/dist/functional/result/impl/result-is-ok.d.mts

@@ -12,10 +12,10 @@ import { type NarrowToOk } from './types.mjs';
  * if (Result.isOk(operation)) {
  *   const value: number = operation.value;
  *
- *   assert(value === 3);
+ *   assert.isTrue(value === 3);
  * }
  *
- * assert.ok(Result.isErr(failure));
+ * assert.isTrue(Result.isErr(failure));
  * ```
  */
 export declare const isOk: <R extends UnknownResult>(result: R) => result is NarrowToOk<R>;

package/dist/functional/result/impl/result-is-ok.mjs

@@ -13,10 +13,10 @@ import { OkTypeTagName } from './tag.mjs';
  * if (Result.isOk(operation)) {
  *   const value: number = operation.value;
  *
- *   assert(value === 3);
+ *   assert.isTrue(value === 3);
  * }
  *
- * assert.ok(Result.isErr(failure));
+ * assert.isTrue(Result.isErr(failure));
  * ```
  */
 const isOk = (result) => result.$$tag === OkTypeTagName;

package/dist/functional/result/impl/result-is-result.d.mts

@@ -10,11 +10,11 @@
  *
  * const notResult = { $$tag: 'ts-data-forge::Result.ok' };
  *
- * assert.ok(Result.isResult(okValue));
+ * assert.isTrue(Result.isResult(okValue));
  *
- * assert.ok(Result.isResult(errValue));
+ * assert.isTrue(Result.isResult(errValue));
  *
- * assert.notOk(Result.isResult(notResult));
+ * assert.isFalse(Result.isResult(notResult));
  * ```
  */
 export declare const isResult: (maybeResult: unknown) => maybeResult is UnknownResult;

package/dist/functional/result/impl/result-is-result.mjs

@@ -14,11 +14,11 @@ import { ErrTypeTagName, OkTypeTagName } from './tag.mjs';
  *
  * const notResult = { $$tag: 'ts-data-forge::Result.ok' };
  *
- * assert.ok(Result.isResult(okValue));
+ * assert.isTrue(Result.isResult(okValue));
  *
- * assert.ok(Result.isResult(errValue));
+ * assert.isTrue(Result.isResult(errValue));
  *
- * assert.notOk(Result.isResult(notResult));
+ * assert.isFalse(Result.isResult(notResult));
  * ```
  */
 const isResult = (maybeResult) => isRecord(maybeResult) &&

package/dist/functional/result/impl/result-ok.d.mts

@@ -16,7 +16,7 @@
  *   value: { id: 1 },
  * });
  *
- * assert.ok(Result.isErr(failure));
+ * assert.isTrue(Result.isErr(failure));
  * ```
  *
  * @template S The type of the success value.

package/dist/functional/result/impl/result-ok.mjs

@@ -18,7 +18,7 @@ import { OkTypeTagName } from './tag.mjs';
  *   value: { id: 1 },
  * });
  *
- * assert.ok(Result.isErr(failure));
+ * assert.isTrue(Result.isErr(failure));
  * ```
  *
  * @template S The type of the success value.