@tim-code/my-util 0.0.11 → 0.0.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tim-code/my-util",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "",
   "type": "module",
   "author": "",

package/src/math.js

@@ -10,17 +10,23 @@ export function mod(number, modulus) {
 }
 
 /**
- * Convert a number to a string and prepend a plus if the number is positive.
- * @param {number} number
+ * Prepend a plus to a number or string if positive.
+ * @param {number|string} number Or string
  * @param {Object} $1
  * @param {boolean=} $1.zero If true, prepends a plus to zero as well.
- * @param {number=} $1.decimals If a number, uses .toFixed(decimals) instead of .toString()
- * @returns {string}
+ * @returns {string|undefined} Returns undefined if number is not a number or string. NaN return undefined.
  */
-export function formatPlus(number, { zero = false, decimals = undefined } = {}) {
-  const string = typeof decimals === "number" ? number.toFixed(decimals) : number.toString()
-  if (number > 0 || (number === 0 && zero)) {
-    return `+${string}`
+export function formatPlus(number, { zero = false } = {}) {
+  if (typeof number === "number" && !isNaN(number)) {
+    if (number > 0 || (zero && number === 0)) {
+      return `+${number}`
+    }
+    return `${number}`
+  } else if (typeof number === "string") {
+    if (number === "0" ? zero : number[0] !== "-") {
+      return `+${number}`
+    }
+    return number
   }
-  return `${string}`
+  return undefined
 }

package/src/math.test.js

@@ -77,25 +77,39 @@ describe("formatPlus", () => {
     expect(formatPlus(0, { zero: true })).toBe("+0")
   })
 
-  it("uses toFixed when decimals option is provided", () => {
-    expect(formatPlus(1.234, { decimals: 2 })).toBe("+1.23")
-    expect(formatPlus(-1.234, { decimals: 1 })).toBe("-1.2")
-    expect(formatPlus(0, { decimals: 3, zero: true })).toBe("+0.000")
-    expect(formatPlus(0, { decimals: 3 })).toBe("0.000")
-  })
-
-  it("handles zero with decimals and zero=true", () => {
-    expect(formatPlus(0, { decimals: 2, zero: true })).toBe("+0.00")
-  })
-
   it("handles undefined options argument", () => {
     expect(formatPlus(5)).toBe("+5")
     expect(formatPlus(-5)).toBe("-5")
     expect(formatPlus(0)).toBe("0")
   })
 
-  it("does not use toFixed if decimals is 0 (current behavior)", () => {
-    expect(formatPlus(1.99, { decimals: 0 })).toBe("+2")
-    expect(formatPlus(-1.99, { decimals: 0 })).toBe("-2")
+  // String input cases
+  it("prepends a plus for positive string numbers", () => {
+    expect(formatPlus("5")).toBe("+5")
+    expect(formatPlus("123.45")).toBe("+123.45")
+  })
+
+  it("does not prepend a plus for negative string numbers", () => {
+    expect(formatPlus("-5")).toBe("-5")
+    expect(formatPlus("-123.45")).toBe("-123.45")
+  })
+
+  it("prepends a plus for string zero if zero option is true", () => {
+    expect(formatPlus("0", { zero: true })).toBe("+0")
+  })
+
+  it("does not prepend a plus for string zero if zero option is false", () => {
+    expect(formatPlus("0")).toBe("0")
+  })
+
+  it("returns undefined for non-number, non-string input", () => {
+    expect(formatPlus(undefined)).toBeUndefined()
+    // eslint-disable-next-line no-restricted-syntax
+    expect(formatPlus(null)).toBeUndefined()
+    expect(formatPlus({})).toBeUndefined()
+    expect(formatPlus([])).toBeUndefined()
+    expect(formatPlus(true)).toBeUndefined()
+    expect(formatPlus(Symbol("x"))).toBeUndefined()
+    expect(formatPlus(NaN)).toBeUndefined()
   })
 })