ts-data-forge 5.1.0 → 6.0.0

package/dist/number/branded-types/int.d.mts

@@ -9,11 +9,11 @@ import { TsDataForgeInternals } from '../refined-number-utils.mjs';
  * @example
  *
  * ```ts
- * assert.ok(isInt(5));
+ * assert.isTrue(isInt(5));
  *
- * assert.notOk(isInt(5.25));
+ * assert.isFalse(isInt(5.25));
  *
- * assert.ok(Int.is(-10));
+ * assert.isTrue(Int.is(-10));
  * ```
  *
  * @param value - The value to check
@@ -32,9 +32,9 @@ export declare const isInt: (a: number) => a is Int;
  * ```ts
  * const branded = asInt(42);
  *
- * assert(branded === 42);
+ * assert.isTrue(branded === 42);
  *
- * assert.ok(Int.is(branded));
+ * assert.isTrue(Int.is(branded));
  * ```
  *
  * @param value - The value to cast
@@ -66,11 +66,11 @@ export declare const Int: {
      * @example
      *
      * ```ts
-     * assert.ok(isInt(5));
+     * assert.isTrue(isInt(5));
      *
-     * assert.notOk(isInt(5.25));
+     * assert.isFalse(isInt(5.25));
      *
-     * assert.ok(Int.is(-10));
+     * assert.isTrue(Int.is(-10));
      * ```
      *
      * @param value - The value to check
@@ -92,9 +92,9 @@ export declare const Int: {
      *
      * const absolute = Int.abs(negative);
      *
-     * assert(absolute === 12);
+     * assert.isTrue(absolute === 12);
      *
-     * assert.ok(Int.is(absolute));
+     * assert.isTrue(Int.is(absolute));
      * ```
      *
      * @param a - The integer value
@@ -109,7 +109,7 @@ export declare const Int: {
      * ```ts
      * const smallest = Int.min(asInt(7), asInt(-3), asInt(2));
      *
-     * assert(smallest === -3);
+     * assert.isTrue(smallest === -3);
      * ```
      *
      * @param values - The integers to compare (at least one required)
@@ -124,7 +124,7 @@ export declare const Int: {
      * ```ts
      * const largest = Int.max(asInt(7), asInt(-3), asInt(2));
      *
-     * assert(largest === 7);
+     * assert.isTrue(largest === 7);
      * ```
      *
      * @param values - The integers to compare (at least one required)
@@ -146,9 +146,9 @@ export declare const Int: {
      *
      * const randomValue = Int.random(min, max);
      *
-     * assert.ok(Int.is(randomValue));
+     * assert.isTrue(Int.is(randomValue));
      *
-     * assert.ok(randomValue >= 1 && randomValue <= 6);
+     * assert.isTrue(randomValue >= 1 && randomValue <= 6);
      * ```
      *
      * @param min - The minimum value (inclusive)
@@ -168,7 +168,7 @@ export declare const Int: {
      *
      * const power = Int.pow(base, exponent);
      *
-     * assert(power === 32);
+     * assert.isTrue(power === 32);
      * ```
      *
      * @param a - The base integer
@@ -184,7 +184,7 @@ export declare const Int: {
      * ```ts
      * const sum = Int.add(asInt(12), asInt(8));
      *
-     * assert(sum === 20);
+     * assert.isTrue(sum === 20);
      * ```
      *
      * @param a - First integer
@@ -200,7 +200,7 @@ export declare const Int: {
      * ```ts
      * const difference = Int.sub(asInt(12), asInt(8));
      *
-     * assert(difference === 4);
+     * assert.isTrue(difference === 4);
      * ```
      *
      * @param a - First integer
@@ -216,7 +216,7 @@ export declare const Int: {
      * ```ts
      * const product = Int.mul(asInt(-4), asInt(6));
      *
-     * assert(product === -24);
+     * assert.isTrue(product === -24);
      * ```
      *
      * @param a - First integer
@@ -239,7 +239,7 @@ export declare const Int: {
      *
      * const quotient = Int.div(dividend, divisor);
      *
-     * assert(quotient === 3);
+     * assert.isTrue(quotient === 3);
      * ```
      *
      * @param a - The dividend

package/dist/number/branded-types/int.mjs

@@ -17,11 +17,11 @@ const { abs, add, castType, div, is, max: max_, min: min_, mul, pow, random, sub
  * @example
  *
  * ```ts
- * assert.ok(isInt(5));
+ * assert.isTrue(isInt(5));
  *
- * assert.notOk(isInt(5.25));
+ * assert.isFalse(isInt(5.25));
  *
- * assert.ok(Int.is(-10));
+ * assert.isTrue(Int.is(-10));
  * ```
  *
  * @param value - The value to check
@@ -40,9 +40,9 @@ const isInt = is;
  * ```ts
  * const branded = asInt(42);
  *
- * assert(branded === 42);
+ * assert.isTrue(branded === 42);
  *
- * assert.ok(Int.is(branded));
+ * assert.isTrue(Int.is(branded));
  * ```
  *
  * @param value - The value to cast
@@ -68,11 +68,11 @@ const Int = {
      * @example
      *
      * ```ts
-     * assert.ok(isInt(5));
+     * assert.isTrue(isInt(5));
      *
-     * assert.notOk(isInt(5.25));
+     * assert.isFalse(isInt(5.25));
      *
-     * assert.ok(Int.is(-10));
+     * assert.isTrue(Int.is(-10));
      * ```
      *
      * @param value - The value to check
@@ -94,9 +94,9 @@ const Int = {
      *
      * const absolute = Int.abs(negative);
      *
-     * assert(absolute === 12);
+     * assert.isTrue(absolute === 12);
      *
-     * assert.ok(Int.is(absolute));
+     * assert.isTrue(Int.is(absolute));
      * ```
      *
      * @param a - The integer value
@@ -111,7 +111,7 @@ const Int = {
      * ```ts
      * const smallest = Int.min(asInt(7), asInt(-3), asInt(2));
      *
-     * assert(smallest === -3);
+     * assert.isTrue(smallest === -3);
      * ```
      *
      * @param values - The integers to compare (at least one required)
@@ -126,7 +126,7 @@ const Int = {
      * ```ts
      * const largest = Int.max(asInt(7), asInt(-3), asInt(2));
      *
-     * assert(largest === 7);
+     * assert.isTrue(largest === 7);
      * ```
      *
      * @param values - The integers to compare (at least one required)
@@ -148,9 +148,9 @@ const Int = {
      *
      * const randomValue = Int.random(min, max);
      *
-     * assert.ok(Int.is(randomValue));
+     * assert.isTrue(Int.is(randomValue));
      *
-     * assert.ok(randomValue >= 1 && randomValue <= 6);
+     * assert.isTrue(randomValue >= 1 && randomValue <= 6);
      * ```
      *
      * @param min - The minimum value (inclusive)
@@ -170,7 +170,7 @@ const Int = {
      *
      * const power = Int.pow(base, exponent);
      *
-     * assert(power === 32);
+     * assert.isTrue(power === 32);
      * ```
      *
      * @param a - The base integer
@@ -186,7 +186,7 @@ const Int = {
      * ```ts
      * const sum = Int.add(asInt(12), asInt(8));
      *
-     * assert(sum === 20);
+     * assert.isTrue(sum === 20);
      * ```
      *
      * @param a - First integer
@@ -202,7 +202,7 @@ const Int = {
      * ```ts
      * const difference = Int.sub(asInt(12), asInt(8));
      *
-     * assert(difference === 4);
+     * assert.isTrue(difference === 4);
      * ```
      *
      * @param a - First integer
@@ -218,7 +218,7 @@ const Int = {
      * ```ts
      * const product = Int.mul(asInt(-4), asInt(6));
      *
-     * assert(product === -24);
+     * assert.isTrue(product === -24);
      * ```
      *
      * @param a - First integer
@@ -241,7 +241,7 @@ const Int = {
      *
      * const quotient = Int.div(dividend, divisor);
      *
-     * assert(quotient === 3);
+     * assert.isTrue(quotient === 3);
      * ```
      *
      * @param a - The dividend

package/dist/number/branded-types/positive-int.d.mts

@@ -7,11 +7,11 @@
  * @example
  *
  * ```ts
- * assert.ok(isPositiveInt(5));
+ * assert.isTrue(isPositiveInt(5));
  *
- * assert.notOk(isPositiveInt(0));
+ * assert.isFalse(isPositiveInt(0));
  *
- * assert.ok(PositiveInt.is(10));
+ * assert.isTrue(PositiveInt.is(10));
  * ```
  *
  * @param value - The value to check
@@ -30,9 +30,9 @@ export declare const isPositiveInt: (a: number) => a is PositiveInt;
  * ```ts
  * const branded = asPositiveInt(7);
  *
- * assert(branded === 7);
+ * assert.isTrue(branded === 7);
  *
- * assert.ok(PositiveInt.is(branded));
+ * assert.isTrue(PositiveInt.is(branded));
  * ```
  *
  * @param value - The value to cast
@@ -75,11 +75,11 @@ export declare const PositiveInt: {
      * @example
      *
      * ```ts
-     * assert.ok(isPositiveInt(5));
+     * assert.isTrue(isPositiveInt(5));
      *
-     * assert.notOk(isPositiveInt(0));
+     * assert.isFalse(isPositiveInt(0));
      *
-     * assert.ok(PositiveInt.is(10));
+     * assert.isTrue(PositiveInt.is(10));
      * ```
      *
      * @param value - The value to check
@@ -108,7 +108,7 @@ export declare const PositiveInt: {
      *   asPositiveInt(12),
      * );
      *
-     * assert(smallest === 3);
+     * assert.isTrue(smallest === 3);
      * ```
      *
      * @param values - The positive integers to compare (at least one required)
@@ -127,7 +127,7 @@ export declare const PositiveInt: {
      *   asPositiveInt(12),
      * );
      *
-     * assert(largest === 12);
+     * assert.isTrue(largest === 12);
      * ```
      *
      * @param values - The positive integers to compare (at least one required)
@@ -147,9 +147,9 @@ export declare const PositiveInt: {
      *
      * const withinRange = PositiveInt.clamp(10);
      *
-     * assert(belowRange === 1);
+     * assert.isTrue(belowRange === 1);
      *
-     * assert(withinRange === 10);
+     * assert.isTrue(withinRange === 10);
      * ```
      *
      * @param value - The number to clamp
@@ -171,9 +171,9 @@ export declare const PositiveInt: {
      *
      * const randomValue = PositiveInt.random(min, max);
      *
-     * assert.ok(PositiveInt.is(randomValue));
+     * assert.isTrue(PositiveInt.is(randomValue));
      *
-     * assert.ok(randomValue >= 3 && randomValue <= 6);
+     * assert.isTrue(randomValue >= 3 && randomValue <= 6);
      * ```
      *
      * @param min - The minimum value (inclusive, must be >= 1)
@@ -194,7 +194,7 @@ export declare const PositiveInt: {
      *
      * const power = PositiveInt.pow(base, exponent);
      *
-     * assert(power === 16);
+     * assert.isTrue(power === 16);
      * ```
      *
      * @param a - The base positive integer
@@ -210,7 +210,7 @@ export declare const PositiveInt: {
      * ```ts
      * const sum = PositiveInt.add(asPositiveInt(4), asPositiveInt(5));
      *
-     * assert(sum === 9);
+     * assert.isTrue(sum === 9);
      * ```
      *
      * @param a - First positive integer
@@ -229,7 +229,7 @@ export declare const PositiveInt: {
      * ```ts
      * const difference = PositiveInt.sub(asPositiveInt(5), asPositiveInt(7));
      *
-     * assert(difference === 1);
+     * assert.isTrue(difference === 1);
      * ```
      *
      * @param a - The minuend (positive integer)
@@ -245,7 +245,7 @@ export declare const PositiveInt: {
      * ```ts
      * const product = PositiveInt.mul(asPositiveInt(3), asPositiveInt(7));
      *
-     * assert(product === 21);
+     * assert.isTrue(product === 21);
      * ```
      *
      * @param a - First positive integer
@@ -268,9 +268,9 @@ export declare const PositiveInt: {
      *
      * const clamped = PositiveInt.div(asPositiveInt(3), asPositiveInt(10));
      *
-     * assert(quotient === 4);
+     * assert.isTrue(quotient === 4);
      *
-     * assert(clamped === 1);
+     * assert.isTrue(clamped === 1);
      * ```
      *
      * @param a - The dividend (positive integer)

package/dist/number/branded-types/positive-int.mjs

@@ -16,11 +16,11 @@ const { MIN_VALUE, add, castType, clamp, div, is, max: max_, min: min_, mul, pow
  * @example
  *
  * ```ts
- * assert.ok(isPositiveInt(5));
+ * assert.isTrue(isPositiveInt(5));
  *
- * assert.notOk(isPositiveInt(0));
+ * assert.isFalse(isPositiveInt(0));
  *
- * assert.ok(PositiveInt.is(10));
+ * assert.isTrue(PositiveInt.is(10));
  * ```
  *
  * @param value - The value to check
@@ -39,9 +39,9 @@ const isPositiveInt = is;
  * ```ts
  * const branded = asPositiveInt(7);
  *
- * assert(branded === 7);
+ * assert.isTrue(branded === 7);
  *
- * assert.ok(PositiveInt.is(branded));
+ * assert.isTrue(PositiveInt.is(branded));
  * ```
  *
  * @param value - The value to cast
@@ -72,11 +72,11 @@ const PositiveInt = {
      * @example
      *
      * ```ts
-     * assert.ok(isPositiveInt(5));
+     * assert.isTrue(isPositiveInt(5));
      *
-     * assert.notOk(isPositiveInt(0));
+     * assert.isFalse(isPositiveInt(0));
      *
-     * assert.ok(PositiveInt.is(10));
+     * assert.isTrue(PositiveInt.is(10));
      * ```
      *
      * @param value - The value to check
@@ -105,7 +105,7 @@ const PositiveInt = {
      *   asPositiveInt(12),
      * );
      *
-     * assert(smallest === 3);
+     * assert.isTrue(smallest === 3);
      * ```
      *
      * @param values - The positive integers to compare (at least one required)
@@ -124,7 +124,7 @@ const PositiveInt = {
      *   asPositiveInt(12),
      * );
      *
-     * assert(largest === 12);
+     * assert.isTrue(largest === 12);
      * ```
      *
      * @param values - The positive integers to compare (at least one required)
@@ -144,9 +144,9 @@ const PositiveInt = {
      *
      * const withinRange = PositiveInt.clamp(10);
      *
-     * assert(belowRange === 1);
+     * assert.isTrue(belowRange === 1);
      *
-     * assert(withinRange === 10);
+     * assert.isTrue(withinRange === 10);
      * ```
      *
      * @param value - The number to clamp
@@ -168,9 +168,9 @@ const PositiveInt = {
      *
      * const randomValue = PositiveInt.random(min, max);
      *
-     * assert.ok(PositiveInt.is(randomValue));
+     * assert.isTrue(PositiveInt.is(randomValue));
      *
-     * assert.ok(randomValue >= 3 && randomValue <= 6);
+     * assert.isTrue(randomValue >= 3 && randomValue <= 6);
      * ```
      *
      * @param min - The minimum value (inclusive, must be >= 1)
@@ -191,7 +191,7 @@ const PositiveInt = {
      *
      * const power = PositiveInt.pow(base, exponent);
      *
-     * assert(power === 16);
+     * assert.isTrue(power === 16);
      * ```
      *
      * @param a - The base positive integer
@@ -207,7 +207,7 @@ const PositiveInt = {
      * ```ts
      * const sum = PositiveInt.add(asPositiveInt(4), asPositiveInt(5));
      *
-     * assert(sum === 9);
+     * assert.isTrue(sum === 9);
      * ```
      *
      * @param a - First positive integer
@@ -226,7 +226,7 @@ const PositiveInt = {
      * ```ts
      * const difference = PositiveInt.sub(asPositiveInt(5), asPositiveInt(7));
      *
-     * assert(difference === 1);
+     * assert.isTrue(difference === 1);
      * ```
      *
      * @param a - The minuend (positive integer)
@@ -242,7 +242,7 @@ const PositiveInt = {
      * ```ts
      * const product = PositiveInt.mul(asPositiveInt(3), asPositiveInt(7));
      *
-     * assert(product === 21);
+     * assert.isTrue(product === 21);
      * ```
      *
      * @param a - First positive integer
@@ -265,9 +265,9 @@ const PositiveInt = {
      *
      * const clamped = PositiveInt.div(asPositiveInt(3), asPositiveInt(10));
      *
-     * assert(quotient === 4);
+     * assert.isTrue(quotient === 4);
      *
-     * assert(clamped === 1);
+     * assert.isTrue(clamped === 1);
      * ```
      *
      * @param a - The dividend (positive integer)

package/dist/number/branded-types/positive-safe-int.d.mts

@@ -5,13 +5,13 @@
  * @example
  *
  * ```ts
- * assert.ok(isPositiveSafeInt(1));
+ * assert.isTrue(isPositiveSafeInt(1));
  *
- * assert.ok(isPositiveSafeInt(Number.MAX_SAFE_INTEGER));
+ * assert.isTrue(isPositiveSafeInt(Number.MAX_SAFE_INTEGER));
  *
- * assert.notOk(isPositiveSafeInt(0));
+ * assert.isFalse(isPositiveSafeInt(0));
  *
- * assert.ok(PositiveSafeInt.is(42));
+ * assert.isTrue(PositiveSafeInt.is(42));
  * ```
  *
  * @param value The value to check.
@@ -26,9 +26,9 @@ export declare const isPositiveSafeInt: (a: number) => a is PositiveSafeInt;
  * ```ts
  * const branded = asPositiveSafeInt(128);
  *
- * assert(branded === 128);
+ * assert.isTrue(branded === 128);
  *
- * assert.ok(PositiveSafeInt.is(branded));
+ * assert.isTrue(PositiveSafeInt.is(branded));
  * ```
  *
  * @param value The value to cast.
@@ -65,13 +65,13 @@ export declare const PositiveSafeInt: {
      * @example
      *
      * ```ts
-     * assert.ok(isPositiveSafeInt(1));
+     * assert.isTrue(isPositiveSafeInt(1));
      *
-     * assert.ok(isPositiveSafeInt(Number.MAX_SAFE_INTEGER));
+     * assert.isTrue(isPositiveSafeInt(Number.MAX_SAFE_INTEGER));
      *
-     * assert.notOk(isPositiveSafeInt(0));
+     * assert.isFalse(isPositiveSafeInt(0));
      *
-     * assert.ok(PositiveSafeInt.is(42));
+     * assert.isTrue(PositiveSafeInt.is(42));
      * ```
      *
      * @param value The value to check.
@@ -102,7 +102,7 @@ export declare const PositiveSafeInt: {
      *   asPositiveSafeInt(5),
      * );
      *
-     * assert(smallest === 5);
+     * assert.isTrue(smallest === 5);
      * ```
      *
      * @param a The first PositiveSafeInt.
@@ -121,7 +121,7 @@ export declare const PositiveSafeInt: {
      *   asPositiveSafeInt(5),
      * );
      *
-     * assert(largest === 10);
+     * assert.isTrue(largest === 10);
      * ```
      *
      * @param a The first PositiveSafeInt.
@@ -141,11 +141,11 @@ export declare const PositiveSafeInt: {
      *
      * const aboveRange = PositiveSafeInt.clamp(Number.MAX_SAFE_INTEGER + 10);
      *
-     * assert(belowRange === 1);
+     * assert.isTrue(belowRange === 1);
      *
-     * assert(withinRange === 123);
+     * assert.isTrue(withinRange === 123);
      *
-     * assert(aboveRange === Number.MAX_SAFE_INTEGER);
+     * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);
      * ```
      *
      * @param value The number to clamp.
@@ -164,9 +164,9 @@ export declare const PositiveSafeInt: {
      *
      * const randomValue = PositiveSafeInt.random(min, max);
      *
-     * assert.ok(PositiveSafeInt.is(randomValue));
+     * assert.isTrue(PositiveSafeInt.is(randomValue));
      *
-     * assert.ok(randomValue >= 1 && randomValue <= 6);
+     * assert.isTrue(randomValue >= 1 && randomValue <= 6);
      * ```
      *
      * @returns A random PositiveSafeInt between 1 and MAX_SAFE_INTEGER.
@@ -184,7 +184,7 @@ export declare const PositiveSafeInt: {
      *
      * const power = PositiveSafeInt.pow(base, exponent);
      *
-     * assert(power === 27);
+     * assert.isTrue(power === 27);
      * ```
      *
      * @param a The base PositiveSafeInt.
@@ -203,9 +203,9 @@ export declare const PositiveSafeInt: {
      *   asPositiveSafeInt(2048),
      * );
      *
-     * assert(sum === 3048);
+     * assert.isTrue(sum === 3048);
      *
-     * assert.ok(PositiveSafeInt.is(sum));
+     * assert.isTrue(PositiveSafeInt.is(sum));
      * ```
      *
      * @param a The first PositiveSafeInt.
@@ -224,9 +224,9 @@ export declare const PositiveSafeInt: {
      *   asPositiveSafeInt(20),
      * );
      *
-     * assert(difference === 1);
+     * assert.isTrue(difference === 1);
      *
-     * assert.ok(PositiveSafeInt.is(difference));
+     * assert.isTrue(PositiveSafeInt.is(difference));
      * ```
      *
      * @param a The minuend PositiveSafeInt.
@@ -246,9 +246,9 @@ export declare const PositiveSafeInt: {
      *   asPositiveSafeInt(20),
      * );
      *
-     * assert(product === 1000);
+     * assert.isTrue(product === 1000);
      *
-     * assert.ok(PositiveSafeInt.is(product));
+     * assert.isTrue(PositiveSafeInt.is(product));
      * ```
      *
      * @param a The first PositiveSafeInt.
@@ -272,9 +272,9 @@ export declare const PositiveSafeInt: {
      *   asPositiveSafeInt(50),
      * );
      *
-     * assert(quotient === 6);
+     * assert.isTrue(quotient === 6);
      *
-     * assert(clamped === 1);
+     * assert.isTrue(clamped === 1);
      * ```
      *
      * @param a The dividend PositiveSafeInt.