ts-data-forge 6.13.0 → 7.0.0

package/dist/number/branded-types/non-negative-finite-number.d.mts

@@ -145,12 +145,12 @@ export declare const NonNegativeFiniteNumber: {
     readonly div: (x: TtfImported_NonNegativeFiniteNumber, y: number & {
         readonly NaNValue: false;
         readonly Finite: true;
-        readonly "!=0": true;
         readonly "> -2^16": true;
         readonly "> -2^32": true;
         readonly ">= -2^15": true;
         readonly ">= -2^31": true;
         readonly ">=0": true;
+        readonly "!=0": true;
     } & Readonly<{
         'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
     }>) => TtfImported_NonNegativeFiniteNumber;

package/dist/number/branded-types/non-negative-int16.d.mts

@@ -134,12 +134,12 @@ export declare const NonNegativeInt16: {
         readonly NaNValue: false;
         readonly Finite: true;
         readonly Int: true;
-        readonly "!=0": true;
         readonly "> -2^16": true;
         readonly "> -2^32": true;
         readonly ">= -2^15": true;
         readonly ">= -2^31": true;
         readonly ">=0": true;
+        readonly "!=0": true;
         readonly "< 2^15": true;
         readonly "< 2^16": true;
         readonly "< 2^31": true;

package/dist/number/branded-types/non-negative-int32.d.mts

@@ -133,12 +133,12 @@ export declare const NonNegativeInt32: {
         readonly NaNValue: false;
         readonly Finite: true;
         readonly Int: true;
-        readonly "!=0": true;
         readonly "> -2^16": true;
         readonly "> -2^32": true;
         readonly ">= -2^15": true;
         readonly ">= -2^31": true;
         readonly ">=0": true;
+        readonly "!=0": true;
         readonly "< 2^31": true;
         readonly "< 2^32": true;
         readonly SafeInt: true;

package/dist/number/branded-types/non-positive-finite-number.d.mts

@@ -0,0 +1,130 @@
+import { type NonPositiveFiniteNumber as TtfImported_NonPositiveFiniteNumber } from 'ts-type-forge';
+import { TsDataForgeInternals } from '../refined-number-utils.mjs';
+export type NonPositiveFiniteNumber = TtfImported_NonPositiveFiniteNumber;
+type ElementType = NonPositiveFiniteNumber;
+/**
+ * Checks if a number is a NonPositiveFiniteNumber (a finite number <= 0).
+ *
+ * @param value The value to check.
+ * @returns `true` if the value is a NonPositiveFiniteNumber, `false` otherwise.
+ */
+export declare const isNonPositiveFiniteNumber: (a: number) => a is TtfImported_NonPositiveFiniteNumber;
+/**
+ * Casts a number to a NonPositiveFiniteNumber type.
+ *
+ * @param value The value to cast.
+ * @returns The value as a NonPositiveFiniteNumber type.
+ * @throws {TypeError} If the value is not a non-positive finite number.
+ */
+export declare const asNonPositiveFiniteNumber: <N extends number>(x: N) => number & {
+    readonly NaNValue: false;
+    readonly Finite: true;
+    readonly "<=0": true;
+    readonly "< 2^15": true;
+    readonly "< 2^16": true;
+    readonly "< 2^31": true;
+    readonly "< 2^32": true;
+} & Readonly<{
+    'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
+}> & N;
+/**
+ * Namespace providing type-safe arithmetic operations for non-positive finite
+ * numbers.
+ *
+ * All operations maintain the non-positive constraint by clamping positive
+ * results to MAX_VALUE (0), while ensuring results remain finite (excluding NaN
+ * and Infinity). This type is useful for representing quantities that must
+ * always be non-positive, such as debts, penalties, and negative offsets.
+ */
+export declare const NonPositiveFiniteNumber: {
+    /**
+     * Type guard to check if a value is a NonPositiveFiniteNumber.
+     *
+     * @param value The value to check.
+     * @returns `true` if the value is a non-positive finite number, `false`
+     *   otherwise.
+     */
+    readonly is: (a: number) => a is TtfImported_NonPositiveFiniteNumber;
+    /**
+     * The maximum value for a non-positive finite number.
+     *
+     * @readonly
+     */
+    readonly MAX_VALUE: 0;
+    /**
+     * Returns the smaller of two NonPositiveFiniteNumber values.
+     *
+     * @param a The first NonPositiveFiniteNumber.
+     * @param b The second NonPositiveFiniteNumber.
+     * @returns The minimum value as a NonPositiveFiniteNumber.
+     */
+    readonly min: (...values: readonly TtfImported_NonPositiveFiniteNumber[]) => TtfImported_NonPositiveFiniteNumber;
+    /**
+     * Returns the larger of two NonPositiveFiniteNumber values.
+     *
+     * @param a The first NonPositiveFiniteNumber.
+     * @param b The second NonPositiveFiniteNumber.
+     * @returns The maximum value as a NonPositiveFiniteNumber.
+     */
+    readonly max: (...values: readonly TtfImported_NonPositiveFiniteNumber[]) => TtfImported_NonPositiveFiniteNumber;
+    /**
+     * Clamps a number to the non-positive finite range.
+     *
+     * @param value The number to clamp.
+     * @returns The value clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+     */
+    readonly clamp: (x: number) => TtfImported_NonPositiveFiniteNumber;
+    /**
+     * Rounds down a NonPositiveFiniteNumber to the nearest integer.
+     *
+     * @param x The NonPositiveFiniteNumber to round down.
+     * @returns The floor value as a NonPositiveInt (can be 0).
+     */
+    readonly floor: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>>;
+    /**
+     * Rounds up a NonPositiveFiniteNumber to the nearest integer.
+     *
+     * @param x The NonPositiveFiniteNumber to round up.
+     * @returns The ceiling value as a NegativeInt (always <= -1) or 0.
+     */
+    readonly ceil: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>>;
+    /**
+     * Rounds a NonPositiveFiniteNumber to the nearest integer.
+     *
+     * @param x The NonPositiveFiniteNumber to round.
+     * @returns The rounded value as a NonPositiveInt (can be 0 if x > -0.5).
+     */
+    readonly round: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>>;
+    /**
+     * Generates a random NonPositiveFiniteNumber value.
+     *
+     * @returns A random non-positive finite number.
+     */
+    readonly random: (min?: TtfImported_NonPositiveFiniteNumber | undefined, max?: TtfImported_NonPositiveFiniteNumber | undefined) => TtfImported_NonPositiveFiniteNumber;
+    /**
+     * Raises a NonPositiveFiniteNumber to the power of another NonPositiveFiniteNumber.
+     *
+     * @param a The base NonPositiveFiniteNumber.
+     * @param b The exponent NonPositiveFiniteNumber.
+     * @returns `a ** b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+     */
+    readonly pow: (x: TtfImported_NonPositiveFiniteNumber, y: TtfImported_NonPositiveFiniteNumber) => TtfImported_NonPositiveFiniteNumber;
+    /**
+     * Adds two NonPositiveFiniteNumber values.
+     *
+     * @param a The first NonPositiveFiniteNumber.
+     * @param b The second NonPositiveFiniteNumber.
+     * @returns `a + b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+     */
+    readonly add: (x: TtfImported_NonPositiveFiniteNumber, y: TtfImported_NonPositiveFiniteNumber) => TtfImported_NonPositiveFiniteNumber;
+    /**
+     * Subtracts one NonPositiveFiniteNumber from another.
+     *
+     * @param a The minuend NonPositiveFiniteNumber.
+     * @param b The subtrahend NonPositiveFiniteNumber.
+     * @returns `a - b` clamped to (-∞, 0] as a NonPositiveFiniteNumber (maximum 0).
+     */
+    readonly sub: (x: TtfImported_NonPositiveFiniteNumber, y: TtfImported_NonPositiveFiniteNumber) => TtfImported_NonPositiveFiniteNumber;
+};
+export {};
+//# sourceMappingURL=non-positive-finite-number.d.mts.map

package/dist/number/branded-types/non-positive-finite-number.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"non-positive-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-positive-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,uBAAuB,IAAI,mCAAmC,EAAE,MAAM,eAAe,CAAC;AACpG,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,KAAK,WAAW,GAAG,uBAAuB,CAAC;AA2D3C;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,yDAAK,CAAC;AAE5C;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;MAAW,CAAC;AAElD;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB;IAClC;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;wBA3GA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IA2GC;;;;;OAKG;uBAvGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAuGC;;;;;OAKG;wBArGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAqGC;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;CAEK,CAAC"}

package/dist/number/branded-types/non-positive-finite-number.mjs

@@ -0,0 +1,134 @@
+import { TsDataForgeInternals } from '../refined-number-utils.mjs';
+
+const typeNameInMessage = 'a non-positive finite number';
+const { MAX_VALUE, add, castType, clamp, is, max: max_, min: min_, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
+    MIN_VALUE: Number.MAX_VALUE * -1,
+    MAX_VALUE: 0,
+    typeNameInMessage,
+});
+const floor = (x) => 
+// eslint-disable-next-line total-functions/no-unsafe-type-assertion
+Math.floor(x);
+const ceil = (x) => 
+// eslint-disable-next-line total-functions/no-unsafe-type-assertion
+Math.ceil(x);
+const round = (x) => 
+// eslint-disable-next-line total-functions/no-unsafe-type-assertion
+Math.round(x);
+/**
+ * Checks if a number is a NonPositiveFiniteNumber (a finite number <= 0).
+ *
+ * @param value The value to check.
+ * @returns `true` if the value is a NonPositiveFiniteNumber, `false` otherwise.
+ */
+const isNonPositiveFiniteNumber = is;
+/**
+ * Casts a number to a NonPositiveFiniteNumber type.
+ *
+ * @param value The value to cast.
+ * @returns The value as a NonPositiveFiniteNumber type.
+ * @throws {TypeError} If the value is not a non-positive finite number.
+ */
+const asNonPositiveFiniteNumber = castType;
+/**
+ * Namespace providing type-safe arithmetic operations for non-positive finite
+ * numbers.
+ *
+ * All operations maintain the non-positive constraint by clamping positive
+ * results to MAX_VALUE (0), while ensuring results remain finite (excluding NaN
+ * and Infinity). This type is useful for representing quantities that must
+ * always be non-positive, such as debts, penalties, and negative offsets.
+ */
+const NonPositiveFiniteNumber = {
+    /**
+     * Type guard to check if a value is a NonPositiveFiniteNumber.
+     *
+     * @param value The value to check.
+     * @returns `true` if the value is a non-positive finite number, `false`
+     *   otherwise.
+     */
+    is,
+    /**
+     * The maximum value for a non-positive finite number.
+     *
+     * @readonly
+     */
+    MAX_VALUE,
+    /**
+     * Returns the smaller of two NonPositiveFiniteNumber values.
+     *
+     * @param a The first NonPositiveFiniteNumber.
+     * @param b The second NonPositiveFiniteNumber.
+     * @returns The minimum value as a NonPositiveFiniteNumber.
+     */
+    min: min_,
+    /**
+     * Returns the larger of two NonPositiveFiniteNumber values.
+     *
+     * @param a The first NonPositiveFiniteNumber.
+     * @param b The second NonPositiveFiniteNumber.
+     * @returns The maximum value as a NonPositiveFiniteNumber.
+     */
+    max: max_,
+    /**
+     * Clamps a number to the non-positive finite range.
+     *
+     * @param value The number to clamp.
+     * @returns The value clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+     */
+    clamp,
+    /**
+     * Rounds down a NonPositiveFiniteNumber to the nearest integer.
+     *
+     * @param x The NonPositiveFiniteNumber to round down.
+     * @returns The floor value as a NonPositiveInt (can be 0).
+     */
+    floor,
+    /**
+     * Rounds up a NonPositiveFiniteNumber to the nearest integer.
+     *
+     * @param x The NonPositiveFiniteNumber to round up.
+     * @returns The ceiling value as a NegativeInt (always <= -1) or 0.
+     */
+    ceil,
+    /**
+     * Rounds a NonPositiveFiniteNumber to the nearest integer.
+     *
+     * @param x The NonPositiveFiniteNumber to round.
+     * @returns The rounded value as a NonPositiveInt (can be 0 if x > -0.5).
+     */
+    round,
+    /**
+     * Generates a random NonPositiveFiniteNumber value.
+     *
+     * @returns A random non-positive finite number.
+     */
+    random,
+    /**
+     * Raises a NonPositiveFiniteNumber to the power of another NonPositiveFiniteNumber.
+     *
+     * @param a The base NonPositiveFiniteNumber.
+     * @param b The exponent NonPositiveFiniteNumber.
+     * @returns `a ** b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+     */
+    pow,
+    /**
+     * Adds two NonPositiveFiniteNumber values.
+     *
+     * @param a The first NonPositiveFiniteNumber.
+     * @param b The second NonPositiveFiniteNumber.
+     * @returns `a + b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+     */
+    add,
+    /**
+     * Subtracts one NonPositiveFiniteNumber from another.
+     *
+     * @param a The minuend NonPositiveFiniteNumber.
+     * @param b The subtrahend NonPositiveFiniteNumber.
+     * @returns `a - b` clamped to (-∞, 0] as a NonPositiveFiniteNumber (maximum 0).
+     */
+    sub,
+};
+
+export { NonPositiveFiniteNumber, asNonPositiveFiniteNumber, isNonPositiveFiniteNumber };
+//# sourceMappingURL=non-positive-finite-number.mjs.map

package/dist/number/branded-types/non-positive-finite-number.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"non-positive-finite-number.mjs","sources":["../../../src/number/branded-types/non-positive-finite-number.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAOA,MAAM,iBAAiB,GAAG,8BAA8B;AAExD,MAAM,EACJ,SAAS,EACT,GAAG,EACH,QAAQ,EACR,KAAK,EACL,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,iBAAiB,CAI3D;AACA,IAAA,SAAS,EAAE,MAAM,CAAC,SAAS,GAAG,EAAE;AAChC,IAAA,SAAS,EAAE,CAAC;IACZ,iBAAiB;AACT,CAAA,CAAC;AAEX,MAAM,KAAK,GAAG,CACZ,CAAc;AAId;AACA,IAAI,CAAC,KAAK,CACR,CAAC,CAGF;AAEH,MAAM,IAAI,GAAG,CACX,CAAc;AAId;AACA,IAAI,CAAC,IAAI,CAAC,CAAC,CAEV;AAEH,MAAM,KAAK,GAAG,CACZ,CAAc;AAId;AACA,IAAI,CAAC,KAAK,CACR,CAAC,CAGF;AAEH;;;;;AAKG;AACI,MAAM,yBAAyB,GAAG;AAEzC;;;;;;AAMG;AACI,MAAM,yBAAyB,GAAG;AAEzC;;;;;;;;AAQG;AACI,MAAM,uBAAuB,GAAG;AACrC;;;;;;AAMG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;IACH,KAAK;AAEL;;;;;AAKG;IACH,KAAK;AAEL;;;;;AAKG;IACH,IAAI;AAEJ;;;;;AAKG;IACH,KAAK;AAEL;;;;AAIG;IACH,MAAM;AAEN;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;;;;;"}

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

@@ -0,0 +1,224 @@
+import { type NonPositiveInt as TtfImported_NonPositiveInt } from 'ts-type-forge';
+export type NonPositiveInt = TtfImported_NonPositiveInt;
+/**
+ * Type guard that checks if a value is a non-positive integer.
+ *
+ * A non-positive integer is any integer less than or equal to zero (<= 0).
+ * This includes zero and all negative integers, but excludes positive numbers
+ * and non-integers.
+ *
+ * @example
+ *
+ * ```ts
+ * assert.isTrue(isNonPositiveInt(0));
+ *
+ * assert.isTrue(isNonPositiveInt(-5));
+ *
+ * assert.isFalse(isNonPositiveInt(1));
+ * ```
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-positive integer, `false` otherwise
+ */
+export declare const isNonPositiveInt: (a: number) => a is TtfImported_NonPositiveInt;
+/**
+ * Casts a number to a NonPositiveInt branded type.
+ *
+ * This function validates that the input is a non-positive integer (<= 0) and
+ * returns it with the NonPositiveInt brand. This ensures type safety for
+ * operations that require non-positive integer values.
+ *
+ * @example
+ *
+ * ```ts
+ * const branded = asNonPositiveInt(-7);
+ *
+ * assert.isTrue(branded === -7);
+ *
+ * assert.isTrue(NonPositiveInt.is(branded));
+ * ```
+ *
+ * @param value - The value to cast
+ * @returns The value as a NonPositiveInt branded type
+ * @throws {TypeError} If the value is not a non-positive integer
+ */
+export declare const asNonPositiveInt: <N extends number>(x: N) => number & {
+    readonly NaNValue: false;
+    readonly Finite: true;
+    readonly Int: true;
+    readonly "<=0": true;
+    readonly "< 2^15": true;
+    readonly "< 2^16": true;
+    readonly "< 2^31": true;
+    readonly "< 2^32": true;
+} & Readonly<{
+    'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
+}> & N;
+/**
+ * Namespace providing type-safe operations for NonPositiveInt branded types.
+ *
+ * NonPositiveInt represents integers that are less than or equal to zero (<= 0).
+ * All operations automatically clamp results to maintain the non-positive
+ * constraint, ensuring that arithmetic operations never produce positive values.
+ *
+ * This type is essential for:
+ *
+ * - Debts and negative balances
+ * - Penalties and reductions
+ * - Offsets and adjustments (downward)
+ * - Negative counts or differences
+ * - Depth or altitude below a reference point
+ */
+export declare const NonPositiveInt: {
+    /**
+     * Type guard that checks if a value is a non-positive integer.
+     *
+     * @example
+     *
+     * ```ts
+     * const value: number = -42;
+     *
+     * if (NonPositiveInt.is(value)) {
+     *   // value is now typed as NonPositiveInt
+     *   const debt = value;
+     * }
+     * ```
+     *
+     * @param value - The value to check
+     * @returns `true` if the value is a non-positive integer, `false` otherwise
+     */
+    readonly is: (a: number) => a is TtfImported_NonPositiveInt;
+    /**
+     * The maximum value for a non-positive integer.
+     *
+     * @readonly
+     */
+    readonly MAX_VALUE: 0;
+    /**
+     * Returns the smaller of two non-positive integers.
+     *
+     * Since non-positive integers range from negative infinity to 0, the smaller
+     * value is the one further from zero (more negative).
+     *
+     * @example
+     *
+     * ```ts
+     * const result = NonPositiveInt.min(-5, -10);
+     *
+     * assert.strictEqual(result, -10);
+     * ```
+     *
+     * @param a - The first non-positive integer
+     * @param b - The second non-positive integer
+     * @returns The minimum value as a non-positive integer
+     */
+    readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>[]) => TtfImported_NonPositiveInt;
+    /**
+     * Returns the larger of two non-positive integers.
+     *
+     * Since non-positive integers range from negative infinity to 0, the larger
+     * value is the one closer to zero (less negative).
+     *
+     * @example
+     *
+     * ```ts
+     * const result = NonPositiveInt.max(-5, -10);
+     *
+     * assert.strictEqual(result, -5);
+     * ```
+     *
+     * @param a - The first non-positive integer
+     * @param b - The second non-positive integer
+     * @returns The maximum value as a non-positive integer
+     */
+    readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>[]) => TtfImported_NonPositiveInt;
+    /**
+     * Clamps a number to the non-positive integer range.
+     *
+     * Any positive value is clamped to 0 (the maximum non-positive integer).
+     * Negative values are preserved as long as they are valid integers.
+     *
+     * @example
+     *
+     * ```ts
+     * assert.strictEqual(NonPositiveInt.clamp(5), 0);
+     *
+     * assert.strictEqual(NonPositiveInt.clamp(-5), -5);
+     *
+     * assert.strictEqual(NonPositiveInt.clamp(0), 0);
+     * ```
+     *
+     * @param value - The number to clamp
+     * @returns The value clamped to the non-positive integer range
+     */
+    readonly clamp: (x: number) => TtfImported_NonPositiveInt;
+    /**
+     * Generates a random non-positive integer value.
+     *
+     * @example
+     *
+     * ```ts
+     * const randomValue = NonPositiveInt.random();
+     *
+     * assert.isTrue(NonPositiveInt.is(randomValue));
+     * ```
+     *
+     * @returns A random non-positive integer
+     */
+    readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt> | undefined) => TtfImported_NonPositiveInt;
+    /**
+     * Raises a non-positive integer to the power of another non-positive integer.
+     *
+     * The result is clamped to the non-positive integer range.
+     *
+     * @example
+     *
+     * ```ts
+     * const result = NonPositiveInt.pow(-2, -1);
+     * ```
+     *
+     * @param a - The base non-positive integer
+     * @param b - The exponent non-positive integer
+     * @returns `a ** b` clamped to the non-positive integer range
+     */
+    readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>) => TtfImported_NonPositiveInt;
+    /**
+     * Adds two non-positive integers.
+     *
+     * The result is clamped to the non-positive integer range. If the sum is
+     * positive, it is clamped to 0.
+     *
+     * @example
+     *
+     * ```ts
+     * assert.strictEqual(NonPositiveInt.add(-5, -3), -8);
+     *
+     * assert.strictEqual(NonPositiveInt.add(-5, 10), 0);
+     * ```
+     *
+     * @param a - The first non-positive integer
+     * @param b - The second non-positive integer
+     * @returns `a + b` clamped to the non-positive integer range
+     */
+    readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>) => TtfImported_NonPositiveInt;
+    /**
+     * Subtracts one non-positive integer from another.
+     *
+     * The result is clamped to the non-positive integer range. If the result is
+     * positive, it is clamped to 0.
+     *
+     * @example
+     *
+     * ```ts
+     * assert.strictEqual(NonPositiveInt.sub(-10, -3), -7);
+     *
+     * assert.strictEqual(NonPositiveInt.sub(-10, 5), 0);
+     * ```
+     *
+     * @param a - The minuend non-positive integer
+     * @param b - The subtrahend non-positive integer
+     * @returns `a - b` clamped to the non-positive integer range
+     */
+    readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>) => TtfImported_NonPositiveInt;
+};
+//# sourceMappingURL=non-positive-int.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"non-positive-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-positive-int.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,IAAI,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAGlF,MAAM,MAAM,cAAc,GAAG,0BAA0B,CAAC;AA4BxD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,gBAAgB,gDAAK,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;MAAW,CAAC;AAEzC;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;OAIG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;OAYG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;CAEK,CAAC"}