@raindrops-on-roses/number-nice-number 0.0.1

package/README.md

@@ -0,0 +1,68 @@
+# @raindrops-on-roses/nice-number
+
+`niceNumber` utility from [raindrops-on-roses](https://www.npmjs.com/package/raindrops-on-roses).
+
+Returns a human-friendly number based on the `1`, `2`, `5`, `10` progression, scaled to the appropriate power of ten. It is useful for chart scales, tick intervals, and similar numeric steps.
+
+## Install
+
+```sh
+npm install @raindrops-on-roses/nice-number
+```
+
+## Usage
+
+```ts
+import { niceNumber } from "@raindrops-on-roses/nice-number";
+
+niceNumber(37); // 50
+niceNumber(23, true); // 20
+```
+
+By default, the result is rounded upward so it is greater than or equal to the provided range.
+
+When `round` is `true`, the nearest human-friendly value is returned instead.
+
+```ts
+niceNumber(101); // 200
+niceNumber(149, true); // 100
+niceNumber(150, true); // 200
+niceNumber(0.15, true); // 0.2
+```
+
+## API
+
+```ts
+niceNumber(range: number, round?: boolean): number
+```
+
+### Parameters
+
+- `range` - The positive numeric range to convert to a human-friendly value.
+- `round` - Whether to return the nearest human-friendly value instead of rounding upward. Defaults to `false`.
+
+### Returns
+
+A human-friendly number expressed as `1`, `2`, `5`, or `10` times a power of ten.
+
+## With the complete library
+
+You can also install the complete `raindrops-on-roses` package:
+
+```sh
+npm install raindrops-on-roses
+```
+
+and import `niceNumber` from the umbrella package:
+
+```ts
+import { niceNumber } from "raindrops-on-roses";
+```
+
+## Lore
+
+> We talk about being in our 30s, and our 40s, and our 50s. We don’t talk about being in our 37s.
+
+## Repository
+
+[graphieros/raindrops-on-roses](https://github.com/graphieros/raindrops-on-roses)

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Returns a human-friendly number based on the `1`, `2`, `5`, `10` progression
+ * scaled to the appropriate power of ten. Useful to produce chart scales, tick itervals, etc.
+ *
+ * By default, the result is rounded upward so it is greater than or equal to
+ * the provided range. When `round` is `true`, the nearest human-friendly value
+ * is returned instead.
+ *
+ * ---
+ *
+ * @param range - The positive numeric range to convert to a human-friendly value
+ * @param round - Whether to return the nearest human-friendly value instead of rounding upward
+ * @returns A human-friendly number expressed as `1`, `2`, `5`, or `10` times a power of ten
+ *
+ * @example
+ * ```ts
+ * niceNumber(37); // 50
+ * niceNumber(23, true); // 20
+ *```
+ * ---
+ *
+ * Lore:
+We talk about being in our 30s, and our 40s, and our 50s. We don’t talk about being in our 37s.
+ */
+export declare function niceNumber(range: number, round?: boolean): 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;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CA+B/D"}

package/dist/index.js

@@ -0,0 +1,9 @@
+//#region src/index.ts
+function e(e, t = !1) {
+	let n = 10 ** Math.floor(Math.log10(e)), r = e / n, i = 2 ** -52 * Math.max(1, Math.abs(r)), a;
+	return a = t ? r < 1.5 - i ? 1 : r < 3 - i ? 2 : r < 7 - i ? 5 : 10 : r <= 1 + i ? 1 : r <= 2 + i ? 2 : r <= 5 + i ? 5 : 10, a * n;
+}
+//#endregion
+export { e as niceNumber };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["/**\n * Returns a human-friendly number based on the `1`, `2`, `5`, `10` progression\n * scaled to the appropriate power of ten. Useful to produce chart scales, tick itervals, etc.\n *\n * By default, the result is rounded upward so it is greater than or equal to\n * the provided range. When `round` is `true`, the nearest human-friendly value\n * is returned instead.\n *\n * ---\n *\n * @param range - The positive numeric range to convert to a human-friendly value\n * @param round - Whether to return the nearest human-friendly value instead of rounding upward\n * @returns A human-friendly number expressed as `1`, `2`, `5`, or `10` times a power of ten\n *\n * @example\n * ```ts\n * niceNumber(37); // 50\n * niceNumber(23, true); // 20\n *```\n * ---\n *\n * Lore:\nWe talk about being in our 30s, and our 40s, and our 50s. We don’t talk about being in our 37s.\n */\nexport function niceNumber(range: number, round = false): number {\n  const exponent = Math.floor(Math.log10(range));\n  const magnitude = Math.pow(10, exponent);\n  const fraction = range / magnitude;\n  const epsilon = Number.EPSILON * Math.max(1, Math.abs(fraction));\n\n  let niceFraction: number;\n\n  if (round) {\n    if (fraction < 1.5 - epsilon) {\n      niceFraction = 1;\n    } else if (fraction < 3 - epsilon) {\n      niceFraction = 2;\n    } else if (fraction < 7 - epsilon) {\n      niceFraction = 5;\n    } else {\n      niceFraction = 10;\n    }\n  } else {\n    if (fraction <= 1 + epsilon) {\n      niceFraction = 1;\n    } else if (fraction <= 2 + epsilon) {\n      niceFraction = 2;\n    } else if (fraction <= 5 + epsilon) {\n      niceFraction = 5;\n    } else {\n      niceFraction = 10;\n    }\n  }\n\n  return niceFraction * magnitude;\n}\n"],"mappings":";AAwBA,SAAgB,EAAW,GAAe,IAAQ,IAAe;CAE/D,IAAM,IAAqB,MADV,KAAK,MAAM,KAAK,MAAM,CAAK,CACb,GACzB,IAAW,IAAQ,GACnB,eAA2B,KAAK,IAAI,GAAG,KAAK,IAAI,CAAQ,CAAC,GAE3D;CAwBJ,OAtBA,AAkBI,IAlBA,IACE,IAAW,MAAM,IACJ,IACN,IAAW,IAAI,IACT,IACN,IAAW,IAAI,IACT,IAEA,KAGb,KAAY,IAAI,IACH,IACN,KAAY,IAAI,IACV,IACN,KAAY,IAAI,IACV,IAEA,IAIZ,IAAe;AACxB"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@raindrops-on-roses/number-nice-number",
+  "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-nice-number"
+  }
+}