@grain/stdlib 0.7.0 → 0.7.1

package/marshal.md

@@ -46,15 +46,15 @@ deserialized at a later time to restore the value.
 
 Parameters:
 
-|param|type|description|
-|-----|----|-----------|
-|`value`|`a`|The value to serialize|
+| param   | type | description            |
+| ------- | ---- | ---------------------- |
+| `value` | `a`  | The value to serialize |
 
 Returns:
 
-|type|description|
-|----|-----------|
-|`Bytes`|A byte-based representation of the value|
+| type    | description                              |
+| ------- | ---------------------------------------- |
+| `Bytes` | A byte-based representation of the value |
 
 Examples:
 
@@ -86,15 +86,15 @@ unmarshaled corresponds to the expected type.
 
 Parameters:
 
-|param|type|description|
-|-----|----|-----------|
-|`bytes`|`Bytes`|The data to deserialize|
+| param   | type    | description             |
+| ------- | ------- | ----------------------- |
+| `bytes` | `Bytes` | The data to deserialize |
 
 Returns:
 
-|type|description|
-|----|-----------|
-|`Result<a, String>`|An in-memory value|
+| type                | description        |
+| ------------------- | ------------------ |
+| `Result<a, String>` | An in-memory value |
 
 Examples:
 

package/number.gr

@@ -83,7 +83,7 @@ provide let e = 2.718281828459045
  * @returns The sum of the two operands
  *
  * @example
- * from Number use { (+) }
+ * use Number.{ (+) }
  * assert 1 + 2 == 3
  *
  * @since v0.6.0
@@ -99,7 +99,7 @@ provide let (+) = (+)
  * @returns The difference of the two operands
  *
  * @example
- * from Number use { (-) }
+ * use Number.{ (-) }
  * assert 5 - 2 == 3
  *
  * @since v0.6.0
@@ -115,7 +115,7 @@ provide let (-) = (-)
  * @returns The product of the two operands
  *
  * @example
- * from Number use { (*) }
+ * use Number.{ (*) }
  * assert 5 * 4 == 20
  *
  * @since v0.6.0
@@ -131,7 +131,7 @@ provide let (*) = (*)
  * @returns The quotient of the two operands
  *
  * @example
- * from Number use { (/) }
+ * use Number.{ (/) }
  * assert 10 / 2.5 == 4
  *
  * @since v0.6.0
@@ -139,6 +139,22 @@ provide let (*) = (*)
  */
 provide let (/) = (/)
 
+/**
+ * Computes the remainder of the division of the first operand by the second.
+ * The result will have the sign of the second operand.
+ *
+ * @param num1: The first operand
+ * @param num2: The second operand
+ * @returns The modulus of its operands
+ *
+ * @example
+ * use Number.{ (%) }
+ * assert 10 % 3 == 1
+ *
+ * @since v0.7.1
+ */
+provide let (%) = (%)
+
 /**
  * Computes the exponentiation of the given base and power.
  *
@@ -147,7 +163,7 @@ provide let (/) = (/)
  * @returns The base raised to the given power
  *
  * @example
- * from Number use { (**) }
+ * use Number.{ (**) }
  * assert 10 ** 2 == 100
  *
  * @since v0.6.0
@@ -155,6 +171,104 @@ provide let (/) = (/)
  */
 provide let (**) = (**)
 
+/**
+ * Checks if the first value is equal to the second value.
+ *
+ * @param x: The first value
+ * @param y: The second value
+ * @returns `true` if the first value is equal to the second value or `false` otherwise
+ *
+ * @example
+ * use Number.{ (==) }
+ * assert 1 == 1
+ *
+ * @since v0.7.1
+ */
+provide let (==) = Numbers.numberEq
+
+/**
+ * Checks if the first value is equal to the second value.
+ *
+ * @param x: The first value
+ * @param y: The second value
+ * @returns `true` if the first value is equal to the second value or `false` otherwise
+ *
+ * @example
+ * use Number.{ (==) }
+ * assert 1 == 1
+ *
+ * @since v0.7.1
+ */
+provide let (!=) = (x, y) => !Numbers.numberEq(x, y)
+
+/**
+ * Checks if the first value is less than the second value.
+ *
+ * @param num1: The first value
+ * @param num2: The second value
+ * @returns `true` if the first value is less than the second value or `false` otherwise
+ *
+ * @example
+ * use Number.{ (<) }
+ * assert 1 < 5
+ *
+ * @since v0.7.1
+ */
+provide let (<) = (<)
+
+/**
+ * Checks if the first value is greater than the second value.
+ *
+ * @param num1: The first value
+ * @param num2: The second value
+ * @returns `true` if the first value is greater than the second value or `false` otherwise
+ *
+ * @example
+ * use Number.{ (>) }
+ * assert 5 > 1
+ *
+ * @since v0.7.1
+ */
+provide let (>) = (>)
+
+/**
+ * Checks if the first value is less than or equal to the second value.
+ *
+ * @param num1: The first value
+ * @param num2: The second value
+ * @returns `true` if the first value is less than or equal to the second value or `false` otherwise
+ *
+ * @example
+ * use Number.{ (<=) }
+ * assert 1 <= 2
+ * @example
+ * use Number.{ (<=) }
+ * assert 1 <= 1
+ *
+ * @since v0.7.1
+ */
+@unsafe
+provide let (<=) = (<=)
+
+/**
+ * Checks if the first value is greater than or equal to the second value.
+ *
+ * @param num1: The first value
+ * @param num2: The second value
+ * @returns `true` if the first value is greater than or equal to the second value or `false` otherwise
+ *
+ * @example
+ * use Number.{ (>=) }
+ * assert 3 >= 2
+ * @example
+ * use Number.{ (>=) }
+ * assert 1 >= 1
+ *
+ * @since v0.7.1
+ */
+@unsafe
+provide let (>=) = (>=)
+
 /**
  * Computes the exponentiation of Euler's number to the given power.
  *