@tim-code/my-util 0.0.10 → 0.0.11

package/package.json

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

package/src/math.js

@@ -1,9 +1,26 @@
 /**
- * Module safe for negative numbers i.e. mod(-1, 3) === 2 (not -1 as in -1 % 3).
- * @param {number} n
- * @param {number} m If 0, returns NaN as does n % m.
+ * Gives the remainder when the number is divided by modulus.
+ * The sign of the remainder is always the same as the modulus i.e. mod(-1, 3) === 2 (not -1 as in -1 % 3).
+ * @param {number} number
+ * @param {number} modulus If 0, returns NaN as does n % m.
  * @returns {number}
  */
-export function mod(n, m) {
-  return ((n % m) + m) % m
+export function mod(number, modulus) {
+  return ((number % modulus) + modulus) % modulus
+}
+
+/**
+ * Convert a number to a string and prepend a plus if the number is positive.
+ * @param {number} number
+ * @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}
+ */
+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}`
+  }
+  return `${string}`
 }

package/src/math.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "@jest/globals"
-const { mod } = await import("./math.js")
+const { mod, formatPlus } = await import("./math.js")
 
 describe("mod", () => {
   it("returns n when n is less than m and n is non-negative", () => {
@@ -34,4 +34,68 @@ describe("mod", () => {
     expect(mod(0, 0)).toBeNaN()
     expect(mod(-3, 0)).toBeNaN()
   })
+
+  // All sign combinations for number and modulus
+  it("handles all sign combinations for number and modulus", () => {
+    // number > 0, modulus > 0
+    expect(mod(5, 3)).toBe(2)
+    // number > 0, modulus < 0
+    expect(mod(5, -3)).toBe(-1)
+    // number < 0, modulus > 0
+    expect(mod(-5, 3)).toBe(1)
+    // number < 0, modulus < 0
+    expect(mod(-5, -3)).toBe(-2)
+    // number = 0, modulus > 0
+    expect(mod(0, 3)).toBe(0)
+    // number = 0, modulus < 0
+    expect(mod(0, -3)).toBe(-0)
+    // number > 0, modulus = 0
+    expect(mod(5, 0)).toBeNaN()
+    // number < 0, modulus = 0
+    expect(mod(-5, 0)).toBeNaN()
+    // number = 0, modulus = 0
+    expect(mod(0, 0)).toBeNaN()
+  })
+})
+
+describe("formatPlus", () => {
+  it("prepends a plus for positive numbers", () => {
+    expect(formatPlus(1)).toBe("+1")
+    expect(formatPlus(123.45)).toBe("+123.45")
+  })
+
+  it("does not prepend a plus for negative numbers", () => {
+    expect(formatPlus(-1)).toBe("-1")
+    expect(formatPlus(-123.45)).toBe("-123.45")
+  })
+
+  it("does not prepend a plus for zero by default", () => {
+    expect(formatPlus(0)).toBe("0")
+  })
+
+  it("prepends a plus for zero if zero option is true", () => {
+    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")
+  })
 })