@raindrops-on-roses/number-clamp 0.0.1

package/README.md

@@ -0,0 +1,59 @@
+# @raindrops-on-roses/clamp
+
+`clamp` utility from [raindrops-on-roses](https://www.npmjs.com/package/raindrops-on-roses).
+
+Constrains a numeric value between a minimum and maximum bound.
+
+## Install
+
+```sh
+npm install @raindrops-on-roses/clamp
+```
+
+## Usage
+
+```ts
+import { clamp } from "@raindrops-on-roses/clamp";
+
+clamp(5, 0, 10); // 5
+clamp(-5, 0, 10); // 0
+clamp(15, 0, 10); // 10
+```
+
+## API
+
+```ts
+clamp(value: number, min: number, max: number): number
+```
+
+### Parameters
+
+- `value` — The value to clamp.
+- `min` — The minimum value.
+- `max` — The maximum value.
+
+### Returns
+
+The clamped value, between `min` and `max`.
+
+## With the complete library
+
+You can also install the complete `raindrops-on-roses` package:
+
+```sh
+npm install raindrops-on-roses
+```
+
+and import `clamp` from the umbrella package:
+
+```ts
+import { clamp } from "raindrops-on-roses";
+```
+
+## Lore
+
+Procrustes is an innkeeper who forces his guests to sleep in a magical bed whose size fits no one. Either it is too short, in which case Procrustes cuts off whatever parts of the traveler stick out; or it is too long, in which case the innkeeper stretches the limbs of those who lie in it until they match the size of the bed.
+
+## Repository
+
+[graphieros/raindrops-on-roses](https://github.com/graphieros/raindrops-on-roses)

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Clamps a numeric value between a minimum and maximum bound.
+ *
+ * ---
+ *
+ * @param value - The value to clamp
+ * @param min - The minimum value
+ * @param max - The maximum value
+ * @returns The clamped value, between `min` and `max`
+ *
+ * ---
+ *
+ * Lore:
+ * Procrustes is an innkeeper who forces his guests to sleep in a magical bed whose size fits no one. Either it is too short, in which case Procrustes cuts off whatever parts of the traveler stick out; or it is too long, in which case the innkeeper stretches the limbs of those who lie in it until they match the size of the bed.
+ */
+export declare function clamp(value: number, min: number, max: number): number;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAErE"}

package/dist/index.js

@@ -0,0 +1,8 @@
+//#region src/index.ts
+function e(e, t, n) {
+	return Math.min(Math.max(e, t), n);
+}
+//#endregion
+export { e as clamp };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["/**\n * Clamps a numeric value between a minimum and maximum bound.\n *\n * ---\n *\n * @param value - The value to clamp\n * @param min - The minimum value\n * @param max - The maximum value\n * @returns The clamped value, between `min` and `max`\n *\n * ---\n *\n * Lore:\n * Procrustes is an innkeeper who forces his guests to sleep in a magical bed whose size fits no one. Either it is too short, in which case Procrustes cuts off whatever parts of the traveler stick out; or it is too long, in which case the innkeeper stretches the limbs of those who lie in it until they match the size of the bed.\n */\nexport function clamp(value: number, min: number, max: number): number {\n  return Math.min(Math.max(value, min), max);\n}\n"],"mappings":";AAeA,SAAgB,EAAM,GAAe,GAAa,GAAqB;CACrE,OAAO,KAAK,IAAI,KAAK,IAAI,GAAO,CAAG,GAAG,CAAG;AAC3C"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@raindrops-on-roses/number-clamp",
+  "version": "0.0.1",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "vite build && tsc -p tsconfig.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/graphieros/raindrops-on-roses.git",
+    "directory": "packages/number-clamp"
+  }
+}