Num

const Num: object

Defined in: Data/Num.ts:20

Type Declaration

abs

abs: (value) => number

Returns the absolute value of a number.

Parameters

value

number

Returns

number

Example

pipe(-5, Num.abs); // 5
pipe(5, Num.abs);  // 5

add

add: (amount) => (value) => number

Adds amount to a number. Data-last: use in pipe or Arr.map.

Parameters

amount

number

Returns

(value) => number

See

Num.subtract to subtract an amount from a number.

Example

pipe(5, Num.add(3));                   // 8
pipe([1, 2, 3], Arr.map(Num.add(10))); // [11, 12, 13]

between

between: (min, max) => (value) => boolean

Returns true when the number is between min and max (both inclusive).

Parameters

min

number

max

number

Returns

(value) => boolean

See

Num.inRange for half-open range checking [start, end).

Example

pipe(5, Num.between(1, 10));  // true
pipe(0, Num.between(1, 10));  // false
pipe(10, Num.between(1, 10)); // true

ceil

ceil: (value) => number

Rounds a number up to the nearest integer.

Parameters

value

number

Returns

number

See

• Num.round to round to nearest integer.
• Num.floor to round down.

Example

pipe(3.1, Num.ceil); // 4
pipe(-3.9, Num.ceil); // -3

clamp

clamp: (min, max) => (value) => number

Clamps a number between min and max (both inclusive).

Parameters

min

number

max

number

Returns

(value) => number

Example

pipe(150, Num.clamp(0, 100)); // 100
pipe(-5, Num.clamp(0, 100));  // 0
pipe(42, Num.clamp(0, 100));  // 42

divide

divide: (divisor) => (dividend) => Maybe<number>

Divides a number by divisor. Returns None when divisor is zero. Data-last: divide(divisor)(dividend) = dividend / divisor.

Parameters

divisor

number

Returns

(dividend) => Maybe<number>

See

• Num.multiply to multiply a number by a factor.
• Num.remainder to compute the division remainder.

Example

pipe(20, Num.divide(4));                           // Some(5)
pipe(5, Num.divide(0));                            // None
pipe([10, 20, 30], Arr.filterMap(Num.divide(10))); // [1, 2, 3]

floor

floor: (value) => number

Rounds a number down to the nearest integer.

Parameters

value

number

Returns

number

See

• Num.round to round to nearest integer.
• Num.ceil to round up.

Example

pipe(3.9, Num.floor); // 3
pipe(-3.2, Num.floor); // -4

format

format: (options?, locales?) => (value) => Maybe<string>

Formats a number using Intl.NumberFormat. Returns None when value is NaN or non-finite. Data-last curried signature.

Parameters

options?

NumberFormatOptions

locales?

string | string[]

Returns

(value) => Maybe<string>

Example

const formatCurrency = Num.format({ style: "currency", currency: "USD" }, "en-US");
pipe(1234.5, formatCurrency); // Some("$1,234.50")
pipe(NaN, formatCurrency);    // None

from

from: object

Parsers and converters from strings or BigInt to number.

from.string

string: (text) => Maybe<number>

Parses a string as a number. Returns None when parsing produces NaN or text is blank.

Parameters

text

string

Returns

Maybe<number>

Example

Num.from.string("42");   // Some(42)
Num.from.string("3.14"); // Some(3.14)
Num.from.string("abc");  // None
Num.from.string("");     // None

inRange

inRange: (start, end) => (value) => boolean

Returns true when the number is in the range [start, end) (inclusive of start, exclusive of end).

Parameters

start

number

end

number

Returns

(value) => boolean

See

Num.between for fully closed range checking [min, max].

Example

pipe(5, Num.inRange(1, 10));  // true
pipe(1, Num.inRange(1, 10));  // true
pipe(10, Num.inRange(1, 10)); // false

is

is: object

Predicates and type guards for number values.

is.even

even: (value) => boolean

Returns true when the number is an even integer.

Parameters

value

number

Returns

boolean

See

Num.is.odd to check if a number is odd.

Example

Num.is.even(4);   // true
Num.is.even(3);   // false
Num.is.even(2.5); // false

is.finite

finite: (value) => boolean

Returns true when the number is finite (not Infinity, -Infinity, or NaN).

Parameters

value

number

Returns

boolean

Example

Num.is.finite(42);       // true
Num.is.finite(Infinity); // false

is.float

float: (value) => boolean

Returns true when the number is a finite float (fractional number).

Parameters

value

number

Returns

boolean

See

Num.is.integer to check for whole numbers.

Example

Num.is.float(3.14); // true
Num.is.float(5);    // false

is.integer

integer: (value) => boolean

Returns true when the number is a whole integer.

Parameters

value

number

Returns

boolean

See

Num.is.float to check for fractional numbers.

Example

Num.is.integer(5);    // true
Num.is.integer(3.14); // false

is.nan

nan: (value) => boolean

Returns true when the value is NaN.

Parameters

value

number

Returns

boolean

Example

Num.is.nan(NaN); // true
Num.is.nan(42);  // false

is.negative

negative: (value) => boolean

Returns true when the number is strictly less than zero.

Parameters

value

number

Returns

boolean

See

Num.is.positive to check if a number is greater than zero.

Example

Num.is.negative(-5); // true
Num.is.negative(0);  // false
Num.is.negative(5);  // false

is.odd

odd: (value) => boolean

Returns true when the number is an odd integer.

Parameters

value

number

Returns

boolean

See

Num.is.even to check if a number is even.

Example

Num.is.odd(3);   // true
Num.is.odd(4);   // false
Num.is.odd(2.5); // false

is.positive

positive: (value) => boolean

Returns true when the number is strictly greater than zero.

Parameters

value

number

Returns

boolean

See

Num.is.negative to check if a number is less than zero.

Example

Num.is.positive(5);  // true
Num.is.positive(0);  // false
Num.is.positive(-5); // false

is.zero

zero: (value) => boolean

Returns true when the number is equal to zero.

Parameters

value

number

Returns

boolean

Example

Num.is.zero(0); // true
Num.is.zero(5); // false

max

max: (numbers) => Maybe<number>

Computes the maximum of a list of numbers. Returns None if the list is empty.

Parameters

numbers

readonly number[]

Returns

Maybe<number>

See

Num.min to compute the minimum value.

Example

Num.max([1, 5, 3]); // Some(5)
Num.max([]);        // None

mean

mean: (numbers) => Maybe<number>

Computes the mean of a list of numbers. Returns None if the list is empty.

Parameters

numbers

readonly number[]

Returns

Maybe<number>

Example

Num.mean([1, 2, 3]); // Some(2)
Num.mean([]);        // None

min

min: (numbers) => Maybe<number>

Computes the minimum of a list of numbers. Returns None if the list is empty.

Parameters

numbers

readonly number[]

Returns

Maybe<number>

See

Num.max to compute the maximum value.

Example

Num.min([5, 1, 3]); // Some(1)
Num.min([]);        // None

multiply

multiply: (factor) => (value) => number

Multiplies a number by factor. Data-last: use in pipe or Arr.map.

Parameters

factor

number

Returns

(value) => number

See

Num.divide to divide a number by a divisor.

Example

pipe(6, Num.multiply(7));                    // 42
pipe([1, 2, 3], Arr.map(Num.multiply(100))); // [100, 200, 300]

negate

negate: (value) => number

Negates a number (arithmetic negation).

Parameters

value

number

Returns

number

Example

pipe(5, Num.negate);  // -5
pipe(-5, Num.negate); // 5

range

range: (from, to, step) => readonly number[]

Generates an array of numbers from from to to (both inclusive), stepping by step (default 1). If step is negative or zero, or from > to, returns an empty array. When step does not land exactly on to, the last value is the largest reachable value that does not exceed to.

Parameters

from

number

to

number

step?

number = 1

Returns

readonly number[]

Example

Num.range(0, 5);       // [0, 1, 2, 3, 4, 5]
Num.range(0, 10, 2);   // [0, 2, 4, 6, 8, 10]
Num.range(0, 9, 2);    // [0, 2, 4, 6, 8]
Num.range(5, 0);       // []
Num.range(3, 3);       // [3]

remainder

remainder: (divisor) => (dividend) => Maybe<number>

Returns the remainder of dividing a number by divisor. Returns None when divisor is zero. Data-last: remainder(divisor)(dividend) = dividend % divisor.

Parameters

divisor

number

Returns

(dividend) => Maybe<number>

See

Num.divide for full division.

Example

pipe(10, Num.remainder(3));                           // Some(1)
pipe(5, Num.remainder(0));                            // None
pipe([10, 11, 12], Arr.filterMap(Num.remainder(3))); // [1, 2, 0]

round

round: (value) => number

Rounds a number to the nearest integer.

Parameters

value

number

Returns

number

See

• Num.floor to round down.
• Num.ceil to round up.

Example

pipe(3.5, Num.round); // 4
pipe(3.4, Num.round); // 3

subtract

subtract: (amount) => (from) => number

Subtracts amount from a number. Data-last: subtract(amount)(from) = from - amount.

Parameters

amount

number

Returns

(from) => number

See

Num.add to add an amount to a number.

Example

pipe(10, Num.subtract(3));                  // 7
pipe([5, 10, 15], Arr.map(Num.subtract(2))); // [3, 8, 13]

sum

sum: (numbers) => number = sumFn

Computes the sum of a list of numbers. Returns 0 if the list is empty.

Parameters

numbers

readonly number[]

Returns

number

Example

Num.sum([1, 2, 3]); // 6
Num.sum([]);        // 0