ts-data-forge 5.1.0 → 6.0.0

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

@@ -15,13 +15,13 @@ const { MAX_VALUE, MIN_VALUE, add, castType, clamp, div, is, max: max_, min: min
  * @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.
@@ -36,9 +36,9 @@ const isPositiveSafeInt = is;
  * ```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.
@@ -62,13 +62,13 @@ 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.
@@ -99,7 +99,7 @@ const PositiveSafeInt = {
      *   asPositiveSafeInt(5),
      * );
      *
-     * assert(smallest === 5);
+     * assert.isTrue(smallest === 5);
      * ```
      *
      * @param a The first PositiveSafeInt.
@@ -118,7 +118,7 @@ const PositiveSafeInt = {
      *   asPositiveSafeInt(5),
      * );
      *
-     * assert(largest === 10);
+     * assert.isTrue(largest === 10);
      * ```
      *
      * @param a The first PositiveSafeInt.
@@ -138,11 +138,11 @@ 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.
@@ -161,9 +161,9 @@ 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.
@@ -181,7 +181,7 @@ const PositiveSafeInt = {
      *
      * const power = PositiveSafeInt.pow(base, exponent);
      *
-     * assert(power === 27);
+     * assert.isTrue(power === 27);
      * ```
      *
      * @param a The base PositiveSafeInt.
@@ -200,9 +200,9 @@ 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.
@@ -221,9 +221,9 @@ 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.
@@ -243,9 +243,9 @@ 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.
@@ -269,9 +269,9 @@ const PositiveSafeInt = {
      *   asPositiveSafeInt(50),
      * );
      *
-     * assert(quotient === 6);
+     * assert.isTrue(quotient === 6);
      *
-     * assert(clamped === 1);
+     * assert.isTrue(clamped === 1);
      * ```
      *
      * @param a The dividend PositiveSafeInt.

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

@@ -8,11 +8,11 @@ import { TsDataForgeInternals } from '../refined-number-utils.mjs';
  * @example
  *
  * ```ts
- * assert.ok(isSafeInt(Number.MAX_SAFE_INTEGER));
+ * assert.isTrue(isSafeInt(Number.MAX_SAFE_INTEGER));
  *
- * assert.notOk(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));
+ * assert.isFalse(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));
  *
- * assert.ok(SafeInt.is(Number.MIN_SAFE_INTEGER));
+ * assert.isTrue(SafeInt.is(Number.MIN_SAFE_INTEGER));
  * ```
  *
  * @param value - The value to check
@@ -31,9 +31,9 @@ export declare const isSafeInt: (a: number) => a is SafeInt;
  * ```ts
  * const branded = asSafeInt(123);
  *
- * assert(branded === 123);
+ * assert.isTrue(branded === 123);
  *
- * assert.ok(SafeInt.is(branded));
+ * assert.isTrue(SafeInt.is(branded));
  * ```
  *
  * @param value - The value to cast
@@ -71,11 +71,11 @@ export declare const SafeInt: {
      * @example
      *
      * ```ts
-     * assert.ok(isSafeInt(Number.MAX_SAFE_INTEGER));
+     * assert.isTrue(isSafeInt(Number.MAX_SAFE_INTEGER));
      *
-     * assert.notOk(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));
+     * assert.isFalse(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));
      *
-     * assert.ok(SafeInt.is(Number.MIN_SAFE_INTEGER));
+     * assert.isTrue(SafeInt.is(Number.MIN_SAFE_INTEGER));
      * ```
      *
      * @param value - The value to check
@@ -108,9 +108,9 @@ export declare const SafeInt: {
      *
      * const absolute = SafeInt.abs(negative);
      *
-     * assert(absolute === 900);
+     * assert.isTrue(absolute === 900);
      *
-     * assert.ok(SafeInt.is(absolute));
+     * assert.isTrue(SafeInt.is(absolute));
      * ```
      *
      * @param a - The safe integer value
@@ -125,7 +125,7 @@ export declare const SafeInt: {
      * ```ts
      * const smallest = SafeInt.min(asSafeInt(25), asSafeInt(-14), asSafeInt(99));
      *
-     * assert(smallest === -14);
+     * assert.isTrue(smallest === -14);
      * ```
      *
      * @param values - The safe integers to compare (at least one required)
@@ -140,7 +140,7 @@ export declare const SafeInt: {
      * ```ts
      * const largest = SafeInt.max(asSafeInt(25), asSafeInt(-14), asSafeInt(99));
      *
-     * assert(largest === 99);
+     * assert.isTrue(largest === 99);
      * ```
      *
      * @param values - The safe integers to compare (at least one required)
@@ -159,11 +159,11 @@ export declare const SafeInt: {
      *
      * const belowRange = SafeInt.clamp(-1e20);
      *
-     * assert(aboveRange === Number.MAX_SAFE_INTEGER);
+     * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);
      *
-     * assert(withinRange === 123);
+     * assert.isTrue(withinRange === 123);
      *
-     * assert(belowRange === Number.MIN_SAFE_INTEGER);
+     * assert.isTrue(belowRange === Number.MIN_SAFE_INTEGER);
      * ```
      *
      * @param value The number to clamp.
@@ -186,9 +186,9 @@ export declare const SafeInt: {
      *
      * const randomValue = SafeInt.random(min, max);
      *
-     * assert.ok(SafeInt.is(randomValue));
+     * assert.isTrue(SafeInt.is(randomValue));
      *
-     * assert.ok(randomValue >= -10 && randomValue <= 10);
+     * assert.isTrue(randomValue >= -10 && randomValue <= 10);
      * ```
      *
      * @param min - The minimum value (inclusive)
@@ -208,9 +208,9 @@ export declare const SafeInt: {
      *
      * const power = SafeInt.pow(base, exponent);
      *
-     * assert(power === 243);
+     * assert.isTrue(power === 243);
      *
-     * assert.ok(SafeInt.is(power));
+     * assert.isTrue(SafeInt.is(power));
      * ```
      *
      * @param a The base SafeInt.
@@ -226,9 +226,9 @@ export declare const SafeInt: {
      * ```ts
      * const sum = SafeInt.add(asSafeInt(9), asSafeInt(4));
      *
-     * assert(sum === 13);
+     * assert.isTrue(sum === 13);
      *
-     * assert.ok(SafeInt.is(sum));
+     * assert.isTrue(SafeInt.is(sum));
      * ```
      *
      * @param a The first SafeInt.
@@ -244,9 +244,9 @@ export declare const SafeInt: {
      * ```ts
      * const difference = SafeInt.sub(asSafeInt(9), asSafeInt(14));
      *
-     * assert(difference === -5);
+     * assert.isTrue(difference === -5);
      *
-     * assert.ok(SafeInt.is(difference));
+     * assert.isTrue(SafeInt.is(difference));
      * ```
      *
      * @param a The minuend SafeInt.
@@ -262,9 +262,9 @@ export declare const SafeInt: {
      * ```ts
      * const product = SafeInt.mul(asSafeInt(-8), asSafeInt(7));
      *
-     * assert(product === -56);
+     * assert.isTrue(product === -56);
      *
-     * assert.ok(SafeInt.is(product));
+     * assert.isTrue(SafeInt.is(product));
      * ```
      *
      * @param a The first SafeInt.
@@ -283,9 +283,9 @@ export declare const SafeInt: {
      * ```ts
      * const quotient = SafeInt.div(asSafeInt(-17), asSafeInt(5));
      *
-     * assert(quotient === -4);
+     * assert.isTrue(quotient === -4);
      *
-     * assert.ok(SafeInt.is(quotient));
+     * assert.isTrue(SafeInt.is(quotient));
      * ```
      *
      * @param a - The dividend

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

@@ -18,11 +18,11 @@ const { MAX_VALUE, MIN_VALUE, abs, add, castType, clamp, div, is, max: max_, min
  * @example
  *
  * ```ts
- * assert.ok(isSafeInt(Number.MAX_SAFE_INTEGER));
+ * assert.isTrue(isSafeInt(Number.MAX_SAFE_INTEGER));
  *
- * assert.notOk(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));
+ * assert.isFalse(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));
  *
- * assert.ok(SafeInt.is(Number.MIN_SAFE_INTEGER));
+ * assert.isTrue(SafeInt.is(Number.MIN_SAFE_INTEGER));
  * ```
  *
  * @param value - The value to check
@@ -41,9 +41,9 @@ const isSafeInt = is;
  * ```ts
  * const branded = asSafeInt(123);
  *
- * assert(branded === 123);
+ * assert.isTrue(branded === 123);
  *
- * assert.ok(SafeInt.is(branded));
+ * assert.isTrue(SafeInt.is(branded));
  * ```
  *
  * @param value - The value to cast
@@ -74,11 +74,11 @@ const SafeInt = {
      * @example
      *
      * ```ts
-     * assert.ok(isSafeInt(Number.MAX_SAFE_INTEGER));
+     * assert.isTrue(isSafeInt(Number.MAX_SAFE_INTEGER));
      *
-     * assert.notOk(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));
+     * assert.isFalse(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));
      *
-     * assert.ok(SafeInt.is(Number.MIN_SAFE_INTEGER));
+     * assert.isTrue(SafeInt.is(Number.MIN_SAFE_INTEGER));
      * ```
      *
      * @param value - The value to check
@@ -111,9 +111,9 @@ const SafeInt = {
      *
      * const absolute = SafeInt.abs(negative);
      *
-     * assert(absolute === 900);
+     * assert.isTrue(absolute === 900);
      *
-     * assert.ok(SafeInt.is(absolute));
+     * assert.isTrue(SafeInt.is(absolute));
      * ```
      *
      * @param a - The safe integer value
@@ -128,7 +128,7 @@ const SafeInt = {
      * ```ts
      * const smallest = SafeInt.min(asSafeInt(25), asSafeInt(-14), asSafeInt(99));
      *
-     * assert(smallest === -14);
+     * assert.isTrue(smallest === -14);
      * ```
      *
      * @param values - The safe integers to compare (at least one required)
@@ -143,7 +143,7 @@ const SafeInt = {
      * ```ts
      * const largest = SafeInt.max(asSafeInt(25), asSafeInt(-14), asSafeInt(99));
      *
-     * assert(largest === 99);
+     * assert.isTrue(largest === 99);
      * ```
      *
      * @param values - The safe integers to compare (at least one required)
@@ -162,11 +162,11 @@ const SafeInt = {
      *
      * const belowRange = SafeInt.clamp(-1e20);
      *
-     * assert(aboveRange === Number.MAX_SAFE_INTEGER);
+     * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);
      *
-     * assert(withinRange === 123);
+     * assert.isTrue(withinRange === 123);
      *
-     * assert(belowRange === Number.MIN_SAFE_INTEGER);
+     * assert.isTrue(belowRange === Number.MIN_SAFE_INTEGER);
      * ```
      *
      * @param value The number to clamp.
@@ -189,9 +189,9 @@ const SafeInt = {
      *
      * const randomValue = SafeInt.random(min, max);
      *
-     * assert.ok(SafeInt.is(randomValue));
+     * assert.isTrue(SafeInt.is(randomValue));
      *
-     * assert.ok(randomValue >= -10 && randomValue <= 10);
+     * assert.isTrue(randomValue >= -10 && randomValue <= 10);
      * ```
      *
      * @param min - The minimum value (inclusive)
@@ -211,9 +211,9 @@ const SafeInt = {
      *
      * const power = SafeInt.pow(base, exponent);
      *
-     * assert(power === 243);
+     * assert.isTrue(power === 243);
      *
-     * assert.ok(SafeInt.is(power));
+     * assert.isTrue(SafeInt.is(power));
      * ```
      *
      * @param a The base SafeInt.
@@ -229,9 +229,9 @@ const SafeInt = {
      * ```ts
      * const sum = SafeInt.add(asSafeInt(9), asSafeInt(4));
      *
-     * assert(sum === 13);
+     * assert.isTrue(sum === 13);
      *
-     * assert.ok(SafeInt.is(sum));
+     * assert.isTrue(SafeInt.is(sum));
      * ```
      *
      * @param a The first SafeInt.
@@ -247,9 +247,9 @@ const SafeInt = {
      * ```ts
      * const difference = SafeInt.sub(asSafeInt(9), asSafeInt(14));
      *
-     * assert(difference === -5);
+     * assert.isTrue(difference === -5);
      *
-     * assert.ok(SafeInt.is(difference));
+     * assert.isTrue(SafeInt.is(difference));
      * ```
      *
      * @param a The minuend SafeInt.
@@ -265,9 +265,9 @@ const SafeInt = {
      * ```ts
      * const product = SafeInt.mul(asSafeInt(-8), asSafeInt(7));
      *
-     * assert(product === -56);
+     * assert.isTrue(product === -56);
      *
-     * assert.ok(SafeInt.is(product));
+     * assert.isTrue(SafeInt.is(product));
      * ```
      *
      * @param a The first SafeInt.
@@ -286,9 +286,9 @@ const SafeInt = {
      * ```ts
      * const quotient = SafeInt.div(asSafeInt(-17), asSafeInt(5));
      *
-     * assert(quotient === -4);
+     * assert.isTrue(quotient === -4);
      *
-     * assert.ok(SafeInt.is(quotient));
+     * assert.isTrue(SafeInt.is(quotient));
      * ```
      *
      * @param a - The dividend

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

@@ -4,11 +4,11 @@
  * @example
  *
  * ```ts
- * assert.ok(isUint(4));
+ * assert.isTrue(isUint(4));
  *
- * assert.notOk(isUint(-1));
+ * assert.isFalse(isUint(-1));
  *
- * assert.ok(Uint.is(0));
+ * assert.isTrue(Uint.is(0));
  * ```
  *
  * @param value The value to check.
@@ -23,9 +23,9 @@ export declare const isUint: (a: number) => a is NonNegativeInt;
  * ```ts
  * const branded = asUint(12);
  *
- * assert(branded === 12);
+ * assert.isTrue(branded === 12);
  *
- * assert.ok(Uint.is(branded));
+ * assert.isTrue(Uint.is(branded));
  * ```
  *
  * @param value The value to cast.
@@ -58,11 +58,11 @@ export declare const Uint: {
      * @example
      *
      * ```ts
-     * assert.ok(isUint(4));
+     * assert.isTrue(isUint(4));
      *
-     * assert.notOk(isUint(-1));
+     * assert.isFalse(isUint(-1));
      *
-     * assert.ok(Uint.is(0));
+     * assert.isTrue(Uint.is(0));
      * ```
      *
      * @param value The value to check.
@@ -84,7 +84,7 @@ export declare const Uint: {
      * ```ts
      * const smallest = Uint.min(asUint(7), asUint(3));
      *
-     * assert(smallest === 3);
+     * assert.isTrue(smallest === 3);
      * ```
      *
      * @param a The first Uint.
@@ -100,7 +100,7 @@ export declare const Uint: {
      * ```ts
      * const largest = Uint.max(asUint(7), asUint(3));
      *
-     * assert(largest === 7);
+     * assert.isTrue(largest === 7);
      * ```
      *
      * @param a The first Uint.
@@ -118,9 +118,9 @@ export declare const Uint: {
      *
      * const clampedPositive = Uint.clamp(42);
      *
-     * assert(clampedNegative === 0);
+     * assert.isTrue(clampedNegative === 0);
      *
-     * assert(clampedPositive === 42);
+     * assert.isTrue(clampedPositive === 42);
      * ```
      *
      * @param value The number to clamp.
@@ -139,9 +139,9 @@ export declare const Uint: {
      *
      * const randomValue = Uint.random(min, max);
      *
-     * assert.ok(Uint.is(randomValue));
+     * assert.isTrue(Uint.is(randomValue));
      *
-     * assert.ok(randomValue >= 0 && randomValue <= 3);
+     * assert.isTrue(randomValue >= 0 && randomValue <= 3);
      * ```
      *
      * @returns A random non-negative integer as a Uint.
@@ -159,7 +159,7 @@ export declare const Uint: {
      *
      * const power = Uint.pow(base, exponent);
      *
-     * assert(power === 32);
+     * assert.isTrue(power === 32);
      * ```
      *
      * @param a The base Uint.
@@ -175,7 +175,7 @@ export declare const Uint: {
      * ```ts
      * const sum = Uint.add(asUint(5), asUint(8));
      *
-     * assert(sum === 13);
+     * assert.isTrue(sum === 13);
      * ```
      *
      * @param a The first Uint.
@@ -191,7 +191,7 @@ export declare const Uint: {
      * ```ts
      * const difference = Uint.sub(asUint(5), asUint(8));
      *
-     * assert(difference === 0);
+     * assert.isTrue(difference === 0);
      * ```
      *
      * @param a The minuend Uint.
@@ -207,7 +207,7 @@ export declare const Uint: {
      * ```ts
      * const product = Uint.mul(asUint(7), asUint(6));
      *
-     * assert(product === 42);
+     * assert.isTrue(product === 42);
      * ```
      *
      * @param a The first Uint.
@@ -223,7 +223,7 @@ export declare const Uint: {
      * ```ts
      * const quotient = Uint.div(asUint(10), asUint(4));
      *
-     * assert(quotient === 2);
+     * assert.isTrue(quotient === 2);
      * ```
      *
      * @param a The dividend Uint.