@oliversalzburg/js-utils 0.0.45-dev.8 → 0.0.45

package/format/count.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Convert counts to a human readable string: `1234` → `1.234K`.
+ * @param count - The count to format.
+ * @returns The formatted string.
+ * @group Formatting
+ */
+export declare const formatCount: (count: number | bigint) => string;

package/format/count.js

@@ -0,0 +1,14 @@
+/**
+ * Convert counts to a human readable string: `1234` → `1.234K`.
+ * @param count - The count to format.
+ * @returns The formatted string.
+ * @group Formatting
+ */
+export const formatCount = (count) => {
+    return new Intl.NumberFormat(undefined, {
+        compactDisplay: "short",
+        maximumFractionDigits: 3,
+        notation: "compact",
+    }).format(count);
+};
+//# sourceMappingURL=count.js.map

package/format/count.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"count.js","sourceRoot":"","sources":["../../source/format/count.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAsB,EAAU,EAAE;IAC5D,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE;QACtC,cAAc,EAAE,OAAO;QACvB,qBAAqB,EAAE,CAAC;QACxB,QAAQ,EAAE,SAAS;KACpB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACnB,CAAC,CAAC"}

package/format/count.test.d.ts

@@ -0,0 +1 @@
+export {};

package/format/count.test.js

@@ -0,0 +1,13 @@
+import { expect } from "chai";
+import { it } from "mocha";
+import { formatCount } from "./count.js";
+it("formats counts as expected", () => {
+    expect(formatCount(-1)).to.equal("-1");
+    expect(formatCount(0)).to.equal("0");
+    expect(formatCount(1)).to.equal("1");
+    expect(formatCount(10)).to.equal("10");
+    expect(formatCount(100)).to.equal("100");
+    expect(formatCount(1000)).to.equal("1K");
+    expect(formatCount(1234)).to.equal("1.234K");
+});
+//# sourceMappingURL=count.test.js.map

package/format/count.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"count.test.js","sourceRoot":"","sources":["../../source/format/count.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;IACpC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACrC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACrC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACzC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;AAC/C,CAAC,CAAC,CAAC"}

package/format/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./bytes.js";
+export * from "./count.js";
 export * from "./milliseconds.js";
 export * from "./string.js";

package/format/index.js

@@ -1,4 +1,5 @@
 export * from "./bytes.js";
+export * from "./count.js";
 export * from "./milliseconds.js";
 export * from "./string.js";
 //# sourceMappingURL=index.js.map

package/format/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/format/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/format/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@oliversalzburg/js-utils",
-  "version": "0.0.45-dev.8",
+  "version": "0.0.45",
   "license": "MIT",
   "author": "Oliver Salzburg <oliver.salzburg@gmail.com>",
   "repository": {
@@ -42,14 +42,14 @@
     "@types/chai": "4.3.16",
     "@types/eslint": "8.56.10",
     "@types/mocha": "10.0.6",
-    "@types/node": "20.12.12",
+    "@types/node": "20.12.13",
     "@types/web": "0.0.147",
     "c8": "9.1.0",
     "chai": "5.1.1",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-jsdoc": "48.2.6",
-    "eslint-plugin-tsdoc": "0.2.17",
+    "eslint-plugin-jsdoc": "48.2.7",
+    "eslint-plugin-tsdoc": "0.3.0",
     "globals": "15.3.0",
     "lint-staged": "15.2.5",
     "mocha": "10.4.0",