@thi.ng/date 2.7.0 → 2.7.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-02-22T23:15:26Z
+- **Last updated**: 2024-02-28T14:23:30Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -73,7 +73,7 @@ For Node.js REPL:
 const date = await import("@thi.ng/date");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 5.38 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 5.43 KB
 
 ## Dependencies
 
@@ -280,8 +280,8 @@ Dates can be formatted as relative descriptions using
 [`formatRelative()`](https://docs.thi.ng/umbrella/date/functions/formatRelative.html)
 and
 [`formatRelativeParts()`](https://docs.thi.ng/umbrella/date/functions/formatRelativeParts.html).
-Both functions use the currently active [locale](#locales) and accept an optional
-reference date (default: now).
+Both functions use the currently active [locale](#locales) and accept an
+optional reference date (default: `now()`).
 
 ```ts
 setLocale(EN_LONG);
@@ -374,8 +374,10 @@ string literal, prefix the term with `\\`.
 
 The following preset formatters are available:
 
+- `FMT_ISO` - `"2020-09-13T21:42:07.123Z"`
 - `FMT_ISO_SHORT` - `"2020-09-13T21:42:07Z"`
 - `FMT_yyyyMMdd` - `"2020-09-13"`
+- `FMT_yyyyMMdd_ALT` - `"20200913"`
 - `FMT_Mdyyyy` - `"9/13/2020"`
 - `FMT_MMMdyyyy` - `"Sep 13 2020"`
 - `FMT_dMyyyy` - `"13/9/2020"`
@@ -384,7 +386,25 @@ The following preset formatters are available:
 - `FMT_HHmm` - `"21:42"`
 - `FMT_hm` - `"9:42 PM"`
 - `FMT_HHmmss` - `"21:42:07"`
+- `FMT_HHmmss_ALT` - `"214207"`
 - `FMT_hms` - `"9:42:07 PM"`
+- `FMT_yyyy` - `"2020"` (4 digit year)
+- `FMT_MM` - `"12"` (2 digit month)
+- `FMT_ww` - `"52"` (2 digit week)
+- `FMT_dd` - `"28"` (2 digit day in month)
+- `FMT_HH` - `"23"` (2 digit hour, 24h system)
+- `FMT_mm` - `"59"` (2 digit minute)
+- `FMT_ss` - `"01"` (2 digit second)
+
+All formatters are fully composable/nestable, i.e. new formats can be created
+using existing formats like so:
+
+```ts
+import { defFormat, FMT_HHmmss, FMT_yyyyMMdd } from "@thi.ng/date";
+
+defFormat([FMT_yyyyMMdd, " @ ", FMT_HHmmss])();
+// "2024-02-28 @ 12:05:47"
+```
 
 ### Timecodes
 

package/duration.d.ts

@@ -12,6 +12,8 @@ export declare const decomposeDuration: (dur: number) => number[];
  *
  * @example
  * ```ts
+ * import { composeDuration } from "@thi.ng/date";
+ *
  * composeDuration({ h: 12, m: 34, s: 56 })
  * // 45296000
  * ```
@@ -24,6 +26,7 @@ export declare const composeDuration: (parts: Partial<Record<Precision, number>>
  *
  * @example
  * ```ts
+ * import { durationAs } from "@thi.ng/date";
  * durationAs("d", difference("2023-02-01T12:00:00Z", "2023-01-01"))
  * // 31.5
  * ```

package/format.d.ts

@@ -15,6 +15,8 @@ export declare const FORMATTERS: Record<string, FormatFn>;
  *
  * @example
  * ```ts
+ * import { defFormat } from "@thi.ng/date";
+ *
  * const fmt = defFormat(["yyyy", "-", "MM", "-", "dd"]);
  *
  * fmt(new Date(2015, 3, 23))
@@ -128,6 +130,8 @@ export declare const FMT_ss: (x?: MaybeDate, utc?: boolean) => string;
  *
  * @example
  * ```ts
+ * import { formatRelative } from "@thi.ng/date";
+ *
  * formatRelative("2020-06-01", "2021-07-01")
  * // "1 year ago"
  *
@@ -160,6 +164,8 @@ export declare const formatRelative: (date: MaybeDate, base?: MaybeDate, prec?:
  *
  * @example
  * ```ts
+ * import { formatRelativeParts } from "@thi.ng/date";
+ *
  * // with default precision (seconds)
  * formatRelativeParts("2022-09-01 12:23:24", "2021-07-01 12:05")
  * // "in 1 year, 2 months, 21 hours, 18 minutes, 24 seconds"
@@ -184,6 +190,8 @@ export declare const formatRelativeParts: (date: MaybeDate, base?: MaybeDate, pr
  *
  * @example
  * ```ts
+ * import { formatDuration } from "@thi.ng/date";
+ *
  * formatDuration(45296000)
  * // "12 h, 34 min, 56 s"
  *

package/i18n.d.ts

@@ -38,6 +38,8 @@ export declare const monthNames: () => string[];
  *
  * @example
  * ```ts
+ * import { withLocale } from "@thi.ng/date";
+ *
  * withLocale(FR_LONG, () => units(1, "y"));
  * // "1 année"
  *
@@ -69,6 +71,8 @@ export declare const units: (x: number, unit: Precision | LocaleUnit, isDativ?:
  *
  * @example
  * ```ts
+ * import { withLocale } from "@thi.ng/date";
+ *
  * withLocale(DE_LONG, () => unitsLessThan(1, "y"));
  * // "weniger als 1 Jahr"
  * ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/date",
-  "version": "2.7.0",
+  "version": "2.7.2",
   "description": "Datetime types, relative dates, math, iterators, composable formatters, locales",
   "type": "module",
   "module": "./index.js",
@@ -35,9 +35,9 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.25",
+    "@thi.ng/api": "^8.9.26",
     "@thi.ng/checks": "^3.5.0",
-    "@thi.ng/strings": "^3.7.16"
+    "@thi.ng/strings": "^3.7.18"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.40.1",
@@ -132,5 +132,5 @@
   "thi.ng": {
     "year": 2020
   },
-  "gitHead": "16f2b92b5410bd35dcde6c2971c8e62783ebc472\n"
+  "gitHead": "190d68e7f7524631b333cfdbf32c6a23be27c166\n"
 }

package/timecode.d.ts

@@ -10,6 +10,8 @@
  *
  * @example
  * ```ts
+ * import { defTimecode } from "@thi.ng/date";
+ *
  * a = defTimecode(30);
  * a(HOUR + 2*MINUTE + 3*SECOND + 4*1000/30)
  * // "01:02:03:04"