@tim-code/my-util 0.8.0 → 0.8.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tim-code/my-util",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "description": "",
   "type": "module",
   "author": "Tim Sprowl",

package/src/array.js

@@ -194,6 +194,12 @@ function naturalCompare(a, b) {
     b = b.slice(1, b.length)
     return b.localeCompare(a, undefined, { numeric: true })
   }
+  if (a[0] === "+" && !Number.isNaN(Number(a))) {
+    a = a.slice(1, a.length)
+  }
+  if (b[0] === "+" && !Number.isNaN(Number(b))) {
+    b = b.slice(1, b.length)
+  }
   return a.localeCompare(b, undefined, { numeric: true })
 }
 

package/src/array.test.js

@@ -542,6 +542,18 @@ describe("naturalAsc", () => {
     arr.sort(naturalAsc())
     expect(arr).toEqual(["-10", "-2", "-1"])
   })
+
+  it("can sort negative to positive", () => {
+    const arr = ["-2", "+5", "0"]
+    arr.sort(naturalAsc())
+    expect(arr).toEqual(["-2", "0", "+5"])
+  })
+
+  it("handles leading plus signs on numeric-like strings", () => {
+    const arr = ["a", "+10", "+2", "+1"]
+    arr.sort(naturalAsc())
+    expect(arr).toEqual(["+1", "+2", "+10", "a"])
+  })
 })
 
 describe("naturalDesc", () => {
@@ -586,6 +598,18 @@ describe("naturalDesc", () => {
     arr.sort(naturalDesc())
     expect(arr).toEqual(["-1", "-2", "-10"])
   })
+
+  it("can sort positive to negative", () => {
+    const arr = ["+5", "-2", "0"]
+    arr.sort(naturalDesc())
+    expect(arr).toEqual(["+5", "0", "-2"])
+  })
+
+  it("handles leading plus signs on numeric-like strings (descending)", () => {
+    const arr = ["+1", "+2", "+10", "a"]
+    arr.sort(naturalDesc())
+    expect(arr).toEqual(["a", "+10", "+2", "+1"])
+  })
 })
 
 describe("multilevel", () => {

package/src/time.js

@@ -1,9 +1,5 @@
 import { mod } from "./math.js"
 
-// `floorMinute` at first glance seems ugly and something like `floor: "minute"` seems better.
-// However, practically and realistically, it doesn't seem like we need other values for floor besides "second" and "minute".
-// So, then it seems more problematic to rely on an exact string to be passed... probably would need to throw on some other value.
-// We don't really ever want to disable flooring because we want timestamp, date, and time returned to represent the same thing.
 /**
  * Gets various ways of representing the current time in EDT. Floors to nearest second by default.
  * @param {Object} $1
@@ -91,7 +87,7 @@ export function getDayIndexInWeek(string = today()) {
 
 /**
  * Get the minute from a time string.
- * @param {string} time HH:mm or HH:mm::ss
+ * @param {string} time HH:mm or HH:mm:ss
  * @returns {number} Between 0 and 59 inclusive
  */
 export function getMinute(time) {
@@ -264,3 +260,23 @@ export function getStartOfWeek(dateString) {
   const start = addDays(dateString, { days: -index })
   return start
 }
+
+/**
+ * Returns number of seconds from any combination of weeks, days, hours, and minutes.
+ * @param {Object} $1
+ * @param {number=} $1.weeks Default is 0
+ * @param {number=} $1.days Default is 0
+ * @param {number=} $1.hours Default is 0
+ * @param {number=} $1.minutes Default is 0
+ * @returns {number}
+ */
+export function convertToSeconds({ weeks = 0, days = 0, hours = 0, minutes = 0 }) {
+  if (!(weeks >= 0) || !(days >= 0) || !(hours >= 0) || !(minutes >= 0)) {
+    throw new Error("weeks, days, hours, and minutes must be nonnegative")
+  }
+  days += weeks * 7
+  hours += days * 24
+  minutes += hours * 60
+  const seconds = minutes * 60
+  return seconds
+}

package/src/time.test.js

@@ -2,6 +2,7 @@ import { describe, expect, test } from "@jest/globals"
 import {
   addDays,
   addTime,
+  convertToSeconds,
   getDateRange,
   getDayIndexInWeek,
   getEasternTime,
@@ -21,7 +22,7 @@ import {
 // Exported functions:
 // getEasternTime, getTime, getUnixTimestamp, today, getDayIndexInWeek, getMinute,
 // isDateString, isTimeString, isDateTimeString, isUTCString, isUnixTimestamp,
-// addTime, getTimeRange, addDays, getDateRange, getStartOfWeek
+// addTime, getTimeRange, addDays, getDateRange, getStartOfWeek, convertToSeconds
 
 describe("getEasternTime", () => {
   test("returns correct structure and types", () => {
@@ -586,3 +587,32 @@ describe("getStartOfWeek", () => {
     expect(getStartOfWeek("2023-01-02")).toBe("2023-01-01")
   })
 })
+
+describe("convertToSeconds", () => {
+  test("returns 0 for empty input object", () => {
+    expect(convertToSeconds({})).toBe(0)
+  })
+
+  test("converts single units correctly", () => {
+    expect(convertToSeconds({ minutes: 5 })).toBe(5 * 60)
+    expect(convertToSeconds({ hours: 2 })).toBe(2 * 3600)
+    expect(convertToSeconds({ days: 1 })).toBe(24 * 3600)
+    expect(convertToSeconds({ weeks: 1 })).toBe(7 * 24 * 3600)
+  })
+
+  test("converts combined weeks, days, hours, and minutes", () => {
+    // 1w + 2d + 3h + 4m = 788640 seconds
+    expect(convertToSeconds({ weeks: 1, days: 2, hours: 3, minutes: 4 })).toBe(788640)
+  })
+
+  test("supports fractional values (minutes: 0.5 => 30 seconds)", () => {
+    expect(convertToSeconds({ minutes: 0.5 })).toBe(30)
+  })
+
+  test("throws if any value is negative", () => {
+    const cases = [{ weeks: -1 }, { days: -1 }, { hours: -1 }, { minutes: -1 }]
+    for (const opts of cases) {
+      expect(() => convertToSeconds(opts)).toThrow("must be nonnegative")
+    }
+  })
+})