ts-data-forge 5.1.0 → 5.1.1

package/dist/array/impl/array-utils-validation.mjs

@@ -39,9 +39,9 @@ import '../../number/refined-number-utils.mjs';
  *
  * const maybeValue: unknown = 'Ada';
  *
- * assert.ok(Arr.isArray(maybeArray));
+ * assert.isTrue(Arr.isArray(maybeArray));
  *
- * assert.notOk(Arr.isArray(maybeValue));
+ * assert.isFalse(Arr.isArray(maybeValue));
  *
  * if (Arr.isArray(maybeArray)) {
  *   assert.deepStrictEqual(maybeArray, [1, 2, 3]);
@@ -60,9 +60,9 @@ const isArray = (value) => Array.isArray(value);
  *
  * const words = ['Ada', 'Lovelace'] as const;
  *
- * assert.ok(Arr.isEmpty(emptyNumbers));
+ * assert.isTrue(Arr.isEmpty(emptyNumbers));
  *
- * assert.notOk(Arr.isEmpty(words));
+ * assert.isFalse(Arr.isEmpty(words));
  *
  * if (Arr.isEmpty(emptyNumbers)) {
  *   assert.deepStrictEqual(emptyNumbers, []);
@@ -80,9 +80,9 @@ const isEmpty = (array) => array.length === 0;
  *
  * const emptyUsers: readonly { id: number }[] = [];
  *
- * assert.ok(Arr.isNonEmpty(users));
+ * assert.isTrue(Arr.isNonEmpty(users));
  *
- * assert.notOk(Arr.isNonEmpty(emptyUsers));
+ * assert.isFalse(Arr.isNonEmpty(emptyUsers));
  *
  * if (Arr.isNonEmpty(users)) {
  *   assert.deepStrictEqual(users[0], { id: 1 });
@@ -100,9 +100,9 @@ const isNonEmpty = (array) => array.length > 0;
  *
  * const triple: readonly number[] = [1, 2, 3];
  *
- * assert.ok(Arr.isArrayOfLength(pair, 2));
+ * assert.isTrue(Arr.isArrayOfLength(pair, 2));
  *
- * assert.notOk(Arr.isArrayOfLength(triple, 2));
+ * assert.isFalse(Arr.isArrayOfLength(triple, 2));
  *
  * if (Arr.isArrayOfLength(pair, 2)) {
  *   assert.deepStrictEqual(pair, [1, 2]);
@@ -120,12 +120,12 @@ const isArrayOfLength = (array, len) => array.length === len;
  *
  * const emptyQueue: readonly string[] = [];
  *
- * assert.ok(Arr.isArrayAtLeastLength(queue, 1));
+ * assert.isTrue(Arr.isArrayAtLeastLength(queue, 1));
  *
- * assert.notOk(Arr.isArrayAtLeastLength(emptyQueue, 1));
+ * assert.isFalse(Arr.isArrayAtLeastLength(emptyQueue, 1));
  *
  * if (Arr.isArrayAtLeastLength(queue, 1)) {
- *   assert(queue[0] === 'task-1');
+ *   assert.isTrue(queue[0] === 'task-1');
  * }
  * ```
  */
@@ -162,12 +162,12 @@ function some(...args) {
  * ```ts
  * const items = ['Ada', 'Grace', 'Katherine'] as const;
  *
- * assert.ok(Arr.indexIsInRange(items, 1));
+ * assert.isTrue(Arr.indexIsInRange(items, 1));
  *
- * assert.notOk(Arr.indexIsInRange(items, 3));
+ * assert.isFalse(Arr.indexIsInRange(items, 3));
  *
  * if (Arr.indexIsInRange(items, 2)) {
- *   assert(items[2] === 'Katherine');
+ *   assert.isTrue(items[2] === 'Katherine');
  * }
  * ```
  */

package/dist/collections/imap.d.mts

@@ -38,7 +38,7 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
      *
      * const map = IMap.create(entries);
      *
-     * assert(map.size === 2);
+     * assert.isTrue(map.size === 2);
      * ```
      */
     size: SizeType.Arr;
@@ -54,9 +54,9 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
      *   ['enabled', true],
      * ]);
      *
-     * assert.ok(map.has('id'));
+     * assert.isTrue(map.has('id'));
      *
-     * assert.notOk(map.has('missing'));
+     * assert.isFalse(map.has('missing'));
      * ```
      *
      * @param key The key to check.
@@ -96,9 +96,9 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
      *
      * const isNarrowed = map.every((value): value is 2 | 4 => value % 2 === 0);
      *
-     * assert.ok(allEven);
+     * assert.isTrue(allEven);
      *
-     * assert.ok(isNarrowed);
+     * assert.isTrue(isNarrowed);
      * ```
      *
      * @param predicate A function to test each key-value pair.
@@ -128,9 +128,9 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
      *
      * const map = IMap.create(entries);
      *
-     * assert.ok(map.some((value) => value > 4));
+     * assert.isTrue(map.some((value) => value > 4));
      *
-     * assert.notOk(map.some((value) => value > 10));
+     * assert.isFalse(map.some((value) => value > 10));
      * ```
      *
      * @param predicate A function to test each key-value pair.
@@ -155,9 +155,9 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
      *
      * assert.deepStrictEqual(withoutB.get('b'), Optional.none);
      *
-     * assert(original.size === 2);
+     * assert.isTrue(original.size === 2);
      *
-     * assert(withoutB.size === 1);
+     * assert.isTrue(withoutB.size === 1);
      * ```
      *
      * @param key The key to delete.
@@ -214,7 +214,7 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
      *
      * assert.deepStrictEqual(scores.get('alice'), Optional.some(10));
      *
-     * assert(unchanged === scores);
+     * assert.isTrue(unchanged === scores);
      * ```
      *
      * @param key The key whose value to update.
@@ -538,9 +538,9 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
      *
      * const raw = map.toRawMap();
      *
-     * assert.ok(is.map(raw));
+     * assert.isTrue(is.map(raw));
      *
-     * assert(raw.get('key') === 1);
+     * assert.isTrue(raw.get('key') === 1);
      * ```
      *
      * @returns The raw ReadonlyMap instance.
@@ -593,7 +593,7 @@ export declare namespace IMap {
      *   ['status', 'active'],
      * ]);
      *
-     * assert(map.size === 2);
+     * assert.isTrue(map.size === 2);
      *
      * assert.deepStrictEqual(map.get('status'), Optional.some('active'));
      * ```
@@ -633,9 +633,9 @@ export declare namespace IMap {
      *   ['b', 3],
      * ]);
      *
-     * assert.ok(IMap.equal(first, second));
+     * assert.isTrue(IMap.equal(first, second));
      *
-     * assert.notOk(IMap.equal(first, third));
+     * assert.isFalse(IMap.equal(first, third));
      * ```
      *
      * @template K The type of the keys.

package/dist/collections/imap.mjs

@@ -57,7 +57,7 @@ var IMap;
      *   ['status', 'active'],
      * ]);
      *
-     * assert(map.size === 2);
+     * assert.isTrue(map.size === 2);
      *
      * assert.deepStrictEqual(map.get('status'), Optional.some('active'));
      * ```
@@ -97,9 +97,9 @@ var IMap;
      *   ['b', 3],
      * ]);
      *
-     * assert.ok(IMap.equal(first, second));
+     * assert.isTrue(IMap.equal(first, second));
      *
-     * assert.notOk(IMap.equal(first, third));
+     * assert.isFalse(IMap.equal(first, third));
      * ```
      *
      * @template K The type of the keys.

package/dist/collections/iset-mapped.d.mts

@@ -59,7 +59,7 @@ type ISetMappedInterface<K, KM extends MapSetKeyType> = Readonly<{
      *
      * const set = ISetMapped.create<Point, string>(points, toKey, fromKey);
      *
-     * assert(set.size === 2);
+     * assert.isTrue(set.size === 2);
      * ```
      */
     size: SizeType.Arr;
@@ -84,9 +84,9 @@ type ISetMappedInterface<K, KM extends MapSetKeyType> = Readonly<{
      *   fromKey,
      * );
      *
-     * assert.ok(empty.isEmpty);
+     * assert.isTrue(empty.isEmpty);
      *
-     * assert.notOk(points.isEmpty);
+     * assert.isFalse(points.isEmpty);
      * ```
      */
     isEmpty: boolean;
@@ -109,9 +109,9 @@ type ISetMappedInterface<K, KM extends MapSetKeyType> = Readonly<{
      *   fromKey,
      * );
      *
-     * assert.ok(set.has({ x: 1, tag: 'a' }));
+     * assert.isTrue(set.has({ x: 1, tag: 'a' }));
      *
-     * assert.notOk(set.has({ x: 2, tag: 'b' }));
+     * assert.isFalse(set.has({ x: 2, tag: 'b' }));
      * ```
      *
      * @param key The element to check.
@@ -146,9 +146,9 @@ type ISetMappedInterface<K, KM extends MapSetKeyType> = Readonly<{
      *   (point): point is Readonly<{ x: 2 | 4; tag: 'even' }> => point.x % 2 === 0,
      * );
      *
-     * assert.ok(allEven);
+     * assert.isTrue(allEven);
      *
-     * assert.ok(narrowed);
+     * assert.isTrue(narrowed);
      * ```
      *
      * @param predicate A function to test each element.
@@ -187,9 +187,9 @@ type ISetMappedInterface<K, KM extends MapSetKeyType> = Readonly<{
      *   fromKey,
      * );
      *
-     * assert.ok(set.some((point) => point.x > 4));
+     * assert.isTrue(set.some((point) => point.x > 4));
      *
-     * assert.notOk(set.some((point) => point.x > 10));
+     * assert.isFalse(set.some((point) => point.x > 10));
      * ```
      *
      * @param predicate A function to test each element.
@@ -225,7 +225,7 @@ type ISetMappedInterface<K, KM extends MapSetKeyType> = Readonly<{
      *   { x: 2, tag: 'b' },
      * ]);
      *
-     * assert(unchanged === base);
+     * assert.isTrue(unchanged === base);
      * ```
      *
      * @param key The element to add.
@@ -260,7 +260,7 @@ type ISetMappedInterface<K, KM extends MapSetKeyType> = Readonly<{
      *
      * assert.deepStrictEqual(Array.from(withoutSecond), [{ x: 1, tag: 'a' }]);
      *
-     * assert(unchanged === base);
+     * assert.isTrue(unchanged === base);
      * ```
      *
      * @param key The element to delete.
@@ -490,9 +490,9 @@ type ISetMappedInterface<K, KM extends MapSetKeyType> = Readonly<{
      *   fromKey,
      * );
      *
-     * assert.ok(subset.isSubsetOf(superset));
+     * assert.isTrue(subset.isSubsetOf(superset));
      *
-     * assert.notOk(superset.isSubsetOf(subset));
+     * assert.isFalse(superset.isSubsetOf(subset));
      * ```
      *
      * @param set The other set.
@@ -528,9 +528,9 @@ type ISetMappedInterface<K, KM extends MapSetKeyType> = Readonly<{
      *   fromKey,
      * );
      *
-     * assert.ok(superset.isSupersetOf(subset));
+     * assert.isTrue(superset.isSupersetOf(subset));
      *
-     * assert.notOk(subset.isSupersetOf(superset));
+     * assert.isFalse(subset.isSupersetOf(superset));
      * ```
      *
      * @param set The other set.
@@ -806,9 +806,9 @@ type ISetMappedInterface<K, KM extends MapSetKeyType> = Readonly<{
      *
      * const raw = set.toRawSet();
      *
-     * assert.ok(is.set(raw));
+     * assert.isTrue(is.set(raw));
      *
-     * assert.ok(raw.has(toKey({ x: 1, tag: 'a' })));
+     * assert.isTrue(raw.has(toKey({ x: 1, tag: 'a' })));
      * ```
      *
      * @returns The raw ReadonlySet instance.
@@ -943,9 +943,9 @@ export declare namespace ISetMapped {
      *   fromKey,
      * );
      *
-     * assert.ok(ISetMapped.equal(first, second));
+     * assert.isTrue(ISetMapped.equal(first, second));
      *
-     * assert.notOk(ISetMapped.equal(first, third));
+     * assert.isFalse(ISetMapped.equal(first, third));
      * ```
      *
      * @template K The type of the custom elements.

package/dist/collections/iset-mapped.mjs

@@ -127,9 +127,9 @@ var ISetMapped;
      *   fromKey,
      * );
      *
-     * assert.ok(ISetMapped.equal(first, second));
+     * assert.isTrue(ISetMapped.equal(first, second));
      *
-     * assert.notOk(ISetMapped.equal(first, third));
+     * assert.isFalse(ISetMapped.equal(first, third));
      * ```
      *
      * @template K The type of the custom elements.

package/dist/collections/iset.d.mts

@@ -33,7 +33,7 @@ type ISetInterface<K extends MapSetKeyType> = Readonly<{
      * ```ts
      * const set = ISet.create([1, 2, 3]);
      *
-     * assert(set.size === 3);
+     * assert.isTrue(set.size === 3);
      * ```
      */
     size: SizeType.Arr;
@@ -47,9 +47,9 @@ type ISetInterface<K extends MapSetKeyType> = Readonly<{
      *
      * const filledSet = ISet.create([1, 2]);
      *
-     * assert.ok(emptySet.isEmpty);
+     * assert.isTrue(emptySet.isEmpty);
      *
-     * assert.notOk(filledSet.isEmpty);
+     * assert.isFalse(filledSet.isEmpty);
      * ```
      */
     isEmpty: boolean;
@@ -62,9 +62,9 @@ type ISetInterface<K extends MapSetKeyType> = Readonly<{
      * ```ts
      * const set = ISet.create(['apple', 'banana']);
      *
-     * assert.ok(set.has('apple'));
+     * assert.isTrue(set.has('apple'));
      *
-     * assert.notOk(set.has('cherry'));
+     * assert.isFalse(set.has('cherry'));
      * ```
      *
      * @param key The element to check.
@@ -83,9 +83,9 @@ type ISetInterface<K extends MapSetKeyType> = Readonly<{
      *
      * const narrowed = numbers.every((value): value is 2 | 4 | 6 => value % 2 === 0);
      *
-     * assert.ok(allEven);
+     * assert.isTrue(allEven);
      *
-     * assert.ok(narrowed);
+     * assert.isTrue(narrowed);
      * ```
      *
      * @param predicate A function to test each element.
@@ -110,9 +110,9 @@ type ISetInterface<K extends MapSetKeyType> = Readonly<{
      * ```ts
      * const numbers = ISet.create([1, 3, 5]);
      *
-     * assert.ok(numbers.some((value) => value > 4));
+     * assert.isTrue(numbers.some((value) => value > 4));
      *
-     * assert.notOk(numbers.some((value) => value > 10));
+     * assert.isFalse(numbers.some((value) => value > 10));
      * ```
      *
      * @param predicate A function to test each element.
@@ -134,7 +134,7 @@ type ISetInterface<K extends MapSetKeyType> = Readonly<{
      *
      * assert.deepStrictEqual(Array.from(withThree), [1, 2, 3]);
      *
-     * assert(unchanged === base);
+     * assert.isTrue(unchanged === base);
      * ```
      *
      * @param key The element to add.
@@ -155,7 +155,7 @@ type ISetInterface<K extends MapSetKeyType> = Readonly<{
      *
      * assert.deepStrictEqual(Array.from(withoutTwo), [1, 3]);
      *
-     * assert(unchanged === base);
+     * assert.isTrue(unchanged === base);
      * ```
      *
      * @param key The element to delete.
@@ -273,9 +273,9 @@ type ISetInterface<K extends MapSetKeyType> = Readonly<{
      *
      * const superset = ISet.create<number>([1, 2, 3]);
      *
-     * assert.ok(subset.isSubsetOf(superset));
+     * assert.isTrue(subset.isSubsetOf(superset));
      *
-     * assert.notOk(superset.isSubsetOf(subset));
+     * assert.isFalse(superset.isSubsetOf(subset));
      * ```
      *
      * @param set The other set.
@@ -293,9 +293,9 @@ type ISetInterface<K extends MapSetKeyType> = Readonly<{
      *
      * const subset = ISet.create<string>(['a', 'c']);
      *
-     * assert.ok(superset.isSupersetOf(subset));
+     * assert.isTrue(superset.isSupersetOf(subset));
      *
-     * assert.notOk(subset.isSupersetOf(superset));
+     * assert.isFalse(subset.isSupersetOf(superset));
      * ```
      *
      * @param set The other set.
@@ -458,9 +458,9 @@ type ISetInterface<K extends MapSetKeyType> = Readonly<{
      *
      * const raw = set.toRawSet();
      *
-     * assert.ok(is.set(raw));
+     * assert.isTrue(is.set(raw));
      *
-     * assert.ok(raw.has('alpha'));
+     * assert.isTrue(raw.has('alpha'));
      * ```
      *
      * @returns The raw ReadonlySet instance.
@@ -540,9 +540,9 @@ export declare namespace ISet {
      *
      * const third = ISet.create<number>([1, 3]);
      *
-     * assert.ok(ISet.equal(first, second));
+     * assert.isTrue(ISet.equal(first, second));
      *
-     * assert.notOk(ISet.equal(first, third));
+     * assert.isFalse(ISet.equal(first, third));
      * ```
      *
      * @template K The type of the elements.

package/dist/collections/iset.mjs

@@ -77,9 +77,9 @@ var ISet;
      *
      * const third = ISet.create<number>([1, 3]);
      *
-     * assert.ok(ISet.equal(first, second));
+     * assert.isTrue(ISet.equal(first, second));
      *
-     * assert.notOk(ISet.equal(first, third));
+     * assert.isFalse(ISet.equal(first, third));
      * ```
      *
      * @template K The type of the elements.

package/dist/collections/queue.d.mts

@@ -40,17 +40,17 @@ export type Queue<T> = Readonly<{
      * ```ts
      * const queue = createQueue<number>();
      *
-     * assert.ok(queue.isEmpty);
+     * assert.isTrue(queue.isEmpty);
      *
-     * assert(queue.size === 0);
+     * assert.isTrue(queue.size === 0);
      *
      * queue.enqueue(1);
      *
      * queue.enqueue(2);
      *
-     * assert.notOk(queue.isEmpty);
+     * assert.isFalse(queue.isEmpty);
      *
-     * assert(queue.size === 2);
+     * assert.isTrue(queue.size === 2);
      *
      * assert.deepStrictEqual(queue.dequeue(), Optional.some(1));
      *
@@ -60,7 +60,7 @@ export type Queue<T> = Readonly<{
      *
      * const seededQueue = createQueue(['first', 'second']);
      *
-     * assert(seededQueue.size === 2);
+     * assert.isTrue(seededQueue.size === 2);
      *
      * assert.deepStrictEqual(seededQueue.dequeue(), Optional.some('first'));
      *
@@ -76,17 +76,17 @@ export type Queue<T> = Readonly<{
      * ```ts
      * const queue = createQueue<number>();
      *
-     * assert.ok(queue.isEmpty);
+     * assert.isTrue(queue.isEmpty);
      *
-     * assert(queue.size === 0);
+     * assert.isTrue(queue.size === 0);
      *
      * queue.enqueue(1);
      *
      * queue.enqueue(2);
      *
-     * assert.notOk(queue.isEmpty);
+     * assert.isFalse(queue.isEmpty);
      *
-     * assert(queue.size === 2);
+     * assert.isTrue(queue.size === 2);
      *
      * assert.deepStrictEqual(queue.dequeue(), Optional.some(1));
      *
@@ -96,7 +96,7 @@ export type Queue<T> = Readonly<{
      *
      * const seededQueue = createQueue(['first', 'second']);
      *
-     * assert(seededQueue.size === 2);
+     * assert.isTrue(seededQueue.size === 2);
      *
      * assert.deepStrictEqual(seededQueue.dequeue(), Optional.some('first'));
      *
@@ -112,17 +112,17 @@ export type Queue<T> = Readonly<{
      * ```ts
      * const queue = createQueue<number>();
      *
-     * assert.ok(queue.isEmpty);
+     * assert.isTrue(queue.isEmpty);
      *
-     * assert(queue.size === 0);
+     * assert.isTrue(queue.size === 0);
      *
      * queue.enqueue(1);
      *
      * queue.enqueue(2);
      *
-     * assert.notOk(queue.isEmpty);
+     * assert.isFalse(queue.isEmpty);
      *
-     * assert(queue.size === 2);
+     * assert.isTrue(queue.size === 2);
      *
      * assert.deepStrictEqual(queue.dequeue(), Optional.some(1));
      *
@@ -132,7 +132,7 @@ export type Queue<T> = Readonly<{
      *
      * const seededQueue = createQueue(['first', 'second']);
      *
-     * assert(seededQueue.size === 2);
+     * assert.isTrue(seededQueue.size === 2);
      *
      * assert.deepStrictEqual(seededQueue.dequeue(), Optional.some('first'));
      *
@@ -151,17 +151,17 @@ export type Queue<T> = Readonly<{
      * ```ts
      * const queue = createQueue<number>();
      *
-     * assert.ok(queue.isEmpty);
+     * assert.isTrue(queue.isEmpty);
      *
-     * assert(queue.size === 0);
+     * assert.isTrue(queue.size === 0);
      *
      * queue.enqueue(1);
      *
      * queue.enqueue(2);
      *
-     * assert.notOk(queue.isEmpty);
+     * assert.isFalse(queue.isEmpty);
      *
-     * assert(queue.size === 2);
+     * assert.isTrue(queue.size === 2);
      *
      * assert.deepStrictEqual(queue.dequeue(), Optional.some(1));
      *
@@ -171,7 +171,7 @@ export type Queue<T> = Readonly<{
      *
      * const seededQueue = createQueue(['first', 'second']);
      *
-     * assert(seededQueue.size === 2);
+     * assert.isTrue(seededQueue.size === 2);
      *
      * assert.deepStrictEqual(seededQueue.dequeue(), Optional.some('first'));
      *
@@ -211,17 +211,17 @@ export type Queue<T> = Readonly<{
  * ```ts
  * const queue = createQueue<number>();
  *
- * assert.ok(queue.isEmpty);
+ * assert.isTrue(queue.isEmpty);
  *
- * assert(queue.size === 0);
+ * assert.isTrue(queue.size === 0);
  *
  * queue.enqueue(1);
  *
  * queue.enqueue(2);
  *
- * assert.notOk(queue.isEmpty);
+ * assert.isFalse(queue.isEmpty);
  *
- * assert(queue.size === 2);
+ * assert.isTrue(queue.size === 2);
  *
  * assert.deepStrictEqual(queue.dequeue(), Optional.some(1));
  *
@@ -231,7 +231,7 @@ export type Queue<T> = Readonly<{
  *
  * const seededQueue = createQueue(['first', 'second']);
  *
- * assert(seededQueue.size === 2);
+ * assert.isTrue(seededQueue.size === 2);
  *
  * assert.deepStrictEqual(seededQueue.dequeue(), Optional.some('first'));
  *

package/dist/collections/queue.mjs

@@ -183,17 +183,17 @@ class QueueClass {
  * ```ts
  * const queue = createQueue<number>();
  *
- * assert.ok(queue.isEmpty);
+ * assert.isTrue(queue.isEmpty);
  *
- * assert(queue.size === 0);
+ * assert.isTrue(queue.size === 0);
  *
  * queue.enqueue(1);
  *
  * queue.enqueue(2);
  *
- * assert.notOk(queue.isEmpty);
+ * assert.isFalse(queue.isEmpty);
  *
- * assert(queue.size === 2);
+ * assert.isTrue(queue.size === 2);
  *
  * assert.deepStrictEqual(queue.dequeue(), Optional.some(1));
  *
@@ -203,7 +203,7 @@ class QueueClass {
  *
  * const seededQueue = createQueue(['first', 'second']);
  *
- * assert(seededQueue.size === 2);
+ * assert.isTrue(seededQueue.size === 2);
  *
  * assert.deepStrictEqual(seededQueue.dequeue(), Optional.some('first'));
  *