lolite.floor 1.1.7 → 1.1.9

package/README.md

@@ -1,11 +1,9 @@
-# lolite.floor
-
-### floor(value)
+## floor(value)
 Round a number down to the nearest whole integer.
 Non-finite or non-numeric values are coerced to zero.
 
 ```javascript
-const floor = require("lolite.floor")
+const lolite = require("lolite.floor")
 const positiveResult = floor(2.1)
 // result: 2
 
@@ -14,6 +12,122 @@ const negativeResult = floor(-2.1)
 
 const coercedResult = floor("garbage")
 // result: 0 (0 floored)
-```
-
-This utility is part of the [LoLite](https://github.com/enterprise-npm-ai/lolite) utility suite.
+```
+
+### ceil(value)
+Round a number up to the nearest whole integer.
+Non-finite or non-numeric values are coerced to zero.
+
+```javascript
+const lolite = require("lolite.floor")
+const positiveResult = lolite.ceil(2.1)
+// result: 3
+
+const negativeResult = lolite.ceil(-2.1)
+// result: 2
+
+const coercedResult = lolite.ceil("garbage")
+// result: 0 (0 ceiled)
+```
+
+### round(value)
+Round a number either up to the nearest whole integer, unless the number is less than `0.5`, then it rounds down.
+Non-finite or non-numeric values are coerced to zero.
+
+```javascript
+const lolite = require("lolite.floor")
+
+const flooredResult = lolite.round(2.1)
+// result: 2
+
+const ceiledResult = lolite.round(2.9)
+// result: 3
+
+const coercedResult = lolite.round("garbage")
+// result: 0 (0 ceiled)
+```
+
+### trunc(value)
+Truncates the decimal portion of a number, returning only the integer part. Truncation moves toward zero for both positive and negative numbers.
+Non-finite or non-numeric values are coerced to zero.
+
+```javascript
+const lolite = require("lolite.floor")
+
+const positiveResult = lolite.trunc(2.9)
+// result: 2
+
+const negativeResult = lolite.trunc(-2.9)
+// result: -2
+
+const zeroPreservation = lolite.trunc(-0)
+// result: -0
+
+const coercedResult = lolite.trunc("garbage")
+// result: 0
+```
+
+### sign(value)
+Returns the sign of a number, indicating whether the number is positive, negative, or zero, or negative zero.
+Non-finite values are coerced to zero.
+
+```javascript
+const lolite = require("lolite.floor")
+
+lolite.sign(42)        // result: 1
+lolite.sign(Infinity)  // result: 1
+lolite.sign(-42)       // result: -1
+lolite.sign(-Infinity) // result: -1
+lolite.sign(0)         // result: 0
+lolite.sign(-0)        // result: -0
+
+lolite.sign("garbage") // result: 0
+lolite.sign(NaN) // result: 0
+```
+
+### max(a, b)
+Returns the largest of two numbers.
+Non-finite or non-numeric values are coerced to zero.
+
+```javascript
+const lolite = require("lolite.floor")
+const result = lolite.max(5, 10)
+// result: 10
+
+const coercedMax = lolite.max(-5, Infinity)
+// result: 0 (comparing -5 and 0)
+```
+
+### min(a, b)
+Returns the smallest of two numbers.
+Non-finite or non-numeric values are coerced to zero.
+
+```javascript
+const lolite = require("lolite.floor")
+const result = lolite.min(5, 10)
+// result: 5
+
+const coercedMin = lolite.min(5, "garbage")
+// result: 0 (comparing 5 and 0)
+```
+
+### clamp(value, lower, upper)
+Restricts a value to be within the specified bounds.
+Non-finite or non-numeric values are coerced to zero.
+
+Note: If lower bound exceeds upper bound after coercion, the function prioritizes the lower bound.
+```javascript
+const lolite = require("lolite.floor")
+const result = lolite.clamp(5, 1, 10)
+// result: 5
+
+const capped = lolite.clamp(15, 1, 10)
+// result: 10
+
+const raised = lolite.clamp(-5, 1, 10)
+// result: 1
+
+const coercedClamp = lolite.clamp(Infinity, "garbage", NaN)
+// result: 0 (0 clamped between 0 and 0)
+```
+

package/package.json

@@ -1,44 +1,35 @@
 {
   "name": "lolite.floor",
-  "version": "1.1.7",
-  "description": "Enterprise-grade floor utility from the LoLite suite",
-  "main": "index.js",
-  "author": "10x'ly Made Software Ventures AB",
+  "version": "1.1.9",
+  "main": "src/lib/floor.js",
   "license": "EGPSL10X-1.0",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/enterprise-npm-ai/lolite.git"
-  },
-  "bugs": {
-    "url": "https://github.com/enterprise-npm-ai/lolite/issues"
-  },
-  "homepage": "https://github.com/enterprise-npm-ai/lolite#readme",
   "dependencies": {
-    "lodash.multiply": "^4.9.0",
-    "immediate-error": "^7.1.0",
-    "integer-values": "^2.0.0",
+    "construct-new": "^2.0.4",
+    "while2": "^2.0.2",
+    "iszero": "^1.0.0",
+    "countingup": "^0.3.0",
+    "@10xly/strict-equals": "^1.0.0",
+    "subtract": "^0.0.3",
+    "@is-(unknown)/is-finite": "^1.0.0",
+    "pkg-with-failing-optional-dependency": "^1.0.1",
+    "@positive-numbers/zero": "^3.0.0",
+    "@positive-numbers/one": "^3.0.0",
+    "false-value": "^2.0.6",
     "is-not-integer": "^1.0.2",
+    "immediate-error": "^7.1.0",
+    "core-js-pure": "^3.47.0",
     "logtoconsole": "^1.0.7",
+    "lodash.multiply": "^4.9.0",
+    "integer-values": "^2.0.0",
     "@not-js/not": "^1.1.0",
-    "es-logical-not-operator": "^1.0.0",
     "is-integer": "^1.0.7",
-    "literally": "^1.0.0",
+    "es-logical-not-operator": "^1.0.0",
     "not-not": "^1.0.2",
     "yanoop": "^1.0.0",
-    "@10xly/strict-equals": "^1.0.0",
-    "@is-(unknown)/is-finite": "^1.0.0",
-    "@positive-numbers/one": "^3.0.0",
-    "@positive-numbers/zero": "^3.0.0",
-    "construct-new": "^2.0.4",
-    "countingup": "^0.3.0",
-    "false-value": "^2.0.6",
-    "iszero": "^1.0.0",
-    "pkg-with-failing-optional-dependency": "^1.0.1",
-    "subtract": "^0.0.3",
-    "while2": "^2.0.2",
-    "es-intrinsic-cache": "^1.0.1",
+    "literally": "^1.0.0",
     "is-not-negative": "^1.0.3",
     "string-split": "^0.3.1",
-    "to-str": "^1.0.0"
+    "to-str": "^1.0.0",
+    "es-intrinsic-cache": "^1.0.1"
   }
 }

package/{subtract.js → src/lib/subtract.js}

@@ -13,7 +13,7 @@ const number1 = require("@positive-numbers/one")
 const falseValue = require("false-value"),
   { Counter } = countingup
 
-const isNotInteger = require("./isNotInteger")
+const isNotInteger = require("../private/isNotInteger")
 
 function subtract(minuend, subtrahend) {
   if (equal(isFinite(minuend), falseValue())) {