Number Functions

This module provides a collection of utility functions for working with numbers. It extends functionality from the Effect-TS library.

Arithmetic Operations

Returns the sum of two numbers.

typescript
sum(5, 3); // returns 8

Returns the difference between two numbers.

typescript
subtract(5, 3); // returns 2

Returns the product of two numbers.

typescript
multiply(5, 3); // returns 15

Returns the quotient of two numbers.

typescript
divide(6, 2); // returns 3

Returns the remainder after division of two numbers. The result takes the sign of the dividend.

typescript
remainder(5, 2); // returns 1
remainder(-5, 2); // returns -1

Returns the absolute value of a number.

typescript
abs(-5); // returns 5
abs(5); // returns 5

Rounds a number to the specified precision (decimal places).

typescript
round(3.14159, 2); // returns 3.14
round(3.14159, 0); // returns 3

Checks if the first number is greater than the second.

typescript
greaterThan(5, 3); // returns true
greaterThan(3, 5); // returns false

Checks if the first number is less than the second.

typescript
lessThan(3, 5); // returns true
lessThan(5, 3); // returns false

Checks if the first number is less than or equal to the second.

typescript
lessThanOrEqualTo(3, 3); // returns true
lessThanOrEqualTo(3, 5); // returns true
lessThanOrEqualTo(5, 3); // returns false

Checks if the first number is greater than or equal to the second.

typescript
greaterThanOrEqualTo(5, 3); // returns true
greaterThanOrEqualTo(3, 3); // returns true
greaterThanOrEqualTo(3, 5); // returns false

Checks if two numbers are strictly equal.

typescript
equals(5, 5); // returns true
equals(5, 3); // returns false