@openmrs/esm-framework 11.0.1-pre.5906 → 11.0.1-pre.5917

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/docs/functions/convertToLocaleCalendar.md +1 -1
  3. package/docs/functions/duration.md +1 -1
  4. package/docs/functions/formatDate.md +1 -1
  5. package/docs/functions/formatDatetime.md +1 -1
  6. package/docs/functions/formatDuration.md +1 -1
  7. package/docs/functions/formatDurationBetween.md +1 -1
  8. package/docs/functions/formatPartialDate.md +1 -1
  9. package/docs/functions/formatTime.md +1 -1
  10. package/docs/functions/getDefaultCalendar.md +1 -1
  11. package/docs/functions/isOmrsDateStrict.md +1 -1
  12. package/docs/functions/isOmrsDateToday.md +1 -1
  13. package/docs/functions/parseDate.md +1 -1
  14. package/docs/functions/parseDateInput.md +3 -3
  15. package/docs/functions/registerDefaultCalendar.md +1 -1
  16. package/docs/functions/toDateObjectStrict.md +1 -1
  17. package/docs/functions/toOmrsIsoString.md +1 -1
  18. package/docs/interfaces/DurationOptions.md +4 -4
  19. package/docs/interfaces/DurationOptionsWithFormat.md +5 -5
  20. package/docs/type-aliases/DurationUnit.md +1 -1
  21. package/docs/type-aliases/FormatDateMode.md +1 -1
  22. package/docs/type-aliases/FormatDateOptions.md +10 -10
  23. package/package.json +19 -19
package/.turbo/turbo-build.log CHANGED
@@ -1,3 +1,3 @@
1
- [0] Successfully compiled: 4 files with swc (104.84ms)
1
+ [0] Successfully compiled: 4 files with swc (99.46ms)
2
2
  [0] swc --strip-leading-paths src -d dist exited with code 0
3
3
  [1] tsc --project tsconfig.build.json exited with code 0
package/docs/functions/convertToLocaleCalendar.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **convertToLocaleCalendar**(`date`, `locale`): `CalendarDate` \| `CalendarDateTime` \| `ZonedDateTime`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:424](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L424)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:450](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L450)
8
8
 
9
9
  Converts a calendar date to the equivalent locale calendar date.
10
10
 
package/docs/functions/duration.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **duration**(`startDate`, `endDate`, `options?`): `null` \| `DurationInput`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:645](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L645)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:671](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L671)
8
8
 
9
9
  Calculates the duration between two dates as a structured duration object.
10
10
 
package/docs/functions/formatDate.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **formatDate**(`date`, `options?`): `string`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:306](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L306)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:332](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L332)
8
8
 
9
9
  Formats the input date according to the current locale and the
10
10
  given options.
package/docs/functions/formatDatetime.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **formatDatetime**(`date`, `options?`): `string`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:416](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L416)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:442](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L442)
8
8
 
9
9
  Formats the input into a string showing the date and time, according
10
10
  to the current locale. The `mode` parameter is as described for
package/docs/functions/formatDuration.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **formatDuration**(`duration`, `options?`): `string`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:441](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L441)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:467](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L467)
8
8
 
9
9
  Formats the input duration according to the current locale.
10
10
 
package/docs/functions/formatDurationBetween.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **formatDurationBetween**(`startDate`, `endDate`, `options?`): `null` \| `string`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:707](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L707)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:733](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L733)
8
8
 
9
9
  Calculates the duration between two dates and formats it as a locale-aware string.
10
10
  Uses the same unit-selection logic as [duration](duration.md) and delegates formatting
package/docs/functions/formatPartialDate.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **formatPartialDate**(`dateString`, `options`): `null` \| `string`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:241](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L241)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:267](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L267)
8
8
 
9
9
  Formats the string representing a date, including partial representations of dates, according to the current
10
10
  locale and the given options.
package/docs/functions/formatTime.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **formatTime**(`date`): `string`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:396](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L396)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:422](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L422)
8
8
 
9
9
  Formats the input as a time, according to the current locale.
10
10
  12-hour or 24-hour clock depends on locale.
package/docs/functions/getDefaultCalendar.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **getDefaultCalendar**(`locale`): `undefined` \| `CalendarIdentifier`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:164](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L164)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:190](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L190)
8
8
 
9
9
  Retrieves the default calendar for the specified locale if any.
10
10
 
package/docs/functions/isOmrsDateStrict.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **isOmrsDateStrict**(`omrsPayloadString`): `boolean`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L33)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L59)
8
8
 
9
9
  This function checks whether a date string is the OpenMRS ISO format.
10
10
  The format should be YYYY-MM-DDTHH:mm:ss.SSSZZ
package/docs/functions/isOmrsDateToday.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **isOmrsDateToday**(`date`): `boolean`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L64)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L90)
8
8
 
9
9
  Checks if the provided date is today.
10
10
 
package/docs/functions/parseDate.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **parseDate**(`dateString`): `Date`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:97](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L97)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:123](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L123)
8
8
 
9
9
  Utility function to parse an arbitrary string into a date.
10
10
  Uses `dayjs(dateString)`.
package/docs/functions/parseDateInput.md CHANGED
@@ -4,10 +4,10 @@
4
4
 
5
5
  > **parseDateInput**(`dateInput`, `referenceDate`): `null` \| `Dayjs`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:455](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L455)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:481](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L481)
8
8
 
9
- Parses a date input into a dayjs object. String inputs are interpreted using
10
- any-date-parser with corrections for its month/day representation differences
9
+ Parses a date input into a dayjs object. ISO calendar dates are parsed independently of locale;
10
+ other strings use any-date-parser with corrections for its month/day representation differences
11
11
  with dayjs. Non-string inputs are passed directly to dayjs.
12
12
 
13
13
  ## Parameters
package/docs/functions/registerDefaultCalendar.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **registerDefaultCalendar**(`locale`, `calendar`): `void`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:155](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L155)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:181](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L181)
8
8
 
9
9
  Provides the name of the calendar to associate, as a default, with the given base locale.
10
10
 
package/docs/functions/toDateObjectStrict.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **toDateObjectStrict**(`omrsDateString`): `null` \| `Date`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L72)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:98](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L98)
8
8
 
9
9
  Converts the object to a date object if it is an OpenMRS ISO date time string.
10
10
  Otherwise returns null.
package/docs/functions/toOmrsIsoString.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **toOmrsIsoString**(`date`, `toUTC`): `string`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L83)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:109](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L109)
8
8
 
9
9
  Formats the input to OpenMRS ISO format: "YYYY-MM-DDTHH:mm:ss.SSSZZ".
10
10
 
package/docs/interfaces/DurationOptions.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DurationOptions
4
4
 
5
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:495](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L495)
5
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:521](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L521)
6
6
 
7
7
  ## Extended by
8
8
 
@@ -14,7 +14,7 @@ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:495](https://gi
14
14
 
15
15
  > `optional` **largestUnit**: `"auto"` \| [`DurationUnit`](../type-aliases/DurationUnit.md)
16
16
 
17
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:503](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L503)
17
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:529](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L529)
18
18
 
19
19
  Coarsest unit to include. Accepts 'auto' (default when smallestUnit is set),
20
20
  which resolves to the largest non-zero unit or smallestUnit, whichever is greater.
@@ -26,7 +26,7 @@ Mirrors Temporal.Duration.round() behavior.
26
26
 
27
27
  > `optional` **smallestUnit**: [`DurationUnit`](../type-aliases/DurationUnit.md)
28
28
 
29
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:505](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L505)
29
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:531](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L531)
30
30
 
31
31
  Finest unit to include. Defaults to largestUnit when largestUnit is an explicit unit, giving a single-unit result.
32
32
 
@@ -36,6 +36,6 @@ Finest unit to include. Defaults to largestUnit when largestUnit is an explicit
36
36
 
37
37
  > `optional` **thresholds**: `Partial`\<`Record`\<[`DurationUnit`](../type-aliases/DurationUnit.md), `number`\>\>
38
38
 
39
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:497](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L497)
39
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:523](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L523)
40
40
 
41
41
  Override auto-selection thresholds. Each value is in the unit's own terms (e.g., seconds: 30 means "use seconds if < 30 seconds").
package/docs/interfaces/DurationOptionsWithFormat.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DurationOptionsWithFormat
4
4
 
5
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:508](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L508)
5
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:534](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L534)
6
6
 
7
7
  ## Extends
8
8
 
@@ -14,7 +14,7 @@ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:508](https://gi
14
14
 
15
15
  > `optional` **formatOptions**: `Partial`\<`ResolvedDurationFormatOptions`\>
16
16
 
17
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:510](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L510)
17
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:536](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L536)
18
18
 
19
19
  Options passed to Intl.DurationFormat. Defaults to { style: 'short', localeMatcher: 'lookup' }.
20
20
 
@@ -24,7 +24,7 @@ Options passed to Intl.DurationFormat. Defaults to { style: 'short', localeMatch
24
24
 
25
25
  > `optional` **largestUnit**: `"auto"` \| [`DurationUnit`](../type-aliases/DurationUnit.md)
26
26
 
27
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:503](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L503)
27
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:529](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L529)
28
28
 
29
29
  Coarsest unit to include. Accepts 'auto' (default when smallestUnit is set),
30
30
  which resolves to the largest non-zero unit or smallestUnit, whichever is greater.
@@ -40,7 +40,7 @@ Mirrors Temporal.Duration.round() behavior.
40
40
 
41
41
  > `optional` **smallestUnit**: [`DurationUnit`](../type-aliases/DurationUnit.md)
42
42
 
43
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:505](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L505)
43
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:531](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L531)
44
44
 
45
45
  Finest unit to include. Defaults to largestUnit when largestUnit is an explicit unit, giving a single-unit result.
46
46
 
@@ -54,7 +54,7 @@ Finest unit to include. Defaults to largestUnit when largestUnit is an explicit
54
54
 
55
55
  > `optional` **thresholds**: `Partial`\<`Record`\<[`DurationUnit`](../type-aliases/DurationUnit.md), `number`\>\>
56
56
 
57
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:497](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L497)
57
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:523](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L523)
58
58
 
59
59
  Override auto-selection thresholds. Each value is in the unit's own terms (e.g., seconds: 30 means "use seconds if < 30 seconds").
60
60
 
package/docs/type-aliases/DurationUnit.md CHANGED
@@ -4,6 +4,6 @@
4
4
 
5
5
  > **DurationUnit** = `DurationUnitPlural` \| `DurationUnitSingular`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:493](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L493)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:519](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L519)
8
8
 
9
9
  Accepts both singular ('year') and plural ('years') forms, mirroring Temporal.Duration.round().
package/docs/type-aliases/FormatDateMode.md CHANGED
@@ -4,4 +4,4 @@
4
4
 
5
5
  > **FormatDateMode** = `"standard"` \| `"wide"`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:170](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L170)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:196](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L196)
package/docs/type-aliases/FormatDateOptions.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **FormatDateOptions** = `object`
6
6
 
7
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:172](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L172)
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:198](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L198)
8
8
 
9
9
  ## Properties
10
10
 
@@ -12,7 +12,7 @@ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:172](https://gi
12
12
 
13
13
  > `optional` **calendar**: `string`
14
14
 
15
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:176](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L176)
15
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:202](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L202)
16
16
 
17
17
  The calendar to use when formatting this date.
18
18
 
@@ -22,7 +22,7 @@ The calendar to use when formatting this date.
22
22
 
23
23
  > **day**: `boolean`
24
24
 
25
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:192](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L192)
25
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:218](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L218)
26
26
 
27
27
  Whether to include the day number
28
28
 
@@ -32,7 +32,7 @@ Whether to include the day number
32
32
 
33
33
  > `optional` **locale**: `string`
34
34
 
35
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:180](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L180)
35
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:206](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L206)
36
36
 
37
37
  The locale to use when formatting this date
38
38
 
@@ -42,7 +42,7 @@ The locale to use when formatting this date
42
42
 
43
43
  > **mode**: [`FormatDateMode`](FormatDateMode.md)
44
44
 
45
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:185](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L185)
45
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:211](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L211)
46
46
 
47
47
  - `standard`: "03 Feb 2022"
48
48
  - `wide`: "03 — Feb — 2022"
@@ -53,7 +53,7 @@ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:185](https://gi
53
53
 
54
54
  > **month**: `boolean`
55
55
 
56
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:194](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L194)
56
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:220](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L220)
57
57
 
58
58
  Whether to include the month number
59
59
 
@@ -63,7 +63,7 @@ Whether to include the month number
63
63
 
64
64
  > **noToday**: `boolean`
65
65
 
66
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:205](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L205)
66
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:231](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L231)
67
67
 
68
68
  Disables the special handling of dates that are today. If false
69
69
  (the default), then dates that are today will be formatted as "Today"
@@ -76,7 +76,7 @@ formatted the same as all other dates.
76
76
 
77
77
  > `optional` **numberingSystem**: `string`
78
78
 
79
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:198](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L198)
79
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:224](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L224)
80
80
 
81
81
  The unicode numbering system to use
82
82
 
@@ -86,7 +86,7 @@ The unicode numbering system to use
86
86
 
87
87
  > **time**: `true` \| `false` \| `"for today"`
88
88
 
89
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:190](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L190)
89
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:216](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L216)
90
90
 
91
91
  Whether the time should be included in the output always (`true`),
92
92
  never (`false`), or only when the input date is today (`for today`).
@@ -97,6 +97,6 @@ never (`false`), or only when the input date is today (`for today`).
97
97
 
98
98
  > **year**: `boolean`
99
99
 
100
- Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:196](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L196)
100
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:222](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L222)
101
101
 
102
102
  Whether to include the year
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "11.0.1-pre.5906",
3
+ "version": "11.0.1-pre.5917",
4
4
  "license": "MPL-2.0",
5
5
  "type": "module",
6
6
  "module": "dist/index.js",
@@ -60,23 +60,23 @@
60
60
  "access": "public"
61
61
  },
62
62
  "dependencies": {
63
- "@openmrs/esm-api": "11.0.1-pre.5906",
64
- "@openmrs/esm-config": "11.0.1-pre.5906",
65
- "@openmrs/esm-context": "11.0.1-pre.5906",
66
- "@openmrs/esm-dynamic-loading": "11.0.1-pre.5906",
67
- "@openmrs/esm-emr-api": "11.0.1-pre.5906",
68
- "@openmrs/esm-error-handling": "11.0.1-pre.5906",
69
- "@openmrs/esm-expression-evaluator": "11.0.1-pre.5906",
70
- "@openmrs/esm-extensions": "11.0.1-pre.5906",
71
- "@openmrs/esm-feature-flags": "11.0.1-pre.5906",
72
- "@openmrs/esm-globals": "11.0.1-pre.5906",
73
- "@openmrs/esm-navigation": "11.0.1-pre.5906",
74
- "@openmrs/esm-react-utils": "11.0.1-pre.5906",
75
- "@openmrs/esm-routes": "11.0.1-pre.5906",
76
- "@openmrs/esm-state": "11.0.1-pre.5906",
77
- "@openmrs/esm-styleguide": "11.0.1-pre.5906",
78
- "@openmrs/esm-translations": "11.0.1-pre.5906",
79
- "@openmrs/esm-utils": "11.0.1-pre.5906"
63
+ "@openmrs/esm-api": "11.0.1-pre.5917",
64
+ "@openmrs/esm-config": "11.0.1-pre.5917",
65
+ "@openmrs/esm-context": "11.0.1-pre.5917",
66
+ "@openmrs/esm-dynamic-loading": "11.0.1-pre.5917",
67
+ "@openmrs/esm-emr-api": "11.0.1-pre.5917",
68
+ "@openmrs/esm-error-handling": "11.0.1-pre.5917",
69
+ "@openmrs/esm-expression-evaluator": "11.0.1-pre.5917",
70
+ "@openmrs/esm-extensions": "11.0.1-pre.5917",
71
+ "@openmrs/esm-feature-flags": "11.0.1-pre.5917",
72
+ "@openmrs/esm-globals": "11.0.1-pre.5917",
73
+ "@openmrs/esm-navigation": "11.0.1-pre.5917",
74
+ "@openmrs/esm-react-utils": "11.0.1-pre.5917",
75
+ "@openmrs/esm-routes": "11.0.1-pre.5917",
76
+ "@openmrs/esm-state": "11.0.1-pre.5917",
77
+ "@openmrs/esm-styleguide": "11.0.1-pre.5917",
78
+ "@openmrs/esm-translations": "11.0.1-pre.5917",
79
+ "@openmrs/esm-utils": "11.0.1-pre.5917"
80
80
  },
81
81
  "peerDependencies": {
82
82
  "dayjs": "1.x",
@@ -88,7 +88,7 @@
88
88
  "swr": "2.x"
89
89
  },
90
90
  "devDependencies": {
91
- "@openmrs/typedoc-plugin-file-categories": "11.0.1-pre.5906",
91
+ "@openmrs/typedoc-plugin-file-categories": "11.0.1-pre.5917",
92
92
  "@swc/cli": "0.8.1",
93
93
  "@swc/core": "1.15.21",
94
94
  "@vitest/coverage-v8": "^4.1.2",