Update version to 4.7.1, rename countDecimalPlaces function to countDecimals, and add corresponding tests. Document changes in CHANGELOG.md and README.md.

Author: ogroppo

CHANGELOG.md

@@ -1,5 +1,11 @@
 # deverything
 
+## 4.7.1
+
+### Patch Changes
+
+- count decimals rename
+
 ## 4.7.0
 
 ### Minor Changes

README.md

@@ -77,7 +77,7 @@ Contributions always welcome!
 ### Math
 
 - `average()`
-- `countDecimalPlaces()` count the number of decimal places in a number
+- `countDecimals()` count the number of decimal places in a number
 - `isBetween()`
 - `isOutside()`
 - `isStrictlyBetween()`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "deverything",
-  "version": "4.7.0",
+  "version": "4.7.1",
   "description": "Everything you need for Dev",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

src/math/countDecimalPlaces.test.ts

@@ -0,0 +1,37 @@
+import { describe, expect, test } from "vitest";
+import { countDecimals } from "./countDecimals";
+
+describe("countDecimals", () => {
+  test("integers", () => {
+    expect(countDecimals(0)).toBe(0);
+    expect(countDecimals(1)).toBe(0);
+    expect(countDecimals(100)).toBe(0);
+    expect(countDecimals(-5)).toBe(0);
+  });
+
+  test("decimals", () => {
+    expect(countDecimals(1.5)).toBe(1);
+    expect(countDecimals(1.23)).toBe(2);
+    expect(countDecimals(1.234567)).toBe(6);
+    expect(countDecimals(0.1)).toBe(1);
+    expect(countDecimals(0.123456789)).toBe(9);
+  });
+
+  test("negative decimals", () => {
+    expect(countDecimals(-1.5)).toBe(1);
+    expect(countDecimals(-1.23)).toBe(2);
+    expect(countDecimals(-0.123)).toBe(3);
+  });
+
+  test("scientific notation", () => {
+    expect(countDecimals(1e-5)).toBe(5);
+    expect(countDecimals(1.23e-2)).toBe(4);
+    expect(countDecimals(1.5e2)).toBe(0);
+  });
+
+  test("edge cases", () => {
+    expect(countDecimals(Infinity)).toBe(0);
+    expect(countDecimals(-Infinity)).toBe(0);
+    expect(countDecimals(NaN)).toBe(0);
+  });
+});

src/math/countDecimals.test.ts

@@ -1,12 +1,12 @@
 /**
  * Counts the number of decimal places in a number.
  * @example
- * countDecimalPlaces(1.23); // 2
- * countDecimalPlaces(1.234567); // 6
- * countDecimalPlaces(5); // 0
- * countDecimalPlaces(0.1); // 1
+ * countDecimals(1.23); // 2
+ * countDecimals(1.234567); // 6
+ * countDecimals(5); // 0
+ * countDecimals(0.1); // 1
  */
-export const countDecimalPlaces = (num: number): number => {
+export const countDecimals = (num: number): number => {
   if (!Number.isFinite(num)) return 0;
 
   const numStr = num.toString();

src/math/countDecimalPlaces.ts src/math/countDecimals.tssrc/math/countDecimalPlaces.ts renamed to src/math/countDecimals.ts

@@ -1,5 +1,5 @@
 export * from "./average";
-export * from "./countDecimalPlaces";
+export * from "./countDecimals";
 export * from "./isBetween";
 export * from "./isOutside";
 export * from "./isStrictlyBetween";