@ehmpathy/uni-time 1.8.2 → 1.9.0

package/dist/index.d.ts

@@ -10,5 +10,6 @@ export * from './logic/manipulate/addDuration';
 export * from './logic/manipulate/getDuration';
 export * from './logic/manipulate/subDuration';
 export * from './logic/manipulate/toMilliseconds';
+export * from './logic/manipulate/asDurationInWords';
 export * from './logic/wrappers/waitFor';
 export * from './logic/observe/stopwatch/startDurationStopwatch';

package/dist/index.js

@@ -26,6 +26,7 @@ __exportStar(require("./logic/manipulate/addDuration"), exports);
 __exportStar(require("./logic/manipulate/getDuration"), exports);
 __exportStar(require("./logic/manipulate/subDuration"), exports);
 __exportStar(require("./logic/manipulate/toMilliseconds"), exports);
+__exportStar(require("./logic/manipulate/asDurationInWords"), exports);
 __exportStar(require("./logic/wrappers/waitFor"), exports);
 __exportStar(require("./logic/observe/stopwatch/startDurationStopwatch"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,uDAAqC;AACrC,sDAAoC;AACpC,+DAA6C;AAC7C,oEAAkD;AAClD,2DAAyC;AACzC,4DAA0C;AAC1C,yEAAuD;AACvD,iEAA+C;AAC/C,iEAA+C;AAC/C,iEAA+C;AAC/C,oEAAkD;AAClD,2DAAyC;AACzC,mFAAiE"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,uDAAqC;AACrC,sDAAoC;AACpC,+DAA6C;AAC7C,oEAAkD;AAClD,2DAAyC;AACzC,4DAA0C;AAC1C,yEAAuD;AACvD,iEAA+C;AAC/C,iEAA+C;AAC/C,iEAA+C;AAC/C,oEAAkD;AAClD,uEAAqD;AACrD,2DAAyC;AACzC,mFAAiE"}

package/dist/logic/manipulate/asDurationInWords.d.ts

@@ -0,0 +1,12 @@
+import { UniDuration } from '../../domain/UniDuration';
+/**
+ * .what = stringify a UniDuration into short human words
+ * .why  = minimum-surface-area: one obvious input, safe defaults
+ * .how  =
+ *   - order: weeks → ms
+ *   - skip zeros
+ *   - max 2 nonzero units
+ *   - compact labels (e.g. 2h 5m)
+ *   - fallback "0s" when all zero
+ */
+export declare const asDurationInWords: (duration: UniDuration) => string;

package/dist/logic/manipulate/asDurationInWords.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.asDurationInWords = void 0;
+const DURATION_ORDER = [
+    'weeks',
+    'days',
+    'hours',
+    'minutes',
+    'seconds',
+    'milliseconds',
+];
+const SHORT_LABELS = {
+    weeks: 'w',
+    days: 'd',
+    hours: 'h',
+    minutes: 'm',
+    seconds: 's',
+    milliseconds: 'ms',
+};
+/**
+ * .what = stringify a UniDuration into short human words
+ * .why  = minimum-surface-area: one obvious input, safe defaults
+ * .how  =
+ *   - order: weeks → ms
+ *   - skip zeros
+ *   - max 2 nonzero units
+ *   - compact labels (e.g. 2h 5m)
+ *   - fallback "0s" when all zero
+ */
+const asDurationInWords = (duration) => {
+    const norm = Object.fromEntries(DURATION_ORDER.map((u) => {
+        const n = Number(duration?.[u] ?? 0);
+        return [u, Number.isFinite(n) ? Math.max(0, n) : 0];
+    }));
+    const parts = [];
+    for (const u of DURATION_ORDER) {
+        const v = norm[u];
+        if (!v)
+            continue;
+        parts.push(`${v}${SHORT_LABELS[u]}`);
+        if (parts.length === 2)
+            break;
+    }
+    return parts.length ? parts.join(' ') : '0s';
+};
+exports.asDurationInWords = asDurationInWords;
+//# sourceMappingURL=asDurationInWords.js.map

package/dist/logic/manipulate/asDurationInWords.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asDurationInWords.js","sourceRoot":"","sources":["../../../src/logic/manipulate/asDurationInWords.ts"],"names":[],"mappings":";;;AAEA,MAAM,cAAc,GAAG;IACrB,OAAO;IACP,MAAM;IACN,OAAO;IACP,SAAS;IACT,SAAS;IACT,cAAc;CACN,CAAC;AAIX,MAAM,YAAY,GAAyB;IACzC,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,GAAG;IACT,KAAK,EAAE,GAAG;IACV,OAAO,EAAE,GAAG;IACZ,OAAO,EAAE,GAAG;IACZ,YAAY,EAAE,IAAI;CACnB,CAAC;AAEF;;;;;;;;;GASG;AACI,MAAM,iBAAiB,GAAG,CAAC,QAAqB,EAAU,EAAE;IACjE,MAAM,IAAI,GAAyB,MAAM,CAAC,WAAW,CACnD,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACvB,MAAM,CAAC,GAAG,MAAM,CAAE,QAAgB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9C,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CACqB,CAAC;IAE1B,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,CAAC,IAAI,cAAc,EAAE,CAAC;QAC/B,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,IAAI,CAAC,CAAC;YAAE,SAAS;QACjB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACrC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,MAAM;IAChC,CAAC;IAED,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/C,CAAC,CAAC;AAjBW,QAAA,iBAAiB,qBAiB5B"}

package/dist/logic/manipulate/asDurationInWords.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/logic/manipulate/asDurationInWords.test.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const asDurationInWords_1 = require("./asDurationInWords");
+describe('asDurationInWords', () => {
+    const cases = [
+        { input: { hours: 2, minutes: 5 }, output: '2h 5m' },
+        { input: { minutes: 1, seconds: 0 }, output: '1m' },
+        { input: { hours: 1, minutes: 59, seconds: 32 }, output: '1h 59m' },
+        { input: { milliseconds: 350 }, output: '350ms' },
+        { input: {}, output: '0s' },
+    ];
+    it.each(cases)('%j', ({ input, output }) => {
+        expect((0, asDurationInWords_1.asDurationInWords)(input)).toBe(output);
+    });
+});
+//# sourceMappingURL=asDurationInWords.test.js.map

package/dist/logic/manipulate/asDurationInWords.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asDurationInWords.test.js","sourceRoot":"","sources":["../../../src/logic/manipulate/asDurationInWords.test.ts"],"names":[],"mappings":";;AACA,2DAAwD;AAExD,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,MAAM,KAAK,GAA6C;QACtD,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE;QACpD,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;QACnD,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE;QACnE,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE;QACjD,EAAE,KAAK,EAAE,EAAiB,EAAE,MAAM,EAAE,IAAI,EAAE;KAC3C,CAAC;IAEF,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE;QACzC,MAAM,CAAC,IAAA,qCAAiB,EAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@ehmpathy/uni-time",
   "author": "ehmpathy",
   "description": "a glossary of universally intuitive time, date, and duration domain literals",
-  "version": "1.8.2",
+  "version": "1.9.0",
   "repository": "ehmpathy/uni-time",
   "homepage": "https://github.com/ehmpathy/uni-time",
   "keywords": [