@thi.ng/date 2.7.5 → 2.7.7

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-03-07T20:40:47Z
+- **Last updated**: 2024-03-13T14:04:31Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/duration.d.ts

@@ -11,10 +11,12 @@ export declare const decomposeDuration: (dur: number) => number[];
  * {@link decomposeDuration}.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/compose-duration.ts
  * import { composeDuration } from "@thi.ng/date";
  *
- * composeDuration({ h: 12, m: 34, s: 56 })
+ * console.log(
+ *   composeDuration({ h: 12, m: 34, s: 56 })
+ * );
  * // 45296000
  * ```
  *
@@ -25,9 +27,12 @@ export declare const composeDuration: (parts: Partial<Record<Precision, number>>
  * Calculates the given duration in units of given `prec`ision.
  *
  * @example
- * ```ts
- * import { durationAs } from "@thi.ng/date";
- * durationAs("d", difference("2023-02-01T12:00:00Z", "2023-01-01"))
+ * ```ts tangle:../export/duration-as.ts
+ * import { durationAs, difference } from "@thi.ng/date";
+ *
+ * console.log(
+ *   durationAs("d", difference("2023-02-01T12:00:00Z", "2023-01-01"))
+ * );
  * // 31.5
  * ```
  *

package/format.d.ts

@@ -14,15 +14,19 @@ export declare const FORMATTERS: Record<string, FormatFn>;
  * formatter and use as a string literal, prefix the term with `\\`.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/def-format.ts
  * import { defFormat } from "@thi.ng/date";
  *
  * const fmt = defFormat(["yyyy", "-", "MM", "-", "dd"]);
  *
- * fmt(new Date(2015, 3, 23))
+ * console.log(
+ *   fmt(new Date(2015, 3, 23))
+ * );
  * // "2015-04-23"
  *
- * defFormat(["\\yyyy"])(new Date(2015, 3, 23))
+ * console.log(
+ *   defFormat(["\\yyyy"])(new Date(2015, 3, 23))
+ * );
  * // "yyyy"
  * ```
  *
@@ -129,19 +133,27 @@ export declare const FMT_ss: (x?: MaybeDate, utc?: boolean) => string;
  *
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/format-relative.ts
  * import { formatRelative } from "@thi.ng/date";
  *
- * formatRelative("2020-06-01", "2021-07-01")
+ * console.log(
+ *   formatRelative("2020-06-01", "2021-07-01")
+ * );
  * // "1 year ago"
  *
- * formatRelative("2020-08-01", "2021-07-01")
+ * console.log(
+ *   formatRelative("2020-08-01", "2021-07-01")
+ * );
  * // "11 months ago"
  *
- * formatRelative("2021-07-01 13:45", "2021-07-01 12:05")
+ * console.log(
+ *   formatRelative("2021-07-01 13:45", "2021-07-01 12:05")
+ * );
  * // "in 2 hours"
  *
- * formatRelative("2021-07-01 12:23:24", "2021-07-01 12:05")
+ * console.log(
+ *   formatRelative("2021-07-01 12:23:24", "2021-07-01 12:05")
+ * );
  * // "in 18 minutes"
  * ```
  *
@@ -163,18 +175,26 @@ export declare const formatRelative: (date: MaybeDate, base?: MaybeDate, prec?:
  * given dates to extract parts for formatting.
  *
  * @example
- * ```ts
- * import { formatRelativeParts } from "@thi.ng/date";
+ * ```ts tangle:../export/format-relative-parts.ts
+ * import { formatRelativeParts, setLocale, EN_LONG } from "@thi.ng/date";
+ *
+ * setLocale(EN_LONG);
  *
  * // with default precision (seconds)
- * formatRelativeParts("2022-09-01 12:23:24", "2021-07-01 12:05")
+ * console.log(
+ *   formatRelativeParts("2022-09-01 12:23:24", "2021-07-01 12:05")
+ * );
  * // "in 1 year, 2 months, 21 hours, 18 minutes, 24 seconds"
  *
  * // with day precision
- * formatRelativeParts("2012-12-25 17:59", "2021-07-01 12:05", "d")
+ * console.log(
+ *   formatRelativeParts("2012-12-25 17:59", "2021-07-01 12:05", "d")
+ * );
  * // "8 years, 6 months, 5 days ago"
  *
- * formatRelativeParts("2021-07-01 17:59", "2021-07-01 12:05", "d")
+ * console.log(
+ *   formatRelativeParts("2021-07-01 17:59", "2021-07-01 12:05", "d")
+ * );
  * // "in less than a day"
  * ```
  *
@@ -189,16 +209,22 @@ export declare const formatRelativeParts: (date: MaybeDate, base?: MaybeDate, pr
  * {@link LOCALE}.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/format-duration.ts
  * import { formatDuration } from "@thi.ng/date";
  *
- * formatDuration(45296000)
+ * console.log(
+ *   formatDuration(45296000)
+ * );
  * // "12 h, 34 min, 56 s"
  *
- * formatDuration(45296000, "h")
+ * console.log(
+ *   formatDuration(45296000, "h")
+ * );
  * // "13 h"
  *
- * formatDuration(45296000,"d")
+ * console.log(
+ *   formatDuration(45296000,"d")
+ * );
  * // "< 1 d"
  * ```
  *

package/i18n.d.ts

@@ -37,25 +37,37 @@ export declare const monthNames: () => string[];
  * {@link formatRelativeParts}.
  *
  * @example
- * ```ts
- * import { withLocale } from "@thi.ng/date";
+ * ```ts tangle:../export/units.ts
+ * import { units, withLocale, FR_LONG, DE_LONG } from "@thi.ng/date";
  *
- * withLocale(FR_LONG, () => units(1, "y"));
+ * console.log(
+ *   withLocale(FR_LONG, () => units(1, "y"))
+ * );
  * // "1 année"
  *
- * withLocale(FR_LONG, () => units(1, "y", true));
+ * console.log(
+ *   withLocale(FR_LONG, () => units(1, "y", true))
+ * );
  * // "1 an"
  *
- * withLocale(FR_LONG, () => units(2, "y"));
+ * console.log(
+ *   withLocale(FR_LONG, () => units(2, "y"))
+ * );
  * // "2 ans"
  *
- * withLocale(FR_LONG, () => units(2, "y", true));
+ * console.log(
+ *   withLocale(FR_LONG, () => units(2, "y", true))
+ * );
  * // "2 ans"
  *
- * withLocale(DE_LONG, () => units(2, "y"));
+ * console.log(
+ *   withLocale(DE_LONG, () => units(2, "y"))
+ * );
  * // "2 Jahre"
  *
- * withLocale(DE_LONG, () => units(2, "y", true));
+ * console.log(
+ *   withLocale(DE_LONG, () => units(2, "y", true))
+ * );
  * // "2 Jahren"
  * ```
  *
@@ -70,10 +82,12 @@ export declare const units: (x: number, unit: Precision | LocaleUnit, isDativ?:
  * than {x} {unit(s)}`.
  *
  * @example
- * ```ts
- * import { withLocale } from "@thi.ng/date";
+ * ```ts tangle:../export/units-less-than.ts
+ * import { unitsLessThan, withLocale, DE_LONG } from "@thi.ng/date";
  *
- * withLocale(DE_LONG, () => unitsLessThan(1, "y"));
+ * console.log(
+ *   withLocale(DE_LONG, () => unitsLessThan(1, "y"))
+ * );
  * // "weniger als 1 Jahr"
  * ```
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/date",
-  "version": "2.7.5",
+  "version": "2.7.7",
   "description": "Datetime types, relative dates, math, iterators, composable formatters, locales",
   "type": "module",
   "module": "./index.js",
@@ -36,16 +36,16 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.28",
-    "@thi.ng/checks": "^3.5.2",
-    "@thi.ng/strings": "^3.7.21"
+    "@thi.ng/api": "^8.9.30",
+    "@thi.ng/checks": "^3.5.3",
+    "@thi.ng/strings": "^3.7.23"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.40.1",
-    "esbuild": "^0.20.0",
+    "@microsoft/api-extractor": "^7.42.3",
+    "esbuild": "^0.20.1",
     "rimraf": "^5.0.5",
-    "typedoc": "^0.25.7",
-    "typescript": "^5.3.3"
+    "typedoc": "^0.25.12",
+    "typescript": "^5.4.2"
   },
   "keywords": [
     "datastructure",
@@ -133,5 +133,5 @@
   "thi.ng": {
     "year": 2020
   },
-  "gitHead": "a421058a65ba76608d94129ac29451bfedaf201c\n"
+  "gitHead": "7f3fcbd6c0462b0ce45afa141fe163d1f297fd51\n"
 }

package/timecode.d.ts

@@ -9,18 +9,24 @@
  * via 2nd arg (default: all `:`).
  *
  * @example
- * ```ts
- * import { defTimecode } from "@thi.ng/date";
+ * ```ts tangle:../export/timecode.ts
+ * import { defTimecode, DAY, HOUR, MINUTE, SECOND } from "@thi.ng/date";
  *
- * a = defTimecode(30);
- * a(HOUR + 2*MINUTE + 3*SECOND + 4*1000/30)
+ * const fmt = defTimecode(30);
+ *
+ * console.log(
+ *   fmt(HOUR + 2*MINUTE + 3*SECOND + 4*1000/30)
+ * );
  * // "01:02:03:04"
  *
- * a(DAY);
+ * console.log(fmt(DAY));
  * // "01:00:00:00:00"
  *
- * b = defTimecode(30, ["d ", "h ", "' ", '" ']);
- * b(Day + HOUR + 2*MINUTE + 3*SECOND + 999)
+ * const fmt2 = defTimecode(30, ["d ", "h ", "' ", '" ']);
+ *
+ * console.log(
+ *   fmt2(DAY + HOUR + 2 * MINUTE + 3 * SECOND + 999)
+ * );
  * // "01d 01h 02' 03" 29"
  * ```
  *