@douglasneuroinformatics/libjs 0.7.0 → 0.8.0

package/dist/datetime.d.ts

@@ -1,3 +1,12 @@
+export type Duration = {
+    days: number;
+    hours: number;
+    milliseconds: number;
+    minutes: number;
+    seconds: number;
+};
+/** A map that associates time units with their corresponding values in milliseconds */
+export declare const TIME_MAP: Map<"day" | "hour" | "minute" | "second" | "millisecond", number>;
 /**
  * Returns the data in basic ISO format, e.g., yyyy-mm-dd
  * @example
@@ -25,4 +34,12 @@ export declare function yearsPassed(date: Date): number;
  * ```
  */
 export declare function sleep(seconds: number): Promise<unknown>;
+/**
+ * Parses a given duration in milliseconds into an object representing the duration in days, hours, minutes, seconds, and milliseconds.
+ *
+ * @param milliseconds - The duration in milliseconds to be parsed.
+ * @returns An object of type `Duration` representing the parsed duration.
+ * @throws Will throw an error if the input duration is negative.
+ */
+export declare function parseDuration(milliseconds: number): Duration;
 //# sourceMappingURL=datetime.d.ts.map

package/dist/datetime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"datetime.d.ts","sourceRoot":"","sources":["../src/datetime.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEnD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE9C;AAED;;;;;;GAMG;AACH,wBAAsB,KAAK,CAAC,OAAO,EAAE,MAAM,oBAE1C"}
+{"version":3,"file":"datetime.d.ts","sourceRoot":"","sources":["../src/datetime.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,uFAAuF;AACvF,eAAO,MAAM,QAAQ,mEAMV,CAAC;AAEZ;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEnD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE9C;AAED;;;;;;GAMG;AACH,wBAAsB,KAAK,CAAC,OAAO,EAAE,MAAM,oBAE1C;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,QAAQ,CAY5D"}

package/dist/datetime.js

@@ -1,3 +1,11 @@
+/** A map that associates time units with their corresponding values in milliseconds */
+export const TIME_MAP = new Map([
+    ['day', 24 * 60 * 60 * 1000],
+    ['hour', 60 * 60 * 1000],
+    ['minute', 60 * 1000],
+    ['second', 1000],
+    ['millisecond', 1]
+]);
 /**
  * Returns the data in basic ISO format, e.g., yyyy-mm-dd
  * @example
@@ -31,3 +39,23 @@ export function yearsPassed(date) {
 export async function sleep(seconds) {
     return new Promise((resolve) => setTimeout(resolve, seconds * 1000));
 }
+/**
+ * Parses a given duration in milliseconds into an object representing the duration in days, hours, minutes, seconds, and milliseconds.
+ *
+ * @param milliseconds - The duration in milliseconds to be parsed.
+ * @returns An object of type `Duration` representing the parsed duration.
+ * @throws Will throw an error if the input duration is negative.
+ */
+export function parseDuration(milliseconds) {
+    if (0 > milliseconds) {
+        throw new Error(`Cannot parse negative length of time: ${milliseconds}`);
+    }
+    const duration = {};
+    let remaining = milliseconds;
+    TIME_MAP.forEach((value, unit) => {
+        const count = Math.floor(remaining / value);
+        duration[`${unit}s`] = count;
+        remaining %= value;
+    });
+    return duration;
+}

package/dist/datetime.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { sleep, toBasicISOString, yearsPassed } from './datetime.js';
+import { parseDuration, sleep, toBasicISOString, yearsPassed } from './datetime.js';
 describe('toBasicISOString', () => {
     it('should return a string of the format yyyy-mm-dd', () => {
         expect(toBasicISOString(new Date(2000, 0, 1))).toBe('2000-01-01');
@@ -25,3 +25,83 @@ describe('sleep', () => {
         expect(end - start).toBeGreaterThanOrEqual(200);
     });
 });
+describe('parseDuration', () => {
+    it('should fail to parse a negative duration', () => {
+        expect(() => parseDuration(-1)).toThrow('Cannot parse negative length of time: -1');
+    });
+    it('should parse a duration of zero', () => {
+        expect(parseDuration(0)).toEqual({
+            days: 0,
+            hours: 0,
+            milliseconds: 0,
+            minutes: 0,
+            seconds: 0
+        });
+    });
+    it('should parse a duration less than a second', () => {
+        expect(parseDuration(50)).toEqual({
+            days: 0,
+            hours: 0,
+            milliseconds: 50,
+            minutes: 0,
+            seconds: 0
+        });
+        expect(parseDuration(500)).toEqual({
+            days: 0,
+            hours: 0,
+            milliseconds: 500,
+            minutes: 0,
+            seconds: 0
+        });
+    });
+    it('should parse a duration less than one minute but more than one second', () => {
+        expect(parseDuration(11_100)).toEqual({
+            days: 0,
+            hours: 0,
+            milliseconds: 100,
+            minutes: 0,
+            seconds: 11
+        });
+    });
+    it('should parse a duration less than one hour but more than one minute', () => {
+        expect(parseDuration(60_000)).toEqual({
+            days: 0,
+            hours: 0,
+            milliseconds: 0,
+            minutes: 1,
+            seconds: 0
+        });
+        expect(parseDuration(62_500)).toEqual({
+            days: 0,
+            hours: 0,
+            milliseconds: 500,
+            minutes: 1,
+            seconds: 2
+        });
+    });
+    it('should parse a duration less than one day but more than one hour', () => {
+        expect(parseDuration(3_600_000)).toEqual({
+            days: 0,
+            hours: 1,
+            milliseconds: 0,
+            minutes: 0,
+            seconds: 0
+        });
+    });
+    it('should parse a duration greater than one day', () => {
+        expect(parseDuration(86_400_000)).toEqual({
+            days: 1,
+            hours: 0,
+            milliseconds: 0,
+            minutes: 0,
+            seconds: 0
+        });
+        expect(parseDuration(4_351_505_030)).toEqual({
+            days: 50,
+            hours: 8,
+            milliseconds: 30,
+            minutes: 45,
+            seconds: 5
+        });
+    });
+});

package/dist/string.js

@@ -24,4 +24,3 @@ export function format(s, ...args) {
     }
     return s;
 }
-console.log(format('Hello {}', 'World'));

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@douglasneuroinformatics/libjs",
   "type": "module",
-  "version": "0.7.0",
-  "packageManager": "pnpm@9.3.0",
+  "version": "0.8.0",
+  "packageManager": "pnpm@9.11.0",
   "description": "A collection of utility functions and types for Node.js and the browser",
   "author": "Joshua Unrau",
   "license": "Apache-2.0",