@rvoh/dream 2.3.3 → 2.4.0
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.
- package/dist/cjs/src/bin/index.js +2 -0
- package/dist/cjs/src/cli/index.js +5 -0
- package/dist/cjs/src/dream-app/helpers/globalModelKeyFromPath.js +3 -2
- package/dist/cjs/src/helpers/cli/generateDream.js +2 -0
- package/dist/cjs/src/helpers/cli/generateDreamContent.js +11 -2
- package/dist/cjs/src/helpers/cli/generateFactoryContent.js +9 -1
- package/dist/cjs/src/helpers/cli/generateSerializer.js +2 -1
- package/dist/cjs/src/helpers/cli/generateSerializerContent.js +12 -2
- package/dist/esm/src/bin/index.js +2 -0
- package/dist/esm/src/cli/index.js +5 -0
- package/dist/esm/src/dream-app/helpers/globalModelKeyFromPath.js +3 -2
- package/dist/esm/src/helpers/cli/generateDream.js +2 -0
- package/dist/esm/src/helpers/cli/generateDreamContent.js +11 -2
- package/dist/esm/src/helpers/cli/generateFactoryContent.js +9 -1
- package/dist/esm/src/helpers/cli/generateSerializer.js +2 -1
- package/dist/esm/src/helpers/cli/generateSerializerContent.js +12 -2
- package/dist/types/src/bin/index.d.ts +2 -0
- package/dist/types/src/cli/index.d.ts +2 -1
- package/dist/types/src/helpers/EnvInternal.d.ts +1 -1
- package/dist/types/src/helpers/cli/generateDream.d.ts +1 -0
- package/dist/types/src/helpers/cli/generateDreamContent.d.ts +1 -0
- package/dist/types/src/helpers/cli/generateSerializer.d.ts +2 -1
- package/dist/types/src/helpers/cli/generateSerializerContent.d.ts +2 -1
- package/dist/types/src/helpers/path/windowsSafePath.d.ts +4 -4
- package/dist/types/src/helpers/sspawn.d.ts +1 -1
- package/dist/types/src/types/openapi.d.ts +2 -2
- package/dist/types/src/types/openapi.ts +2 -0
- package/docs/assets/hierarchy.js +1 -0
- package/docs/assets/icons.js +1 -1
- package/docs/assets/icons.svg +1 -1
- package/docs/assets/main.js +5 -5
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/assets/style.css +1440 -1255
- package/docs/classes/db.DreamMigrationHelpers.html +42 -37
- package/docs/classes/db.KyselyQueryDriver.html +94 -94
- package/docs/classes/db.PostgresQueryDriver.html +95 -95
- package/docs/classes/db.QueryDriverBase.html +86 -86
- package/docs/classes/errors.CheckConstraintViolation.html +33 -12
- package/docs/classes/errors.ColumnOverflow.html +33 -12
- package/docs/classes/errors.CreateOrFindByFailedToCreateAndFind.html +33 -12
- package/docs/classes/errors.DataIncompatibleWithDatabaseField.html +33 -12
- package/docs/classes/errors.DataTypeColumnTypeMismatch.html +33 -12
- package/docs/classes/errors.GlobalNameNotSet.html +33 -12
- package/docs/classes/errors.InvalidCalendarDate.html +36 -15
- package/docs/classes/errors.InvalidClockTime.html +36 -15
- package/docs/classes/errors.InvalidClockTimeTz.html +36 -15
- package/docs/classes/errors.InvalidDateTime.html +36 -15
- package/docs/classes/errors.MissingSerializersDefinition.html +33 -12
- package/docs/classes/errors.NonLoadedAssociation.html +35 -14
- package/docs/classes/errors.NotNullViolation.html +33 -12
- package/docs/classes/errors.RecordNotFound.html +34 -13
- package/docs/classes/errors.ValidationError.html +35 -14
- package/docs/classes/index.CalendarDate.html +138 -138
- package/docs/classes/index.ClockTime.html +156 -147
- package/docs/classes/index.ClockTimeTz.html +171 -160
- package/docs/classes/index.DateTime.html +526 -310
- package/docs/classes/index.Decorators.html +67 -66
- package/docs/classes/index.Dream.html +502 -439
- package/docs/classes/index.DreamApp.html +42 -47
- package/docs/classes/index.DreamTransaction.html +5 -5
- package/docs/classes/index.Env.html +18 -18
- package/docs/classes/index.Query.html +214 -214
- package/docs/classes/system.CliFileWriter.html +18 -8
- package/docs/classes/system.DreamBin.html +11 -11
- package/docs/classes/system.DreamCLI.html +12 -14
- package/docs/classes/system.DreamImporter.html +5 -5
- package/docs/classes/system.DreamLogos.html +4 -4
- package/docs/classes/system.DreamSerializerBuilder.html +72 -42
- package/docs/classes/system.ObjectSerializerBuilder.html +41 -41
- package/docs/classes/system.PathHelpers.html +8 -8
- package/docs/classes/utils.Encrypt.html +6 -6
- package/docs/classes/utils.Range.html +5 -5
- package/docs/functions/db.closeAllDbConnections.html +1 -1
- package/docs/functions/db.dreamDbConnections.html +1 -1
- package/docs/functions/db.untypedDb.html +1 -1
- package/docs/functions/db.validateColumn.html +1 -1
- package/docs/functions/db.validateTable.html +1 -1
- package/docs/functions/errors.pgErrorType.html +1 -1
- package/docs/functions/index.DreamSerializer.html +1 -1
- package/docs/functions/index.ObjectSerializer.html +1 -1
- package/docs/functions/index.ReplicaSafe.html +1 -1
- package/docs/functions/index.STI.html +1 -1
- package/docs/functions/index.SoftDelete.html +2 -2
- package/docs/functions/utils.camelize.html +4 -4
- package/docs/functions/utils.capitalize.html +3 -3
- package/docs/functions/utils.cloneDeepSafe.html +6 -6
- package/docs/functions/utils.compact.html +4 -4
- package/docs/functions/utils.groupBy.html +5 -5
- package/docs/functions/utils.hyphenize.html +4 -4
- package/docs/functions/utils.intersection.html +4 -4
- package/docs/functions/utils.isEmpty.html +4 -4
- package/docs/functions/utils.normalizeUnicode.html +5 -5
- package/docs/functions/utils.pascalize.html +4 -4
- package/docs/functions/utils.percent.html +5 -5
- package/docs/functions/utils.range.html +1 -0
- package/docs/functions/utils.round.html +4 -4
- package/docs/functions/utils.sanitizeString.html +1 -1
- package/docs/functions/utils.snakeify.html +4 -4
- package/docs/functions/utils.sort.html +2 -2
- package/docs/functions/utils.sortBy.html +5 -5
- package/docs/functions/utils.sortObjectByKey.html +1 -1
- package/docs/functions/utils.sortObjectByValue.html +1 -1
- package/docs/functions/utils.uncapitalize.html +1 -1
- package/docs/functions/utils.uniq.html +5 -5
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +12 -7
- package/docs/interfaces/openapi.OpenapiDescription.html +2 -2
- package/docs/interfaces/openapi.OpenapiSchemaProperties.html +1 -1
- package/docs/interfaces/openapi.OpenapiSchemaPropertiesShorthand.html +1 -1
- package/docs/interfaces/openapi.OpenapiTypeFieldObject.html +1 -1
- package/docs/interfaces/types.BelongsToStatement.html +14 -14
- package/docs/interfaces/types.DecoratorContext.html +8 -8
- package/docs/interfaces/types.DreamAppInitOptions.html +3 -3
- package/docs/interfaces/types.DreamAppOpts.html +8 -8
- package/docs/interfaces/types.DurationObject.html +12 -12
- package/docs/interfaces/types.EncryptOptions.html +3 -3
- package/docs/interfaces/types.InternalAnyTypedSerializerRendersMany.html +4 -4
- package/docs/interfaces/types.InternalAnyTypedSerializerRendersOne.html +4 -4
- package/docs/interfaces/types.SerializerRendererOpts.html +2 -2
- package/docs/modules/db.html +1 -10
- package/docs/modules/errors.html +1 -17
- package/docs/modules/index.html +1 -18
- package/docs/modules/openapi.html +1 -49
- package/docs/modules/system.html +1 -12
- package/docs/modules/types.html +1 -54
- package/docs/modules/utils.html +1 -24
- package/docs/modules.html +1 -0
- package/docs/types/openapi.CommonOpenapiSchemaObjectFields.html +1 -1
- package/docs/types/openapi.OpenapiAllTypes.html +1 -1
- package/docs/types/openapi.OpenapiFormats.html +1 -1
- package/docs/types/openapi.OpenapiNumberFormats.html +1 -1
- package/docs/types/openapi.OpenapiPrimitiveBaseTypes.html +1 -1
- package/docs/types/openapi.OpenapiPrimitiveTypes.html +1 -1
- package/docs/types/openapi.OpenapiSchemaArray.html +1 -1
- package/docs/types/openapi.OpenapiSchemaArrayShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaBase.html +1 -1
- package/docs/types/openapi.OpenapiSchemaBody.html +1 -1
- package/docs/types/openapi.OpenapiSchemaBodyShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaCommonFields.html +1 -1
- package/docs/types/openapi.OpenapiSchemaExpressionAllOf.html +2 -1
- package/docs/types/openapi.OpenapiSchemaExpressionAnyOf.html +2 -1
- package/docs/types/openapi.OpenapiSchemaExpressionOneOf.html +2 -1
- package/docs/types/openapi.OpenapiSchemaExpressionRef.html +2 -1
- package/docs/types/openapi.OpenapiSchemaExpressionRefSchemaShorthand.html +2 -1
- package/docs/types/openapi.OpenapiSchemaInteger.html +1 -1
- package/docs/types/openapi.OpenapiSchemaNull.html +2 -1
- package/docs/types/openapi.OpenapiSchemaNumber.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObject.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectAllOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectAllOfShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectAnyOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectAnyOfShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectBase.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectBaseShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectOneOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectOneOfShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaPrimitiveGeneric.html +1 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionAllOf.html +2 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionAnyOf.html +2 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionOneOf.html +2 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializableRef.html +6 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializerRef.html +4 -1
- package/docs/types/openapi.OpenapiSchemaShorthandPrimitiveGeneric.html +1 -1
- package/docs/types/openapi.OpenapiSchemaString.html +1 -1
- package/docs/types/openapi.OpenapiShorthandAllTypes.html +1 -1
- package/docs/types/openapi.OpenapiShorthandPrimitiveBaseTypes.html +1 -1
- package/docs/types/openapi.OpenapiShorthandPrimitiveTypes.html +1 -1
- package/docs/types/openapi.OpenapiTypeField.html +1 -1
- package/docs/types/system.DreamAppAllowedPackageManagersEnum.html +1 -1
- package/docs/types/types.CalendarDateDurationUnit.html +1 -1
- package/docs/types/types.CalendarDateObject.html +2 -2
- package/docs/types/types.Camelized.html +1 -1
- package/docs/types/types.ClockTimeObject.html +2 -2
- package/docs/types/types.DbConnectionType.html +1 -1
- package/docs/types/types.DbTypes.html +1 -1
- package/docs/types/types.DreamAssociationMetadata.html +1 -1
- package/docs/types/types.DreamAttributes.html +1 -1
- package/docs/types/types.DreamClassAssociationAndStatement.html +1 -1
- package/docs/types/types.DreamClassColumn.html +1 -1
- package/docs/types/types.DreamColumn.html +1 -1
- package/docs/types/types.DreamColumnNames.html +1 -1
- package/docs/types/types.DreamLogLevel.html +1 -1
- package/docs/types/types.DreamLogger.html +5 -1
- package/docs/types/types.DreamModelSerializerType.html +1 -1
- package/docs/types/types.DreamOrViewModelClassSerializerKey.html +1 -1
- package/docs/types/types.DreamOrViewModelSerializerKey.html +1 -1
- package/docs/types/types.DreamParamSafeAttributes.html +1 -1
- package/docs/types/types.DreamParamSafeColumnNames.html +1 -1
- package/docs/types/types.DreamSerializable.html +1 -1
- package/docs/types/types.DreamSerializableArray.html +1 -1
- package/docs/types/types.DreamSerializerKey.html +1 -1
- package/docs/types/types.DreamSerializers.html +1 -1
- package/docs/types/types.DreamVirtualColumns.html +1 -1
- package/docs/types/types.DurationUnit.html +2 -2
- package/docs/types/types.EncryptAlgorithm.html +1 -1
- package/docs/types/types.HasManyStatement.html +1 -1
- package/docs/types/types.HasOneStatement.html +1 -1
- package/docs/types/types.Hyphenized.html +1 -1
- package/docs/types/types.Pascalized.html +1 -1
- package/docs/types/types.PrimaryKeyType.html +1 -1
- package/docs/types/types.RoundingPrecision.html +1 -1
- package/docs/types/types.SerializerCasing.html +1 -1
- package/docs/types/types.SimpleObjectSerializerType.html +1 -1
- package/docs/types/types.Snakeified.html +1 -1
- package/docs/types/types.StrictInterface.html +1 -1
- package/docs/types/types.UpdateableAssociationProperties.html +1 -1
- package/docs/types/types.UpdateableProperties.html +1 -1
- package/docs/types/types.ValidationType.html +1 -1
- package/docs/types/types.ViewModel.html +2 -1
- package/docs/types/types.ViewModelClass.html +1 -1
- package/docs/types/types.WeekdayName.html +2 -2
- package/docs/types/types.WhereStatementForDream.html +1 -1
- package/docs/types/types.WhereStatementForDreamClass.html +1 -1
- package/docs/variables/index.DreamConst.html +1 -1
- package/docs/variables/index.ops.html +1 -1
- package/docs/variables/openapi.openapiPrimitiveTypes.html +1 -0
- package/docs/variables/openapi.openapiShorthandPrimitiveTypes.html +1 -0
- package/docs/variables/system.DreamAppAllowedPackageManagersEnumValues.html +1 -1
- package/docs/variables/system.primaryKeyTypes.html +1 -1
- package/package.json +1 -1
- package/docs/functions/utils.range-1.html +0 -1
- package/docs/variables/openapi.openapiPrimitiveTypes-1.html +0 -1
- package/docs/variables/openapi.openapiShorthandPrimitiveTypes-1.html +0 -1
|
@@ -1,500 +1,716 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DateTime | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DateTime | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@rvoh/dream</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/index.html">index</a></li><li><a href="" aria-current="page">DateTime</a></li></ul><h1>Class DateTime</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>DateTime wraps Luxon DateTime with microsecond precision (0-999).
|
|
2
2
|
The decimal part in ISO/SQL is 6 digits: first 3 = milliseconds, next 3 = microseconds.</p>
|
|
3
3
|
<p>Full datetime output with toSQL() is normalized to UTC.
|
|
4
4
|
Time-only output (toISOTime, toSQLTime) omits timezone offset by default.
|
|
5
5
|
toISO() preserves the timezone of the DateTime instance.</p>
|
|
6
|
-
</div
|
|
7
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="
|
|
8
|
-
<a href="
|
|
9
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="
|
|
10
|
-
<a href="
|
|
11
|
-
<a href="
|
|
12
|
-
<a href="
|
|
13
|
-
<a href="
|
|
14
|
-
<a href="
|
|
15
|
-
<a href="
|
|
16
|
-
<a href="
|
|
17
|
-
<a href="
|
|
18
|
-
<a href="
|
|
19
|
-
<a href="
|
|
20
|
-
<a href="
|
|
21
|
-
<a href="
|
|
22
|
-
<a href="
|
|
23
|
-
<a href="
|
|
24
|
-
<a href="
|
|
25
|
-
<a href="
|
|
26
|
-
<a href="
|
|
27
|
-
<a href="
|
|
28
|
-
<a href="
|
|
29
|
-
<a href="
|
|
30
|
-
<a href="
|
|
31
|
-
<a href="
|
|
32
|
-
<a href="
|
|
33
|
-
<a href="
|
|
34
|
-
<a href="
|
|
35
|
-
<a href="
|
|
36
|
-
<a href="
|
|
37
|
-
<a href="
|
|
38
|
-
<a href="
|
|
39
|
-
<a href="
|
|
40
|
-
<a href="
|
|
41
|
-
<a href="
|
|
42
|
-
<a href="
|
|
43
|
-
<a href="
|
|
44
|
-
<a href="
|
|
45
|
-
<a href="
|
|
46
|
-
<a href="
|
|
47
|
-
<a href="
|
|
48
|
-
<a href="
|
|
49
|
-
<a href="
|
|
50
|
-
<a href="
|
|
51
|
-
<a href="
|
|
52
|
-
<a href="
|
|
53
|
-
<a href="
|
|
54
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="
|
|
55
|
-
<a href="
|
|
56
|
-
<a href="
|
|
57
|
-
<a href="
|
|
58
|
-
<a href="
|
|
59
|
-
<a href="
|
|
60
|
-
<a href="
|
|
61
|
-
<a href="
|
|
62
|
-
<a href="
|
|
63
|
-
<a href="
|
|
64
|
-
<a href="
|
|
65
|
-
<a href="
|
|
66
|
-
<a href="
|
|
67
|
-
<a href="
|
|
68
|
-
<a href="
|
|
69
|
-
<a href="
|
|
70
|
-
<a href="
|
|
71
|
-
<a href="
|
|
72
|
-
<a href="
|
|
73
|
-
<a href="
|
|
74
|
-
<a href="
|
|
75
|
-
<a href="
|
|
76
|
-
<a href="
|
|
77
|
-
<a href="
|
|
78
|
-
<a href="
|
|
79
|
-
<a href="
|
|
80
|
-
<a href="
|
|
81
|
-
<a href="
|
|
82
|
-
<a href="
|
|
83
|
-
<a href="
|
|
84
|
-
<a href="
|
|
85
|
-
<a href="
|
|
86
|
-
<a href="
|
|
87
|
-
<a href="
|
|
88
|
-
<a href="
|
|
89
|
-
<a href="
|
|
90
|
-
<a href="
|
|
91
|
-
<a href="
|
|
92
|
-
<a href="
|
|
93
|
-
<a href="
|
|
94
|
-
<a href="
|
|
95
|
-
<a href="
|
|
96
|
-
<a href="
|
|
97
|
-
<a href="
|
|
98
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_DateTime" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Date<wbr/>Time</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">luxonDatetime</span>, <span class="tsd-kind-parameter">microseconds</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#constructor.new_DateTime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Internal</code><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">luxonDatetime</span>: <span class="tsd-signature-type">DateTime</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">microseconds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L151">src/utils/datetime/DateTime.ts:151</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected"><a id="_microseconds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>_microseconds</span><a href="#_microseconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_microseconds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L38">src/utils/datetime/DateTime.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="luxonDatetime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>luxon<wbr/>Datetime</span><a href="#luxonDatetime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">luxon<wbr/>Datetime</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTime</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L37">src/utils/datetime/DateTime.ts:37</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="day" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>day</span><a href="#day" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="day.day-1"><span class="tsd-signature-keyword">get</span> day<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L61">src/utils/datetime/DateTime.ts:61</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hour" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hour</span><a href="#hour" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="hour.hour-1"><span class="tsd-signature-keyword">get</span> hour<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L65">src/utils/datetime/DateTime.ts:65</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="invalidExplanation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>invalid<wbr/>Explanation</span><a href="#invalidExplanation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="invalidExplanation.invalidExplanation-1"><span class="tsd-signature-keyword">get</span> invalidExplanation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L136">src/utils/datetime/DateTime.ts:136</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="invalidReason" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>invalid<wbr/>Reason</span><a href="#invalidReason" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="invalidReason.invalidReason-1"><span class="tsd-signature-keyword">get</span> invalidReason<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L132">src/utils/datetime/DateTime.ts:132</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="locale" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>locale</span><a href="#locale" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="locale.locale-1"><span class="tsd-signature-keyword">get</span> locale<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L140">src/utils/datetime/DateTime.ts:140</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="microsecond" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>microsecond</span><a href="#microsecond" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="microsecond.microsecond-1"><span class="tsd-signature-keyword">get</span> microsecond<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Microsecond part of the DateTime (NOT microseconds since Unix epoch)</p>
|
|
6
|
+
</div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L36">src/utils/datetime/DateTime.ts:36</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
7
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#_microseconds" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>microseconds</span></a>
|
|
8
|
+
<a href="#luxondatetime" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>luxon<wbr/>Datetime</span></a>
|
|
9
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#day" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>day</span></a>
|
|
10
|
+
<a href="#hour" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hour</span></a>
|
|
11
|
+
<a href="#invalidexplanation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>invalid<wbr/>Explanation</span></a>
|
|
12
|
+
<a href="#invalidreason" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>invalid<wbr/>Reason</span></a>
|
|
13
|
+
<a href="#locale" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>locale</span></a>
|
|
14
|
+
<a href="#microsecond" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>microsecond</span></a>
|
|
15
|
+
<a href="#millisecond" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>millisecond</span></a>
|
|
16
|
+
<a href="#minute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>minute</span></a>
|
|
17
|
+
<a href="#month" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>month</span></a>
|
|
18
|
+
<a href="#offset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>offset</span></a>
|
|
19
|
+
<a href="#ordinal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ordinal</span></a>
|
|
20
|
+
<a href="#quarter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>quarter</span></a>
|
|
21
|
+
<a href="#second" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>second</span></a>
|
|
22
|
+
<a href="#unixintegermicroseconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>unix<wbr/>Integer<wbr/>Microseconds</span></a>
|
|
23
|
+
<a href="#unixintegermilliseconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>unix<wbr/>Integer<wbr/>Milliseconds</span></a>
|
|
24
|
+
<a href="#unixintegerseconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>unix<wbr/>Integer<wbr/>Seconds</span></a>
|
|
25
|
+
<a href="#weekday" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>weekday</span></a>
|
|
26
|
+
<a href="#weekdayname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>weekday<wbr/>Name</span></a>
|
|
27
|
+
<a href="#weeknumber" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>week<wbr/>Number</span></a>
|
|
28
|
+
<a href="#weekyear" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>week<wbr/>Year</span></a>
|
|
29
|
+
<a href="#year" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>year</span></a>
|
|
30
|
+
<a href="#zone" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>zone</span></a>
|
|
31
|
+
<a href="#zonename" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>zone<wbr/>Name</span></a>
|
|
32
|
+
<a href="#date_full" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>FULL</span></a>
|
|
33
|
+
<a href="#date_huge" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>HUGE</span></a>
|
|
34
|
+
<a href="#date_med" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>MED</span></a>
|
|
35
|
+
<a href="#date_med_with_weekday" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>MED_<wbr/>WITH_<wbr/>WEEKDAY</span></a>
|
|
36
|
+
<a href="#date_short" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>SHORT</span></a>
|
|
37
|
+
<a href="#datetime_full" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>FULL</span></a>
|
|
38
|
+
<a href="#datetime_full_with_seconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>FULL_<wbr/>WITH_<wbr/>SECONDS</span></a>
|
|
39
|
+
<a href="#datetime_huge" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>HUGE</span></a>
|
|
40
|
+
<a href="#datetime_huge_with_seconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>HUGE_<wbr/>WITH_<wbr/>SECONDS</span></a>
|
|
41
|
+
<a href="#datetime_med" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>MED</span></a>
|
|
42
|
+
<a href="#datetime_med_with_seconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>MED_<wbr/>WITH_<wbr/>SECONDS</span></a>
|
|
43
|
+
<a href="#datetime_med_with_weekday" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>MED_<wbr/>WITH_<wbr/>WEEKDAY</span></a>
|
|
44
|
+
<a href="#datetime_short" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>SHORT</span></a>
|
|
45
|
+
<a href="#datetime_short_with_seconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>SHORT_<wbr/>WITH_<wbr/>SECONDS</span></a>
|
|
46
|
+
<a href="#time_24_simple" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>24_<wbr/>SIMPLE</span></a>
|
|
47
|
+
<a href="#time_24_with_long_offset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>24_<wbr/>WITH_<wbr/>LONG_<wbr/>OFFSET</span></a>
|
|
48
|
+
<a href="#time_24_with_seconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>24_<wbr/>WITH_<wbr/>SECONDS</span></a>
|
|
49
|
+
<a href="#time_24_with_short_offset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>24_<wbr/>WITH_<wbr/>SHORT_<wbr/>OFFSET</span></a>
|
|
50
|
+
<a href="#time_simple" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>SIMPLE</span></a>
|
|
51
|
+
<a href="#time_with_long_offset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>WITH_<wbr/>LONG_<wbr/>OFFSET</span></a>
|
|
52
|
+
<a href="#time_with_seconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>WITH_<wbr/>SECONDS</span></a>
|
|
53
|
+
<a href="#time_with_short_offset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>WITH_<wbr/>SHORT_<wbr/>OFFSET</span></a>
|
|
54
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#diff" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>diff</span></a>
|
|
55
|
+
<a href="#diffnow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>diff<wbr/>Now</span></a>
|
|
56
|
+
<a href="#endof" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>end<wbr/>Of</span></a>
|
|
57
|
+
<a href="#equals" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>equals</span></a>
|
|
58
|
+
<a href="#hassame" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Same</span></a>
|
|
59
|
+
<a href="#minus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>minus</span></a>
|
|
60
|
+
<a href="#plus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>plus</span></a>
|
|
61
|
+
<a href="#reconfigure" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reconfigure</span></a>
|
|
62
|
+
<a href="#set" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a>
|
|
63
|
+
<a href="#setlocale" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Locale</span></a>
|
|
64
|
+
<a href="#setzone" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Zone</span></a>
|
|
65
|
+
<a href="#startof" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Of</span></a>
|
|
66
|
+
<a href="#toformat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Format</span></a>
|
|
67
|
+
<a href="#toiso" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>ISO</span></a>
|
|
68
|
+
<a href="#toisodate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>ISO<wbr/>Date</span></a>
|
|
69
|
+
<a href="#toisotime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>ISO<wbr/>Time</span></a>
|
|
70
|
+
<a href="#tojsdate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>JS<wbr/>Date</span></a>
|
|
71
|
+
<a href="#tojson" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>JSON</span></a>
|
|
72
|
+
<a href="#tolocal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Local</span></a>
|
|
73
|
+
<a href="#tolocalestring" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Locale<wbr/>String</span></a>
|
|
74
|
+
<a href="#toluxon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Luxon</span></a>
|
|
75
|
+
<a href="#tomicroseconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Microseconds</span></a>
|
|
76
|
+
<a href="#tomillis" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Millis</span></a>
|
|
77
|
+
<a href="#toobject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Object</span></a>
|
|
78
|
+
<a href="#toseconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Seconds</span></a>
|
|
79
|
+
<a href="#tosql" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>SQL</span></a>
|
|
80
|
+
<a href="#tosqldate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>SQL<wbr/>Date</span></a>
|
|
81
|
+
<a href="#tosqltime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>SQL<wbr/>Time</span></a>
|
|
82
|
+
<a href="#tostring" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a>
|
|
83
|
+
<a href="#toutc" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>UTC</span></a>
|
|
84
|
+
<a href="#valueof" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>value<wbr/>Of</span></a>
|
|
85
|
+
<a href="#fromformat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Format</span></a>
|
|
86
|
+
<a href="#fromiso" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>ISO</span></a>
|
|
87
|
+
<a href="#fromjsdate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>JS<wbr/>Date</span></a>
|
|
88
|
+
<a href="#frommicroseconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Microseconds</span></a>
|
|
89
|
+
<a href="#frommillis" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Millis</span></a>
|
|
90
|
+
<a href="#fromobject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Object</span></a>
|
|
91
|
+
<a href="#fromseconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Seconds</span></a>
|
|
92
|
+
<a href="#fromsql" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>SQL</span></a>
|
|
93
|
+
<a href="#local" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>local</span></a>
|
|
94
|
+
<a href="#max" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>max</span></a>
|
|
95
|
+
<a href="#min" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>min</span></a>
|
|
96
|
+
<a href="#now" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>now</span></a>
|
|
97
|
+
<a href="#utc" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>utc</span></a>
|
|
98
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructordatetime"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DateTime</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">luxonDatetime</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTime</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">microseconds</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#constructordatetime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><code class="tsd-tag">Internal</code><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">luxonDatetime</span>: <span class="tsd-signature-type">DateTime</span></span></li><li><span><span class="tsd-kind-parameter">microseconds</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L151">src/utils/datetime/DateTime.ts:151</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="_microseconds"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>_<wbr/>microseconds</span><a href="#_microseconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_microseconds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L38">src/utils/datetime/DateTime.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="luxondatetime"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>luxon<wbr/>Datetime</span><a href="#luxondatetime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">luxonDatetime</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTime</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L37">src/utils/datetime/DateTime.ts:37</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="day"><span>day</span><a href="#day" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="dayday"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">day</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L61">src/utils/datetime/DateTime.ts:61</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hour"><span>hour</span><a href="#hour" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="hourhour"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">hour</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L65">src/utils/datetime/DateTime.ts:65</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="invalidexplanation"><span>invalid<wbr/>Explanation</span><a href="#invalidexplanation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="invalidexplanationinvalidexplanation"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">invalidExplanation</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L136">src/utils/datetime/DateTime.ts:136</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="invalidreason"><span>invalid<wbr/>Reason</span><a href="#invalidreason" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="invalidreasoninvalidreason"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">invalidReason</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L132">src/utils/datetime/DateTime.ts:132</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="locale"><span>locale</span><a href="#locale" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="localelocale"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">locale</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L140">src/utils/datetime/DateTime.ts:140</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="microsecond"><span>microsecond</span><a href="#microsecond" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="microsecondmicrosecond"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">microsecond</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Microsecond part of the DateTime (NOT microseconds since Unix epoch)</p>
|
|
99
99
|
<p>This value will not exceed 999 because above that will carry over to the
|
|
100
100
|
millisecond part of the DateTime</p>
|
|
101
101
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The microsecond of the second (0–999)</p>
|
|
102
|
-
<
|
|
102
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L48">src/utils/datetime/DateTime.ts:48</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="millisecond"><span>millisecond</span><a href="#millisecond" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="millisecondmillisecond"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">millisecond</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L77">src/utils/datetime/DateTime.ts:77</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="minute"><span>minute</span><a href="#minute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="minuteminute"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">minute</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L69">src/utils/datetime/DateTime.ts:69</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="month"><span>month</span><a href="#month" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="monthmonth"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">month</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L57">src/utils/datetime/DateTime.ts:57</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="offset"><span>offset</span><a href="#offset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="offsetoffset"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">offset</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L128">src/utils/datetime/DateTime.ts:128</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="ordinal"><span>ordinal</span><a href="#ordinal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="ordinalordinal"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">ordinal</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L116">src/utils/datetime/DateTime.ts:116</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="quarter"><span>quarter</span><a href="#quarter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="quarterquarter"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">quarter</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L120">src/utils/datetime/DateTime.ts:120</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="second"><span>second</span><a href="#second" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="secondsecond"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">second</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L73">src/utils/datetime/DateTime.ts:73</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="unixintegermicroseconds"><span>unix<wbr/>Integer<wbr/>Microseconds</span><a href="#unixintegermicroseconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="unixintegermicrosecondsunixintegermicroseconds"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">unixIntegerMicroseconds</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the epoch time in microseconds as an integer.
|
|
103
103
|
Equivalent to <code>toMicroseconds()</code> since microseconds are always whole numbers.</p>
|
|
104
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"><
|
|
104
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2026-02-07T09:03:44.123456Z'</span><span class="hl-1">).</span><span class="hl-4">unixIntegerMicroseconds</span><span class="hl-1"> </span><span class="hl-7">// 1770455024123456</span>
|
|
105
105
|
</code><button type="button">Copy</button></pre>
|
|
106
106
|
|
|
107
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
108
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"><
|
|
107
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1244">src/utils/datetime/DateTime.ts:1244</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="unixintegermilliseconds"><span>unix<wbr/>Integer<wbr/>Milliseconds</span><a href="#unixintegermilliseconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="unixintegermillisecondsunixintegermilliseconds"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">unixIntegerMilliseconds</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the epoch time in milliseconds as an integer, truncating any fractional part.</p>
|
|
108
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2026-02-07T09:03:44.123456Z'</span><span class="hl-1">).</span><span class="hl-4">unixIntegerMilliseconds</span><span class="hl-1"> </span><span class="hl-7">// 1770455024123</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2026-02-07T09:03:44.123999Z'</span><span class="hl-1">).</span><span class="hl-4">unixIntegerMilliseconds</span><span class="hl-1"> </span><span class="hl-7">// 1770455024123 (not rounded up)</span>
|
|
109
109
|
</code><button type="button">Copy</button></pre>
|
|
110
110
|
|
|
111
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
112
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"><
|
|
111
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1232">src/utils/datetime/DateTime.ts:1232</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="unixintegerseconds"><span>unix<wbr/>Integer<wbr/>Seconds</span><a href="#unixintegerseconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="unixintegersecondsunixintegerseconds"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">unixIntegerSeconds</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the epoch time in seconds as an integer, truncating any fractional part.</p>
|
|
112
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2026-02-07T09:03:44.123456Z'</span><span class="hl-1">).</span><span class="hl-4">unixIntegerSeconds</span><span class="hl-1"> </span><span class="hl-7">// 1770455024</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2026-02-07T09:03:44.999999Z'</span><span class="hl-1">).</span><span class="hl-4">unixIntegerSeconds</span><span class="hl-1"> </span><span class="hl-7">// 1770455024 (not rounded up)</span>
|
|
113
113
|
</code><button type="button">Copy</button></pre>
|
|
114
114
|
|
|
115
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
115
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1220">src/utils/datetime/DateTime.ts:1220</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="weekday"><span>weekday</span><a href="#weekday" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="weekdayweekday"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">weekday</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L81">src/utils/datetime/DateTime.ts:81</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="weekdayname"><span>weekday<wbr/>Name</span><a href="#weekdayname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="weekdaynameweekdayname"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">weekdayName</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.WeekdayName.html" class="tsd-signature-type tsd-kind-type-alias">WeekdayName</a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the lowercase name of the weekday.</p>
|
|
116
116
|
</div><h4 class="tsd-returns-title">Returns <a href="../types/types.WeekdayName.html" class="tsd-signature-type tsd-kind-type-alias">WeekdayName</a></h4><p>Weekday name: 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', or 'sunday'</p>
|
|
117
|
-
<div class="tsd-comment tsd-typography"><
|
|
117
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-3">Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2026-02-09T09:00:00Z'</span><span class="hl-1">).</span><span class="hl-4">weekdayName</span><span class="hl-1"> </span><span class="hl-7">// 'monday' (Feb 9, 2026 is a Monday)</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2026-02-07T09:00:00Z'</span><span class="hl-1">).</span><span class="hl-4">weekdayName</span><span class="hl-1"> </span><span class="hl-7">// 'saturday'</span>
|
|
118
118
|
</code><button type="button">Copy</button></pre>
|
|
119
119
|
|
|
120
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
121
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
120
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L94">src/utils/datetime/DateTime.ts:94</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="weeknumber"><span>week<wbr/>Number</span><a href="#weeknumber" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="weeknumberweeknumber"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">weekNumber</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L108">src/utils/datetime/DateTime.ts:108</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="weekyear"><span>week<wbr/>Year</span><a href="#weekyear" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="weekyearweekyear"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">weekYear</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L112">src/utils/datetime/DateTime.ts:112</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="year"><span>year</span><a href="#year" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="yearyear"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">year</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L53">src/utils/datetime/DateTime.ts:53</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="zone"><span>zone</span><a href="#zone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="zonezone"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">zone</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Zone</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Zone</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L144">src/utils/datetime/DateTime.ts:144</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="zonename"><span>zone<wbr/>Name</span><a href="#zonename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="zonenamezonename"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">zoneName</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L124">src/utils/datetime/DateTime.ts:124</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="date_full"><code class="tsd-tag">Static</code><span>DATE_<wbr/>FULL</span><a href="#date_full" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="date_fulldate_full"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATE_FULL</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'October 14, 1983'</p>
|
|
121
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATE_FULL</span><span class="hl-1">)</span>
|
|
122
122
|
</code><button type="button">Copy</button></pre>
|
|
123
123
|
|
|
124
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
125
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
124
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L224">src/utils/datetime/DateTime.ts:224</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="date_huge"><code class="tsd-tag">Static</code><span>DATE_<wbr/>HUGE</span><a href="#date_huge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="date_hugedate_huge"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATE_HUGE</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'Tuesday, October 14, 1983'</p>
|
|
125
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-5">Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATE_HUGE</span><span class="hl-1">)</span>
|
|
126
126
|
</code><button type="button">Copy</button></pre>
|
|
127
127
|
|
|
128
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
129
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
128
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L235">src/utils/datetime/DateTime.ts:235</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="date_med"><code class="tsd-tag">Static</code><span>DATE_<wbr/>MED</span><a href="#date_med" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="date_meddate_med"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATE_MED</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'Oct 14, 1983'</p>
|
|
129
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-6">Example<a href="#example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATE_MED</span><span class="hl-1">)</span>
|
|
130
130
|
</code><button type="button">Copy</button></pre>
|
|
131
131
|
|
|
132
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
133
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
132
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L202">src/utils/datetime/DateTime.ts:202</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="date_med_with_weekday"><code class="tsd-tag">Static</code><span>DATE_<wbr/>MED_<wbr/>WITH_<wbr/>WEEKDAY</span><a href="#date_med_with_weekday" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="date_med_with_weekdaydate_med_with_weekday"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATE_MED_WITH_WEEKDAY</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'Fri, Oct 14, 1983'</p>
|
|
133
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-7">Example<a href="#example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATE_MED_WITH_WEEKDAY</span><span class="hl-1">)</span>
|
|
134
134
|
</code><button type="button">Copy</button></pre>
|
|
135
135
|
|
|
136
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
137
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
136
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L213">src/utils/datetime/DateTime.ts:213</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="date_short"><code class="tsd-tag">Static</code><span>DATE_<wbr/>SHORT</span><a href="#date_short" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="date_shortdate_short"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATE_SHORT</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like 10/14/1983</p>
|
|
137
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-8">Example<a href="#example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATE_SHORT</span><span class="hl-1">)</span>
|
|
138
138
|
</code><button type="button">Copy</button></pre>
|
|
139
139
|
|
|
140
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
141
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
140
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L191">src/utils/datetime/DateTime.ts:191</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="datetime_full"><code class="tsd-tag">Static</code><span>DATETIME_<wbr/>FULL</span><a href="#datetime_full" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="datetime_fulldatetime_full"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATETIME_FULL</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'October 14, 1983, 9:30 AM EDT'. Only 12-hour if the locale is.</p>
|
|
141
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-9">Example<a href="#example-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATETIME_FULL</span><span class="hl-1">)</span>
|
|
142
142
|
</code><button type="button">Copy</button></pre>
|
|
143
143
|
|
|
144
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
145
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
144
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L389">src/utils/datetime/DateTime.ts:389</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="datetime_full_with_seconds"><code class="tsd-tag">Static</code><span>DATETIME_<wbr/>FULL_<wbr/>WITH_<wbr/>SECONDS</span><a href="#datetime_full_with_seconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="datetime_full_with_secondsdatetime_full_with_seconds"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATETIME_FULL_WITH_SECONDS</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'October 14, 1983, 9:30:33 AM EDT'. Only 12-hour if the locale is.</p>
|
|
145
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-10">Example<a href="#example-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATETIME_FULL_WITH_SECONDS</span><span class="hl-1">)</span>
|
|
146
146
|
</code><button type="button">Copy</button></pre>
|
|
147
147
|
|
|
148
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
149
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
148
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L400">src/utils/datetime/DateTime.ts:400</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="datetime_huge"><code class="tsd-tag">Static</code><span>DATETIME_<wbr/>HUGE</span><a href="#datetime_huge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="datetime_hugedatetime_huge"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATETIME_HUGE</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'Friday, October 14, 1983, 9:30 AM Eastern Daylight Time'. Only 12-hour if the locale is.</p>
|
|
149
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-11">Example<a href="#example-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATETIME_HUGE</span><span class="hl-1">)</span>
|
|
150
150
|
</code><button type="button">Copy</button></pre>
|
|
151
151
|
|
|
152
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
153
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
152
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L411">src/utils/datetime/DateTime.ts:411</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="datetime_huge_with_seconds"><code class="tsd-tag">Static</code><span>DATETIME_<wbr/>HUGE_<wbr/>WITH_<wbr/>SECONDS</span><a href="#datetime_huge_with_seconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="datetime_huge_with_secondsdatetime_huge_with_seconds"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATETIME_HUGE_WITH_SECONDS</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'Friday, October 14, 1983, 9:30:33 AM Eastern Daylight Time'. Only 12-hour if the locale is.</p>
|
|
153
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-12">Example<a href="#example-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATETIME_HUGE_WITH_SECONDS</span><span class="hl-1">)</span>
|
|
154
154
|
</code><button type="button">Copy</button></pre>
|
|
155
155
|
|
|
156
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
157
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
156
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L422">src/utils/datetime/DateTime.ts:422</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="datetime_med"><code class="tsd-tag">Static</code><span>DATETIME_<wbr/>MED</span><a href="#datetime_med" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="datetime_meddatetime_med"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATETIME_MED</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'Oct 14, 1983, 9:30 AM'. Only 12-hour if the locale is.</p>
|
|
157
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-13">Example<a href="#example-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATETIME_MED</span><span class="hl-1">)</span>
|
|
158
158
|
</code><button type="button">Copy</button></pre>
|
|
159
159
|
|
|
160
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
161
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
160
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L356">src/utils/datetime/DateTime.ts:356</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="datetime_med_with_seconds"><code class="tsd-tag">Static</code><span>DATETIME_<wbr/>MED_<wbr/>WITH_<wbr/>SECONDS</span><a href="#datetime_med_with_seconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="datetime_med_with_secondsdatetime_med_with_seconds"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATETIME_MED_WITH_SECONDS</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'Oct 14, 1983, 9:30:33 AM'. Only 12-hour if the locale is.</p>
|
|
161
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-14">Example<a href="#example-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATETIME_MED_WITH_SECONDS</span><span class="hl-1">)</span>
|
|
162
162
|
</code><button type="button">Copy</button></pre>
|
|
163
163
|
|
|
164
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
165
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
164
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L367">src/utils/datetime/DateTime.ts:367</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="datetime_med_with_weekday"><code class="tsd-tag">Static</code><span>DATETIME_<wbr/>MED_<wbr/>WITH_<wbr/>WEEKDAY</span><a href="#datetime_med_with_weekday" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="datetime_med_with_weekdaydatetime_med_with_weekday"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATETIME_MED_WITH_WEEKDAY</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'Fri, 14 Oct 1983, 9:30 AM'. Only 12-hour if the locale is.</p>
|
|
165
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-15">Example<a href="#example-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATETIME_MED_WITH_WEEKDAY</span><span class="hl-1">)</span>
|
|
166
166
|
</code><button type="button">Copy</button></pre>
|
|
167
167
|
|
|
168
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
169
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
168
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L378">src/utils/datetime/DateTime.ts:378</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="datetime_short"><code class="tsd-tag">Static</code><span>DATETIME_<wbr/>SHORT</span><a href="#datetime_short" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="datetime_shortdatetime_short"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATETIME_SHORT</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like '10/14/1983, 9:30 AM'. Only 12-hour if the locale is.</p>
|
|
169
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-16">Example<a href="#example-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATETIME_SHORT</span><span class="hl-1">)</span>
|
|
170
170
|
</code><button type="button">Copy</button></pre>
|
|
171
171
|
|
|
172
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
173
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
172
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L334">src/utils/datetime/DateTime.ts:334</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="datetime_short_with_seconds"><code class="tsd-tag">Static</code><span>DATETIME_<wbr/>SHORT_<wbr/>WITH_<wbr/>SECONDS</span><a href="#datetime_short_with_seconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="datetime_short_with_secondsdatetime_short_with_seconds"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">DATETIME_SHORT_WITH_SECONDS</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like '10/14/1983, 9:30:33 AM'. Only 12-hour if the locale is.</p>
|
|
173
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-17">Example<a href="#example-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATETIME_SHORT_WITH_SECONDS</span><span class="hl-1">)</span>
|
|
174
174
|
</code><button type="button">Copy</button></pre>
|
|
175
175
|
|
|
176
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
177
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
176
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L345">src/utils/datetime/DateTime.ts:345</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="time_24_simple"><code class="tsd-tag">Static</code><span>TIME_<wbr/>24_<wbr/>SIMPLE</span><a href="#time_24_simple" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="time_24_simpletime_24_simple"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">TIME_24_SIMPLE</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30', always 24-hour.</p>
|
|
177
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-18">Example<a href="#example-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">TIME_24_SIMPLE</span><span class="hl-1">)</span>
|
|
178
178
|
</code><button type="button">Copy</button></pre>
|
|
179
179
|
|
|
180
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
181
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
180
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L290">src/utils/datetime/DateTime.ts:290</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="time_24_with_long_offset"><code class="tsd-tag">Static</code><span>TIME_<wbr/>24_<wbr/>WITH_<wbr/>LONG_<wbr/>OFFSET</span><a href="#time_24_with_long_offset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="time_24_with_long_offsettime_24_with_long_offset"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">TIME_24_WITH_LONG_OFFSET</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30:23 Eastern Daylight Time', always 24-hour.</p>
|
|
181
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-19">Example<a href="#example-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">TIME_24_WITH_LONG_OFFSET</span><span class="hl-1">)</span>
|
|
182
182
|
</code><button type="button">Copy</button></pre>
|
|
183
183
|
|
|
184
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
185
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
184
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L323">src/utils/datetime/DateTime.ts:323</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="time_24_with_seconds"><code class="tsd-tag">Static</code><span>TIME_<wbr/>24_<wbr/>WITH_<wbr/>SECONDS</span><a href="#time_24_with_seconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="time_24_with_secondstime_24_with_seconds"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">TIME_24_WITH_SECONDS</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30:23', always 24-hour.</p>
|
|
185
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-20">Example<a href="#example-20" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">TIME_24_WITH_SECONDS</span><span class="hl-1">)</span>
|
|
186
186
|
</code><button type="button">Copy</button></pre>
|
|
187
187
|
|
|
188
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
189
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
188
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L301">src/utils/datetime/DateTime.ts:301</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="time_24_with_short_offset"><code class="tsd-tag">Static</code><span>TIME_<wbr/>24_<wbr/>WITH_<wbr/>SHORT_<wbr/>OFFSET</span><a href="#time_24_with_short_offset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="time_24_with_short_offsettime_24_with_short_offset"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">TIME_24_WITH_SHORT_OFFSET</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30:23 EDT', always 24-hour.</p>
|
|
189
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-21">Example<a href="#example-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">TIME_24_WITH_SHORT_OFFSET</span><span class="hl-1">)</span>
|
|
190
190
|
</code><button type="button">Copy</button></pre>
|
|
191
191
|
|
|
192
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
193
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
192
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L312">src/utils/datetime/DateTime.ts:312</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="time_simple"><code class="tsd-tag">Static</code><span>TIME_<wbr/>SIMPLE</span><a href="#time_simple" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="time_simpletime_simple"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">TIME_SIMPLE</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30 AM'. Only 12-hour if the locale is.</p>
|
|
193
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-22">Example<a href="#example-22" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">TIME_SIMPLE</span><span class="hl-1">)</span>
|
|
194
194
|
</code><button type="button">Copy</button></pre>
|
|
195
195
|
|
|
196
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
197
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
196
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L246">src/utils/datetime/DateTime.ts:246</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="time_with_long_offset"><code class="tsd-tag">Static</code><span>TIME_<wbr/>WITH_<wbr/>LONG_<wbr/>OFFSET</span><a href="#time_with_long_offset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="time_with_long_offsettime_with_long_offset"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">TIME_WITH_LONG_OFFSET</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30:23 AM Eastern Daylight Time'. Only 12-hour if the locale is.</p>
|
|
197
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-23">Example<a href="#example-23" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">TIME_WITH_LONG_OFFSET</span><span class="hl-1">)</span>
|
|
198
198
|
</code><button type="button">Copy</button></pre>
|
|
199
199
|
|
|
200
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
201
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
200
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L279">src/utils/datetime/DateTime.ts:279</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="time_with_seconds"><code class="tsd-tag">Static</code><span>TIME_<wbr/>WITH_<wbr/>SECONDS</span><a href="#time_with_seconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="time_with_secondstime_with_seconds"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">TIME_WITH_SECONDS</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30:23 AM'. Only 12-hour if the locale is.</p>
|
|
201
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-24">Example<a href="#example-24" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">TIME_WITH_SECONDS</span><span class="hl-1">)</span>
|
|
202
202
|
</code><button type="button">Copy</button></pre>
|
|
203
203
|
|
|
204
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
205
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><
|
|
204
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L257">src/utils/datetime/DateTime.ts:257</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="time_with_short_offset"><code class="tsd-tag">Static</code><span>TIME_<wbr/>WITH_<wbr/>SHORT_<wbr/>OFFSET</span><a href="#time_with_short_offset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="time_with_short_offsettime_with_short_offset"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">TIME_WITH_SHORT_OFFSET</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="#tolocalestring" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30:23 AM EDT'. Only 12-hour if the locale is.</p>
|
|
205
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-25">Example<a href="#example-25" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">TIME_WITH_SHORT_OFFSET</span><span class="hl-1">)</span>
|
|
206
206
|
</code><button type="button">Copy</button></pre>
|
|
207
207
|
|
|
208
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
208
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L268">src/utils/datetime/DateTime.ts:268</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="diff"><span>diff</span><a href="#diff" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="diff-1"><span class="tsd-kind-call-signature">diff</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#diffu">U</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/types.DurationUnit.html" class="tsd-signature-type tsd-kind-type-alias">DurationUnit</a> <span class="tsd-signature-symbol">|</span> <a href="../types/types.DurationUnit.html" class="tsd-signature-type tsd-kind-type-alias">DurationUnit</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">other</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">unit</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#diffu">U</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DiffResult</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#diffu">U</a><span class="tsd-signature-symbol">></span><a href="#diff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the difference between this and another DateTime.</p>
|
|
209
209
|
<p>Supports microsecond precision when 'microseconds' is included in the unit parameter.</p>
|
|
210
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span
|
|
211
|
-
</div
|
|
212
|
-
</div
|
|
213
|
-
<div class="tsd-comment tsd-typography"><
|
|
210
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="diffu"><span class="tsd-kind-type-parameter">U</span> <span class="tsd-signature-keyword">extends</span> <a href="../types/types.DurationUnit.html" class="tsd-signature-type tsd-kind-type-alias">DurationUnit</a> <span class="tsd-signature-symbol">|</span> <a href="../types/types.DurationUnit.html" class="tsd-signature-type tsd-kind-type-alias">DurationUnit</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span> = <span class="tsd-signature-type">undefined</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">other</span>: <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></span><div class="tsd-comment tsd-typography"><p>DateTime to diff against</p>
|
|
211
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">unit</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#diffu">U</a></span><div class="tsd-comment tsd-typography"><p>Unit or units to return (e.g., 'days', 'hours', ['days', 'hours', 'microseconds'])</p>
|
|
212
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DiffResult</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#diffu">U</a><span class="tsd-signature-symbol">></span></h4><p>Object with only the specified units (or all units if not specified)</p>
|
|
213
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-26">Example<a href="#example-26" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">dt1</span><span class="hl-1">.</span><span class="hl-5">diff</span><span class="hl-1">(</span><span class="hl-4">dt2</span><span class="hl-1">, </span><span class="hl-6">'days'</span><span class="hl-1">) </span><span class="hl-7">// { days: 5 }</span><br/><span class="hl-4">dt1</span><span class="hl-1">.</span><span class="hl-5">diff</span><span class="hl-1">(</span><span class="hl-4">dt2</span><span class="hl-1">, [</span><span class="hl-6">'days'</span><span class="hl-1">, </span><span class="hl-6">'hours'</span><span class="hl-1">]) </span><span class="hl-7">// { days: 5, hours: 3 }</span><br/><span class="hl-4">dt1</span><span class="hl-1">.</span><span class="hl-5">diff</span><span class="hl-1">(</span><span class="hl-4">dt2</span><span class="hl-1">, [</span><span class="hl-6">'milliseconds'</span><span class="hl-1">, </span><span class="hl-6">'microseconds'</span><span class="hl-1">]) </span><span class="hl-7">// { milliseconds: 123, microseconds: 456 }</span><br/><span class="hl-4">dt1</span><span class="hl-1">.</span><span class="hl-5">diff</span><span class="hl-1">(</span><span class="hl-4">dt2</span><span class="hl-1">) </span><span class="hl-7">// { years: 0, months: 0, days: 0, hours: 0, minutes: 0, seconds: 1, milliseconds: 500, microseconds: 0 }</span>
|
|
214
214
|
</code><button type="button">Copy</button></pre>
|
|
215
215
|
|
|
216
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
216
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1416">src/utils/datetime/DateTime.ts:1416</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="diffnow"><span>diff<wbr/>Now</span><a href="#diffnow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="diffnow-1"><span class="tsd-kind-call-signature">diffNow</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#diffnowu">U</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/types.DurationUnit.html" class="tsd-signature-type tsd-kind-type-alias">DurationUnit</a> <span class="tsd-signature-symbol">|</span> <a href="../types/types.DurationUnit.html" class="tsd-signature-type tsd-kind-type-alias">DurationUnit</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">unit</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#diffnowu">U</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DiffResult</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#diffnowu">U</a><span class="tsd-signature-symbol">></span><a href="#diffnow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the difference between this DateTime and now.</p>
|
|
217
217
|
<p>Supports microsecond precision when 'microseconds' is included in the unit parameter.</p>
|
|
218
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span
|
|
219
|
-
</div
|
|
220
|
-
<div class="tsd-comment tsd-typography"><
|
|
218
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="diffnowu"><span class="tsd-kind-type-parameter">U</span> <span class="tsd-signature-keyword">extends</span> <a href="../types/types.DurationUnit.html" class="tsd-signature-type tsd-kind-type-alias">DurationUnit</a> <span class="tsd-signature-symbol">|</span> <a href="../types/types.DurationUnit.html" class="tsd-signature-type tsd-kind-type-alias">DurationUnit</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span> = <span class="tsd-signature-type">undefined</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">unit</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#diffnowu">U</a></span><div class="tsd-comment tsd-typography"><p>Unit or units to return</p>
|
|
219
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DiffResult</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#diffnowu">U</a><span class="tsd-signature-symbol">></span></h4><p>Object with only the specified units (or all units if not specified)</p>
|
|
220
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-27">Example<a href="#example-27" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">dt</span><span class="hl-1">.</span><span class="hl-5">diffNow</span><span class="hl-1">(</span><span class="hl-6">'days'</span><span class="hl-1">) </span><span class="hl-7">// { days: 5 }</span><br/><span class="hl-4">dt</span><span class="hl-1">.</span><span class="hl-5">diffNow</span><span class="hl-1">([</span><span class="hl-6">'days'</span><span class="hl-1">, </span><span class="hl-6">'hours'</span><span class="hl-1">, </span><span class="hl-6">'microseconds'</span><span class="hl-1">]) </span><span class="hl-7">// { days: 5, hours: 3, microseconds: 123 }</span>
|
|
221
221
|
</code><button type="button">Copy</button></pre>
|
|
222
222
|
|
|
223
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
223
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1476">src/utils/datetime/DateTime.ts:1476</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="endof"><span>end<wbr/>Of</span><a href="#endof" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="endof-1"><span class="tsd-kind-call-signature">endOf</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">unit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeUnit</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">useLocaleWeeks</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#endof-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new DateTime at the end of the given unit.
|
|
224
224
|
Microsecond is 999 when unit is 'millisecond', else 0.</p>
|
|
225
225
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">unit</span>: <span class="tsd-signature-type">DateTimeUnit</span></span><div class="tsd-comment tsd-typography"><p>Unit to extend to end of</p>
|
|
226
|
-
</div
|
|
227
|
-
</div
|
|
228
|
-
<div class="tsd-comment tsd-typography"><
|
|
226
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">useLocaleWeeks</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Optional options</p>
|
|
227
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
228
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-28">Example<a href="#example-28" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">endOf</span><span class="hl-1">(</span><span class="hl-6">'month'</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-31T23:59:59.999999</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">endOf</span><span class="hl-1">(</span><span class="hl-6">'day'</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T23:59:59.999999</span>
|
|
229
229
|
</code><button type="button">Copy</button></pre>
|
|
230
230
|
|
|
231
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
232
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">other</span>: <a href="
|
|
233
|
-
</div
|
|
234
|
-
<div class="tsd-comment tsd-typography"><
|
|
231
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1353">src/utils/datetime/DateTime.ts:1353</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="equals"><span>equals</span><a href="#equals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="equals-1"><span class="tsd-kind-call-signature">equals</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">other</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#equals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if this and other represent the same instant and microsecond.</p>
|
|
232
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">other</span>: <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></span><div class="tsd-comment tsd-typography"><p>DateTime to compare</p>
|
|
233
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if equal</p>
|
|
234
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-29">Example<a href="#example-29" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">dt1</span><span class="hl-1">.</span><span class="hl-5">equals</span><span class="hl-1">(</span><span class="hl-4">dt2</span><span class="hl-1">)</span>
|
|
235
235
|
</code><button type="button">Copy</button></pre>
|
|
236
236
|
|
|
237
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
238
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">other</span>: <a href="
|
|
239
|
-
</div
|
|
240
|
-
</div
|
|
241
|
-
<div class="tsd-comment tsd-typography"><
|
|
237
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1163">src/utils/datetime/DateTime.ts:1163</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hassame"><span>has<wbr/>Same</span><a href="#hassame" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="hassame-1"><span class="tsd-kind-call-signature">hasSame</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">other</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">unit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeUnit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#hassame-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if this DateTime is in the same unit as another.</p>
|
|
238
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">other</span>: <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></span><div class="tsd-comment tsd-typography"><p>DateTime to compare</p>
|
|
239
|
+
</div></li><li><span><span class="tsd-kind-parameter">unit</span>: <span class="tsd-signature-type">DateTimeUnit</span></span><div class="tsd-comment tsd-typography"><p>Unit to compare</p>
|
|
240
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if same</p>
|
|
241
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-30">Example<a href="#example-30" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">dt1</span><span class="hl-1">.</span><span class="hl-5">hasSame</span><span class="hl-1">(</span><span class="hl-4">dt2</span><span class="hl-1">, </span><span class="hl-6">'day'</span><span class="hl-1">)</span>
|
|
242
242
|
</code><button type="button">Copy</button></pre>
|
|
243
243
|
|
|
244
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
244
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1396">src/utils/datetime/DateTime.ts:1396</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="minus"><span>minus</span><a href="#minus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="minus-1"><span class="tsd-kind-call-signature">minus</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">duration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">DurationLikeObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#minus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Subtracts a duration from this DateTime. Supports microsecond via DurationLikeObject.
|
|
245
245
|
Fractional milliseconds are converted to microseconds (e.g., 1.5 ms = 1 ms + 500 µs).</p>
|
|
246
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">duration</span>: <span class="tsd-signature-type">number</span
|
|
247
|
-
</div
|
|
248
|
-
<div class="tsd-comment tsd-typography"><
|
|
246
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">duration</span>: <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">DurationLikeObject</span></span><div class="tsd-comment tsd-typography"><p>Duration to subtract</p>
|
|
247
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
248
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-31">Example<a href="#example-31" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">14</span><span class="hl-1">).</span><span class="hl-5">minus</span><span class="hl-1">({ </span><span class="hl-4">hours:</span><span class="hl-1"> </span><span class="hl-8">2</span><span class="hl-1"> })</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">minus</span><span class="hl-1">({ </span><span class="hl-4">milliseconds:</span><span class="hl-1"> </span><span class="hl-8">1.5</span><span class="hl-1"> }) </span><span class="hl-7">// subtracts 1ms + 500µs</span>
|
|
249
249
|
</code><button type="button">Copy</button></pre>
|
|
250
250
|
|
|
251
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
251
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1105">src/utils/datetime/DateTime.ts:1105</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="plus"><span>plus</span><a href="#plus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="plus-1"><span class="tsd-kind-call-signature">plus</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">duration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">DurationLikeObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#plus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a duration to this DateTime. Supports microsecond via DurationLikeObject.
|
|
252
252
|
Fractional milliseconds are converted to microseconds (e.g., 1.5 ms = 1 ms + 500 µs).</p>
|
|
253
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">duration</span>: <span class="tsd-signature-type">number</span
|
|
254
|
-
</div
|
|
255
|
-
<div class="tsd-comment tsd-typography"><
|
|
253
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">duration</span>: <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">DurationLikeObject</span></span><div class="tsd-comment tsd-typography"><p>Duration to add (DurationLikeObject with microsecond, or milliseconds number)</p>
|
|
254
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
255
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-32">Example<a href="#example-32" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">plus</span><span class="hl-1">({ </span><span class="hl-4">hours:</span><span class="hl-1"> </span><span class="hl-8">2</span><span class="hl-1"> })</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">500</span><span class="hl-1">).</span><span class="hl-5">plus</span><span class="hl-1">({ </span><span class="hl-4">microseconds:</span><span class="hl-1"> </span><span class="hl-8">600</span><span class="hl-1"> })</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">plus</span><span class="hl-1">({ </span><span class="hl-4">milliseconds:</span><span class="hl-1"> </span><span class="hl-8">1.5</span><span class="hl-1"> }) </span><span class="hl-7">// adds 1ms + 500µs</span>
|
|
256
256
|
</code><button type="button">Copy</button></pre>
|
|
257
257
|
|
|
258
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
258
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1084">src/utils/datetime/DateTime.ts:1084</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="reconfigure"><span>reconfigure</span><a href="#reconfigure" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="reconfigure-1"><span class="tsd-kind-call-signature">reconfigure</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">properties</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#reconfigure-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new DateTime with the given locale/zone options. Microsecond is preserved.</p>
|
|
259
259
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">properties</span>: <span class="tsd-signature-type">LocaleOptions</span></span><div class="tsd-comment tsd-typography"><p>Locale and/or zone options</p>
|
|
260
|
-
</div
|
|
261
|
-
<div class="tsd-comment tsd-typography"><
|
|
260
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
261
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-33">Example<a href="#example-33" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">reconfigure</span><span class="hl-1">({ </span><span class="hl-4">locale:</span><span class="hl-1"> </span><span class="hl-6">'fr'</span><span class="hl-1"> })</span>
|
|
262
262
|
</code><button type="button">Copy</button></pre>
|
|
263
263
|
|
|
264
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
264
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1367">src/utils/datetime/DateTime.ts:1367</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="set"><span>set</span><a href="#set" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="set-1"><span class="tsd-kind-call-signature">set</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">values</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DateTimeObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#set-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new DateTime with the given units set.</p>
|
|
265
265
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">values</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DateTimeObject</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Object with units to set (year, month, day, hour, minute, second, millisecond, microsecond)</p>
|
|
266
|
-
</div
|
|
267
|
-
<div class="tsd-comment tsd-typography"><
|
|
266
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
267
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-34">Example<a href="#example-34" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">set</span><span class="hl-1">({ </span><span class="hl-4">hour:</span><span class="hl-1"> </span><span class="hl-8">14</span><span class="hl-1">, </span><span class="hl-4">microsecond:</span><span class="hl-1"> </span><span class="hl-8">500</span><span class="hl-1"> })</span>
|
|
268
268
|
</code><button type="button">Copy</button></pre>
|
|
269
269
|
|
|
270
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
270
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1124">src/utils/datetime/DateTime.ts:1124</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setlocale"><span>set<wbr/>Locale</span><a href="#setlocale" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setlocale-1"><span class="tsd-kind-call-signature">setLocale</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">locale</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#setlocale-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new DateTime with the given locale. Microsecond is preserved.</p>
|
|
271
271
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">locale</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Locale string (e.g. 'en-US', 'fr')</p>
|
|
272
|
-
</div
|
|
273
|
-
<div class="tsd-comment tsd-typography"><
|
|
272
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
273
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-35">Example<a href="#example-35" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">setLocale</span><span class="hl-1">(</span><span class="hl-6">'fr'</span><span class="hl-1">)</span>
|
|
274
274
|
</code><button type="button">Copy</button></pre>
|
|
275
275
|
|
|
276
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
277
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">zone</span>: <span class="tsd-signature-type">string</span
|
|
278
|
-
</div
|
|
279
|
-
</div
|
|
280
|
-
<div class="tsd-comment tsd-typography"><
|
|
276
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1381">src/utils/datetime/DateTime.ts:1381</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setzone"><span>set<wbr/>Zone</span><a href="#setzone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setzone-1"><span class="tsd-kind-call-signature">setZone</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">zone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Zone</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">keepLocalTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#setzone-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new DateTime in the given zone. Microsecond is preserved.</p>
|
|
277
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">zone</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Zone</span></span><div class="tsd-comment tsd-typography"><p>Zone name or Zone instance</p>
|
|
278
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">keepLocalTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Optional zone options (keepLocalTime, etc.)</p>
|
|
279
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
280
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-36">Example<a href="#example-36" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">setZone</span><span class="hl-1">(</span><span class="hl-6">'utc'</span><span class="hl-1">)</span>
|
|
281
281
|
</code><button type="button">Copy</button></pre>
|
|
282
282
|
|
|
283
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
283
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1292">src/utils/datetime/DateTime.ts:1292</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="startof"><span>start<wbr/>Of</span><a href="#startof" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="startof-1"><span class="tsd-kind-call-signature">startOf</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">unit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeUnit</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">useLocaleWeeks</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#startof-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new DateTime at the start of the given unit.
|
|
284
284
|
Microsecond is 0 except when unit is 'millisecond' (then preserved).</p>
|
|
285
285
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">unit</span>: <span class="tsd-signature-type">DateTimeUnit</span></span><div class="tsd-comment tsd-typography"><p>Unit to truncate to (year, month, day, hour, minute, second, millisecond)</p>
|
|
286
|
-
</div
|
|
287
|
-
</div
|
|
288
|
-
<div class="tsd-comment tsd-typography"><
|
|
286
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">useLocaleWeeks</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Optional options</p>
|
|
287
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
288
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-37">Example<a href="#example-37" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">14</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">).</span><span class="hl-5">startOf</span><span class="hl-1">(</span><span class="hl-6">'day'</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T00:00:00</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">14</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">).</span><span class="hl-5">startOf</span><span class="hl-1">(</span><span class="hl-6">'hour'</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T14:00:00</span>
|
|
289
289
|
</code><button type="button">Copy</button></pre>
|
|
290
290
|
|
|
291
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
291
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1336">src/utils/datetime/DateTime.ts:1336</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="toformat"><span>to<wbr/>Format</span><a href="#toformat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="toformat-1"><span class="tsd-kind-call-signature">toFormat</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fmt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#toformat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation using a format string.
|
|
292
292
|
Supports all Luxon format tokens. Fractional second tokens (S, SSS, SSSSSS) are enhanced
|
|
293
293
|
to include microseconds beyond Luxon's millisecond precision.</p>
|
|
294
294
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fmt</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Format string (e.g., 'yyyy-MM-dd HH:mm:ss', 'yyyy-MM-dd HH:mm:ss.SSSSSS')</p>
|
|
295
|
-
</div
|
|
296
|
-
</div
|
|
297
|
-
<div class="tsd-comment tsd-typography"><
|
|
295
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional locale options</p>
|
|
296
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>Formatted string</p>
|
|
297
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-38">Example<a href="#example-38" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">toFormat</span><span class="hl-1">(</span><span class="hl-6">'yyyy-MM-dd'</span><span class="hl-1">) </span><span class="hl-7">// '2017-03-12'</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">).</span><span class="hl-5">toFormat</span><span class="hl-1">(</span><span class="hl-6">'yyyy-MM-dd HH:mm:ss.SSSSSS'</span><span class="hl-1">) </span><span class="hl-7">// '2017-03-12 10:30:45.123456'</span>
|
|
298
298
|
</code><button type="button">Copy</button></pre>
|
|
299
299
|
|
|
300
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
300
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1048">src/utils/datetime/DateTime.ts:1048</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="toiso"><span>to<wbr/>ISO</span><a href="#toiso" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="toiso-1"><span class="tsd-kind-call-signature">toISO</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ToISOTimeOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#toiso-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an ISO 8601 string with 6 fractional second digits (milliseconds + microseconds).</p>
|
|
301
301
|
<p>Preserves the timezone of the DateTime instance.</p>
|
|
302
302
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">ToISOTimeOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional format options</p>
|
|
303
|
-
</div><
|
|
304
|
-
|
|
303
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>suppressMilliseconds</span></h5><div class="tsd-comment tsd-typography"><p>If true, omits fractional seconds when they are zero</p>
|
|
304
|
+
</div></li><li class="tsd-parameter"><h5><span>suppressSeconds</span></h5><div class="tsd-comment tsd-typography"><p>If true, omits seconds when they are zero</p>
|
|
305
|
+
</div></li><li class="tsd-parameter"><h5><span>includeOffset</span></h5><div class="tsd-comment tsd-typography"><p>If true, includes timezone offset</p>
|
|
306
|
+
</div></li><li class="tsd-parameter"><h5><span>format</span></h5><div class="tsd-comment tsd-typography"><p>Format variant: 'basic' (compact) or 'extended' (default, with separators)</p>
|
|
307
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>ISO string (e.g. "2024-03-15T10:30:45.123456-05:00" or "2024-03-15T10:30:45.123456Z")</p>
|
|
308
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-39">Example<a href="#example-39" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2024-03-15T10:30:45.123456-05:00'</span><span class="hl-1">).</span><span class="hl-5">toISO</span><span class="hl-1">() </span><span class="hl-7">// '2024-03-15T10:30:45.123456-05:00'</span>
|
|
305
309
|
</code><button type="button">Copy</button></pre>
|
|
306
310
|
|
|
307
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
311
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L848">src/utils/datetime/DateTime.ts:848</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="toisodate"><span>to<wbr/>ISO<wbr/>Date</span><a href="#toisodate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="toisodate-1"><span class="tsd-kind-call-signature">toISODate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#toisodate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an ISO date string (date only, no time).</p>
|
|
308
312
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>ISO date string (e.g. "2024-03-15")</p>
|
|
309
|
-
<div class="tsd-comment tsd-typography"><
|
|
313
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-40">Example<a href="#example-40" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">toISODate</span><span class="hl-1">()</span>
|
|
310
314
|
</code><button type="button">Copy</button></pre>
|
|
311
315
|
|
|
312
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
316
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L860">src/utils/datetime/DateTime.ts:860</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="toisotime"><span>to<wbr/>ISO<wbr/>Time</span><a href="#toisotime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="toisotime-1"><span class="tsd-kind-call-signature">toISOTime</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ToISOTimeOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#toisotime-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the time portion in ISO format with 6 fractional second digits.</p>
|
|
313
317
|
<p>Omits timezone offset by default (e.g., '10:30:45.123456').</p>
|
|
314
318
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">ToISOTimeOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional format options</p>
|
|
315
|
-
</div><
|
|
316
|
-
|
|
319
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>suppressMilliseconds</span></h5><div class="tsd-comment tsd-typography"><p>If true, omits fractional seconds when they are zero</p>
|
|
320
|
+
</div></li><li class="tsd-parameter"><h5><span>suppressSeconds</span></h5><div class="tsd-comment tsd-typography"><p>If true, omits seconds when they are zero</p>
|
|
321
|
+
</div></li><li class="tsd-parameter"><h5><span>includeOffset</span></h5><div class="tsd-comment tsd-typography"><p>If true, includes timezone offset</p>
|
|
322
|
+
</div></li><li class="tsd-parameter"><h5><span>format</span></h5><div class="tsd-comment tsd-typography"><p>Format variant: 'basic' (compact) or 'extended' (default, with colons)</p>
|
|
323
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>Time string (e.g. "10:30:45.123456" or "10:30:45.123456-05:00")</p>
|
|
324
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-41">Example<a href="#example-41" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">).</span><span class="hl-5">toISOTime</span><span class="hl-1">() </span><span class="hl-7">// '10:30:45.123456'</span>
|
|
317
325
|
</code><button type="button">Copy</button></pre>
|
|
318
326
|
|
|
319
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
327
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L880">src/utils/datetime/DateTime.ts:880</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tojsdate"><span>to<wbr/>JS<wbr/>Date</span><a href="#tojsdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tojsdate-1"><span class="tsd-kind-call-signature">toJSDate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><a href="#tojsdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a JavaScript Date object.</p>
|
|
320
328
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><p>JavaScript Date</p>
|
|
321
|
-
<div class="tsd-comment tsd-typography"><
|
|
329
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-42">Example<a href="#example-42" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">toJSDate</span><span class="hl-1">()</span>
|
|
322
330
|
</code><button type="button">Copy</button></pre>
|
|
323
331
|
|
|
324
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
332
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L954">src/utils/datetime/DateTime.ts:954</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tojson"><span>to<wbr/>JSON</span><a href="#tojson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tojson-1"><span class="tsd-kind-call-signature">toJSON</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tojson-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an ISO 8601 formatted string for JSON serialization.
|
|
325
333
|
This ensures DateTime objects are properly serialized to ISO format.</p>
|
|
326
334
|
<p>Preserves the timezone of the DateTime instance.</p>
|
|
327
335
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>ISO datetime string with microsecond precision</p>
|
|
328
|
-
<div class="tsd-comment tsd-typography"><
|
|
336
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-43">Example<a href="#example-43" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2026-02-07T09:03:44.123456Z'</span><span class="hl-1">).</span><span class="hl-5">toJSON</span><span class="hl-1">() </span><span class="hl-7">// '2026-02-07T09:03:44.123456Z'</span><br/><span class="hl-2">JSON</span><span class="hl-1">.</span><span class="hl-5">stringify</span><span class="hl-1">({ </span><span class="hl-4">time:</span><span class="hl-1"> </span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">() }) </span><span class="hl-7">// Uses toJSON() automatically</span>
|
|
329
337
|
</code><button type="button">Copy</button></pre>
|
|
330
338
|
|
|
331
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
332
|
-
</div><h4 class="tsd-returns-title">Returns <a href="
|
|
333
|
-
<div class="tsd-comment tsd-typography"><
|
|
339
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L990">src/utils/datetime/DateTime.ts:990</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tolocal"><span>to<wbr/>Local</span><a href="#tolocal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tolocal-1"><span class="tsd-kind-call-signature">toLocal</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#tolocal-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new DateTime in the system's local zone. Microsecond is preserved.</p>
|
|
340
|
+
</div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime in local zone</p>
|
|
341
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-44">Example<a href="#example-44" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">dtUTC</span><span class="hl-1">.</span><span class="hl-5">toLocal</span><span class="hl-1">()</span>
|
|
334
342
|
</code><button type="button">Copy</button></pre>
|
|
335
343
|
|
|
336
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
344
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1320">src/utils/datetime/DateTime.ts:1320</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tolocalestring"><span>to<wbr/>Locale<wbr/>String</span><a href="#tolocalestring" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tolocalestring-1"><span class="tsd-kind-call-signature">toLocaleString</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formatOpts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tolocalestring-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a localized string representation.</p>
|
|
337
345
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">formatOpts</span>: <span class="tsd-signature-type">DateTimeFormatOptions</span></span><div class="tsd-comment tsd-typography"><p>Intl.DateTimeFormat options for formatting</p>
|
|
338
|
-
</div
|
|
339
|
-
</div><
|
|
340
|
-
|
|
346
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional locale configuration</p>
|
|
347
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
348
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
349
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
350
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>Localized string</p>
|
|
351
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-45">Example<a href="#example-45" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">toLocaleString</span><span class="hl-1">()</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">toLocaleString</span><span class="hl-1">(</span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-2">DATE_FULL</span><span class="hl-1">)</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">toLocaleString</span><span class="hl-1">({ </span><span class="hl-4">weekday:</span><span class="hl-1"> </span><span class="hl-6">'long'</span><span class="hl-1"> }, { </span><span class="hl-4">locale:</span><span class="hl-1"> </span><span class="hl-6">'fr-FR'</span><span class="hl-1"> })</span>
|
|
341
352
|
</code><button type="button">Copy</button></pre>
|
|
342
353
|
|
|
343
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
354
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1027">src/utils/datetime/DateTime.ts:1027</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="toluxon"><span>to<wbr/>Luxon</span><a href="#toluxon" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="toluxon-1"><span class="tsd-kind-call-signature">toLuxon</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTime</span><a href="#toluxon-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the underlying Luxon DateTime instance.
|
|
344
355
|
Since Luxon is immutable, it is safe to return the actual object.</p>
|
|
345
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTime</span
|
|
346
|
-
<div class="tsd-comment tsd-typography"><
|
|
356
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTime</span></h4><p>The Luxon DateTime instance</p>
|
|
357
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-46">Example<a href="#example-46" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">dt</span><span class="hl-1"> = </span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">()</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">luxon</span><span class="hl-1"> = </span><span class="hl-4">dt</span><span class="hl-1">.</span><span class="hl-5">toLuxon</span><span class="hl-1">()</span>
|
|
347
358
|
</code><button type="button">Copy</button></pre>
|
|
348
359
|
|
|
349
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
360
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L166">src/utils/datetime/DateTime.ts:166</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tomicroseconds"><span>to<wbr/>Microseconds</span><a href="#tomicroseconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tomicroseconds-1"><span class="tsd-kind-call-signature">toMicroseconds</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#tomicroseconds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the epoch time in microseconds (toMillis * 1000 + microsecond).</p>
|
|
350
361
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>Unix timestamp in microseconds</p>
|
|
351
|
-
<div class="tsd-comment tsd-typography"><
|
|
362
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-47">Example<a href="#example-47" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromMicroseconds</span><span class="hl-1">(</span><span class="hl-8">1707234567890123</span><span class="hl-1">).</span><span class="hl-5">toMicroseconds</span><span class="hl-1">() </span><span class="hl-7">// 1707234567890123</span>
|
|
352
363
|
</code><button type="button">Copy</button></pre>
|
|
353
364
|
|
|
354
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
365
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1187">src/utils/datetime/DateTime.ts:1187</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tomillis"><span>to<wbr/>Millis</span><a href="#tomillis" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tomillis-1"><span class="tsd-kind-call-signature">toMillis</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#tomillis-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the epoch time in milliseconds (toMillis * 1000 + millisecond).</p>
|
|
355
366
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>Unix timestamp in milliseconds</p>
|
|
356
|
-
<div class="tsd-comment tsd-typography"><
|
|
367
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-48">Example<a href="#example-48" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromMicroseconds</span><span class="hl-1">(</span><span class="hl-8">1770455024077750</span><span class="hl-1">).</span><span class="hl-5">toMillis</span><span class="hl-1">() </span><span class="hl-7">// 1770455024077.75</span>
|
|
357
368
|
</code><button type="button">Copy</button></pre>
|
|
358
369
|
|
|
359
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
370
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1175">src/utils/datetime/DateTime.ts:1175</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="toobject"><span>to<wbr/>Object</span><a href="#toobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="toobject-1"><span class="tsd-kind-call-signature">toObject</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeObject</span><a href="#toobject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an object with date/time components including microsecond.</p>
|
|
360
371
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeObject</span></h4><p>Object with year, month, day, hour, minute, second, millisecond, microsecond</p>
|
|
361
|
-
<div class="tsd-comment tsd-typography"><
|
|
372
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-49">Example<a href="#example-49" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">5</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">).</span><span class="hl-5">toObject</span><span class="hl-1">()</span>
|
|
362
373
|
</code><button type="button">Copy</button></pre>
|
|
363
374
|
|
|
364
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
365
|
-
|
|
366
|
-
|
|
375
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1140">src/utils/datetime/DateTime.ts:1140</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="toseconds"><span>to<wbr/>Seconds</span><a href="#toseconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="toseconds-1"><span class="tsd-kind-call-signature">toSeconds</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#toseconds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the epoch time in seconds, including fractional milliseconds.
|
|
376
|
+
Includes microsecond precision in the fractional part.</p>
|
|
377
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>Unix timestamp in seconds (with fractional milliseconds)</p>
|
|
378
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-50">Example<a href="#example-50" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromSeconds</span><span class="hl-1">(</span><span class="hl-8">1707234567</span><span class="hl-1">).</span><span class="hl-5">toSeconds</span><span class="hl-1">() </span><span class="hl-7">// 1707234567</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2026-02-07T09:03:44.123456Z'</span><span class="hl-1">).</span><span class="hl-5">toSeconds</span><span class="hl-1">() </span><span class="hl-7">// includes .123456 in fractional part</span>
|
|
367
379
|
</code><button type="button">Copy</button></pre>
|
|
368
380
|
|
|
369
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
370
|
-
<p>
|
|
371
|
-
|
|
372
|
-
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">include<wbr/>Offset</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If true, includes timezone offset</p>
|
|
373
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>SQL time string (e.g. "10:30:45.123456")</p>
|
|
374
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-51" class="tsd-anchor"></a>Example<a href="#Example-51" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">).</span><span class="hl-5">toSQLTime</span><span class="hl-1">() </span><span class="hl-7">// '10:30:45.123456'</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">).</span><span class="hl-5">toSQLTime</span><span class="hl-1">({ </span><span class="hl-4">includeOffset:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> }) </span><span class="hl-7">// '10:30:45.123456 -04:00'</span>
|
|
381
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1201">src/utils/datetime/DateTime.ts:1201</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tosql"><span>to<wbr/>SQL</span><a href="#tosql" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tosql-1"><span class="tsd-kind-call-signature">toSQL</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tosql-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L903">src/utils/datetime/DateTime.ts:903</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tosqldate"><span>to<wbr/>SQL<wbr/>Date</span><a href="#tosqldate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tosqldate-1"><span class="tsd-kind-call-signature">toSQLDate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tosqldate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an SQL date string (date only, no time).</p>
|
|
382
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>SQL date string (e.g. "2024-03-15")</p>
|
|
383
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-51">Example<a href="#example-51" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">toSQLDate</span><span class="hl-1">()</span>
|
|
375
384
|
</code><button type="button">Copy</button></pre>
|
|
376
385
|
|
|
377
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
378
|
-
|
|
379
|
-
</div><h4 class="tsd-
|
|
380
|
-
|
|
386
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L918">src/utils/datetime/DateTime.ts:918</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tosqltime"><span>to<wbr/>SQL<wbr/>Time</span><a href="#tosqltime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tosqltime-1"><span class="tsd-kind-call-signature">toSQLTime</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeOffset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tosqltime-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an SQL time string with 6 fractional second digits.</p>
|
|
387
|
+
<p>Omits timezone offset by default.</p>
|
|
388
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">includeOffset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Optional SQL time format options</p>
|
|
389
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">includeOffset</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If true, includes timezone offset</p>
|
|
390
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>SQL time string (e.g. "10:30:45.123456")</p>
|
|
391
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-52">Example<a href="#example-52" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">).</span><span class="hl-5">toSQLTime</span><span class="hl-1">() </span><span class="hl-7">// '10:30:45.123456'</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">).</span><span class="hl-5">toSQLTime</span><span class="hl-1">({ </span><span class="hl-4">includeOffset:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> }) </span><span class="hl-7">// '10:30:45.123456 -04:00'</span>
|
|
381
392
|
</code><button type="button">Copy</button></pre>
|
|
382
393
|
|
|
383
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
394
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L936">src/utils/datetime/DateTime.ts:936</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tostring"><span>to<wbr/>String</span><a href="#tostring" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tostring-1"><span class="tsd-kind-call-signature">toString</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tostring-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an ISO 8601 formatted string representation.
|
|
384
395
|
Alias for toISO().</p>
|
|
385
396
|
<p>Preserves the timezone of the DateTime instance.</p>
|
|
386
397
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>ISO datetime string with microsecond precision</p>
|
|
387
|
-
<div class="tsd-comment tsd-typography"><
|
|
398
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-53">Example<a href="#example-53" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2026-02-07T09:03:44.123456Z'</span><span class="hl-1">).</span><span class="hl-5">toString</span><span class="hl-1">() </span><span class="hl-7">// '2026-02-07T09:03:44.123456Z'</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">dt</span><span class="hl-1"> = </span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">)</span><br/><span class="hl-6">`The time is </span><span class="hl-0">${</span><span class="hl-4">dt</span><span class="hl-0">}</span><span class="hl-6">`</span><span class="hl-1"> </span><span class="hl-7">// Uses toString() implicitly</span>
|
|
388
399
|
</code><button type="button">Copy</button></pre>
|
|
389
400
|
|
|
390
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
401
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1008">src/utils/datetime/DateTime.ts:1008</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="toutc"><span>to<wbr/>UTC</span><a href="#toutc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="toutc-1"><span class="tsd-kind-call-signature">toUTC</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">keepLocalTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#toutc-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new DateTime in UTC. Microsecond is preserved.</p>
|
|
391
402
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">offset</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Optional offset in minutes</p>
|
|
392
|
-
</div
|
|
393
|
-
</div
|
|
394
|
-
<div class="tsd-comment tsd-typography"><
|
|
403
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">keepLocalTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Optional zone options</p>
|
|
404
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime in UTC</p>
|
|
405
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-54">Example<a href="#example-54" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">).</span><span class="hl-5">toUTC</span><span class="hl-1">()</span>
|
|
395
406
|
</code><button type="button">Copy</button></pre>
|
|
396
407
|
|
|
397
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
408
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1307">src/utils/datetime/DateTime.ts:1307</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="valueof"><span>value<wbr/>Of</span><a href="#valueof" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="valueof-1"><span class="tsd-kind-call-signature">valueOf</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#valueof-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L971">src/utils/datetime/DateTime.ts:971</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromformat"><code class="tsd-tag">Static</code><span>from<wbr/>Format</span><a href="#fromformat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromformat-1"><span class="tsd-kind-call-signature">fromFormat</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">format</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#fromformat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a DateTime from a custom format string.
|
|
398
409
|
Supports standard Luxon format tokens plus 'u' or 'SSSSSS' for microseconds (6 decimal places).</p>
|
|
399
410
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The string to parse</p>
|
|
400
|
-
</div
|
|
401
|
-
</div
|
|
402
|
-
</div
|
|
403
|
-
<div class="tsd-comment tsd-typography"><
|
|
404
|
-
|
|
411
|
+
</div></li><li><span><span class="tsd-kind-parameter">format</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Format string using Luxon tokens (e.g., 'MM/dd/yyyy HH:mm:ss.u')</p>
|
|
412
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional parsing options (zone, locale, etc.)</p>
|
|
413
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the parsed instant</p>
|
|
414
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the string doesn't match the format or is invalid</p>
|
|
415
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-55">Example<a href="#example-55" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromFormat</span><span class="hl-1">(</span><span class="hl-6">'12/15/2017'</span><span class="hl-1">, </span><span class="hl-6">'MM/dd/yyyy'</span><span class="hl-1">)</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromFormat</span><span class="hl-1">(</span><span class="hl-6">'12/15/2017 10:30:45'</span><span class="hl-1">, </span><span class="hl-6">'MM/dd/yyyy HH:mm:ss'</span><span class="hl-1">)</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromFormat</span><span class="hl-1">(</span><span class="hl-6">'12/15/2017 10:30:45.123456'</span><span class="hl-1">, </span><span class="hl-6">'MM/dd/yyyy HH:mm:ss.u'</span><span class="hl-1">)</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromFormat</span><span class="hl-1">(</span><span class="hl-6">'12/15/2017 10:30:45.123456'</span><span class="hl-1">, </span><span class="hl-6">'MM/dd/yyyy HH:mm:ss.SSSSSS'</span><span class="hl-1">)</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromFormat</span><span class="hl-1">(</span><span class="hl-6">'mai 25, 1982'</span><span class="hl-1">, </span><span class="hl-6">'MMMM dd, yyyy'</span><span class="hl-1">, { </span><span class="hl-4">locale:</span><span class="hl-1"> </span><span class="hl-6">'fr'</span><span class="hl-1"> })</span>
|
|
405
416
|
</code><button type="button">Copy</button></pre>
|
|
406
417
|
|
|
407
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
418
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L818">src/utils/datetime/DateTime.ts:818</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromiso"><code class="tsd-tag">Static</code><span>from<wbr/>ISO</span><a href="#fromiso" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromiso-1"><span class="tsd-kind-call-signature">fromISO</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#fromiso-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a DateTime from an ISO 8601 string.</p>
|
|
408
419
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>ISO string (e.g. "2024-03-15T10:30:45.123456-05:00"); parses up to 6 fractional second digits</p>
|
|
409
|
-
</div
|
|
410
|
-
</div><
|
|
411
|
-
|
|
420
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
421
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone to interpret/convert the datetime in (defaults to UTC)</p>
|
|
422
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
423
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
424
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
425
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the parsed instant</p>
|
|
426
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-56">Example<a href="#example-56" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2024-03-15T10:30:45.123456-05:00'</span><span class="hl-1">)</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2024-03-15T10:30:45Z'</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> })</span>
|
|
412
427
|
</code><button type="button">Copy</button></pre>
|
|
413
428
|
|
|
414
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
429
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L761">src/utils/datetime/DateTime.ts:761</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromjsdate"><code class="tsd-tag">Static</code><span>from<wbr/>JS<wbr/>Date</span><a href="#fromjsdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromjsdate-1"><span class="tsd-kind-call-signature">fromJSDate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">date</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#fromjsdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a DateTime from a JavaScript Date.</p>
|
|
415
430
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">date</span>: <span class="tsd-signature-type">Date</span></span><div class="tsd-comment tsd-typography"><p>A JavaScript Date instance</p>
|
|
416
|
-
</div
|
|
417
|
-
</div><
|
|
418
|
-
|
|
431
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
432
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone for the result (IANA timezone name or Zone object)</p>
|
|
433
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
434
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
435
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
436
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime representing the same instant</p>
|
|
437
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-57">Example<a href="#example-57" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromJSDate</span><span class="hl-1">(</span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-5">Date</span><span class="hl-1">())</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromJSDate</span><span class="hl-1">(</span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-5">Date</span><span class="hl-1">(), { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> })</span>
|
|
419
438
|
</code><button type="button">Copy</button></pre>
|
|
420
439
|
|
|
421
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
440
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L626">src/utils/datetime/DateTime.ts:626</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="frommicroseconds"><code class="tsd-tag">Static</code><span>from<wbr/>Microseconds</span><a href="#frommicroseconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="frommicroseconds-1"><span class="tsd-kind-call-signature">fromMicroseconds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">microsecondsInput</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#frommicroseconds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a DateTime from epoch microseconds.</p>
|
|
422
441
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">microsecondsInput</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
423
|
-
</div><
|
|
424
|
-
|
|
442
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone for the result (IANA timezone name or Zone object)</p>
|
|
443
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
444
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
445
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
446
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the given instant</p>
|
|
447
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-58">Example<a href="#example-58" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromMicroseconds</span><span class="hl-1">(</span><span class="hl-8">1707234567890123</span><span class="hl-1">)</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromMicroseconds</span><span class="hl-1">(</span><span class="hl-8">1707234567890123</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> })</span>
|
|
425
448
|
</code><button type="button">Copy</button></pre>
|
|
426
449
|
|
|
427
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
450
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L673">src/utils/datetime/DateTime.ts:673</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="frommillis"><code class="tsd-tag">Static</code><span>from<wbr/>Millis</span><a href="#frommillis" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="frommillis-1"><span class="tsd-kind-call-signature">fromMillis</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">millisecondInput</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#frommillis-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a DateTime from epoch milliseconds.</p>
|
|
428
451
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">millisecondInput</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Unix timestamp in milliseconds (fractional part becomes microseconds)</p>
|
|
429
|
-
</div
|
|
430
|
-
</div><
|
|
431
|
-
|
|
452
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
453
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone for the result (IANA timezone name or Zone object)</p>
|
|
454
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
455
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
456
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
457
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the given instant</p>
|
|
458
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-59">Example<a href="#example-59" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromMillis</span><span class="hl-1">(</span><span class="hl-8">1707234567890</span><span class="hl-1">)</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromMillis</span><span class="hl-1">(</span><span class="hl-8">1707234567890.123</span><span class="hl-1">) </span><span class="hl-7">// .123 ms = 123 microseconds</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromMillis</span><span class="hl-1">(</span><span class="hl-8">1707234567890</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> })</span>
|
|
432
459
|
</code><button type="button">Copy</button></pre>
|
|
433
460
|
|
|
434
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
461
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L650">src/utils/datetime/DateTime.ts:650</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromobject"><code class="tsd-tag">Static</code><span>from<wbr/>Object</span><a href="#fromobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromobject-1"><span class="tsd-kind-call-signature">fromObject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DateTimeObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#fromobject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a DateTime from an object with date/time units.
|
|
435
462
|
Fractional milliseconds are converted to microseconds (e.g., 1.5 ms = 1 ms + 500 µs).</p>
|
|
436
463
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">obj</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DateTimeObject</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Object with year, month, day, hour, minute, second, millisecond, microsecond</p>
|
|
437
|
-
</div
|
|
438
|
-
</div><
|
|
439
|
-
|
|
464
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
465
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone for the datetime (IANA timezone name or Zone object)</p>
|
|
466
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
467
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
468
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
469
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the given components</p>
|
|
470
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-60">Example<a href="#example-60" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</span><span class="hl-1">({ </span><span class="hl-4">year:</span><span class="hl-1"> </span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-4">month:</span><span class="hl-1"> </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-4">day:</span><span class="hl-1"> </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-4">hour:</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1">, </span><span class="hl-4">minute:</span><span class="hl-1"> </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-4">microsecond:</span><span class="hl-1"> </span><span class="hl-8">123</span><span class="hl-1"> })</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</span><span class="hl-1">({ </span><span class="hl-4">year:</span><span class="hl-1"> </span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-4">month:</span><span class="hl-1"> </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-4">day:</span><span class="hl-1"> </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-4">millisecond:</span><span class="hl-1"> </span><span class="hl-8">1.5</span><span class="hl-1"> }) </span><span class="hl-7">// 1ms + 500µs</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</span><span class="hl-1">({ </span><span class="hl-4">year:</span><span class="hl-1"> </span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-4">month:</span><span class="hl-1"> </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-4">day:</span><span class="hl-1"> </span><span class="hl-8">12</span><span class="hl-1"> }, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> })</span>
|
|
440
471
|
</code><button type="button">Copy</button></pre>
|
|
441
472
|
|
|
442
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
473
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L722">src/utils/datetime/DateTime.ts:722</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromseconds"><code class="tsd-tag">Static</code><span>from<wbr/>Seconds</span><a href="#fromseconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromseconds-1"><span class="tsd-kind-call-signature">fromSeconds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seconds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#fromseconds-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a DateTime from epoch seconds.
|
|
474
|
+
Fractional seconds are converted to milliseconds and microseconds.</p>
|
|
475
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">seconds</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Unix timestamp in seconds (fractional part becomes ms + µs)</p>
|
|
476
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
477
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone for the result (IANA timezone name or Zone object)</p>
|
|
478
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
479
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
480
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
481
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the given instant</p>
|
|
482
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-61">Example<a href="#example-61" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromSeconds</span><span class="hl-1">(</span><span class="hl-8">1707234567</span><span class="hl-1">)</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromSeconds</span><span class="hl-1">(</span><span class="hl-8">1707234567.123456</span><span class="hl-1">) </span><span class="hl-7">// .123456 seconds = 123ms + 456µs</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromSeconds</span><span class="hl-1">(</span><span class="hl-8">1707234567</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> })</span>
|
|
483
|
+
</code><button type="button">Copy</button></pre>
|
|
484
|
+
|
|
485
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L696">src/utils/datetime/DateTime.ts:696</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromsql"><code class="tsd-tag">Static</code><span>from<wbr/>SQL</span><a href="#fromsql" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromsql-1"><span class="tsd-kind-call-signature">fromSQL</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#fromsql-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a DateTime from an SQL datetime string.</p>
|
|
443
486
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>SQL string (e.g. "2024-03-15 10:30:45.123456"); parses up to 6 fractional second digits</p>
|
|
444
|
-
</div
|
|
445
|
-
</div><
|
|
446
|
-
|
|
487
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
488
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone to interpret the datetime in (overrides timezone in string)</p>
|
|
489
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
490
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
491
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
492
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the parsed instant</p>
|
|
493
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-62">Example<a href="#example-62" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromSQL</span><span class="hl-1">(</span><span class="hl-6">'2024-03-15 10:30:45.123456'</span><span class="hl-1">)</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">fromSQL</span><span class="hl-1">(</span><span class="hl-6">'2024-03-15 10:30:45'</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> })</span>
|
|
447
494
|
</code><button type="button">Copy</button></pre>
|
|
448
495
|
|
|
449
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
450
|
-
|
|
451
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">
|
|
452
|
-
</div
|
|
453
|
-
</div><
|
|
454
|
-
|
|
496
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L791">src/utils/datetime/DateTime.ts:791</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="local"><code class="tsd-tag">Static</code><span>local</span><a href="#local" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="local-1"><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">day</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">hour</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">minute</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">second</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">millisecond</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">microsecond</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a local DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
497
|
+
The last argument may be an options object instead of a time component.</p>
|
|
498
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Month (1–12)</p>
|
|
499
|
+
</div></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Day of month</p>
|
|
500
|
+
</div></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Hour (0–23)</p>
|
|
501
|
+
</div></li><li><span><span class="tsd-kind-parameter">minute</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Minute (0–59)</p>
|
|
502
|
+
</div></li><li><span><span class="tsd-kind-parameter">second</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Second (0–59)</p>
|
|
503
|
+
</div></li><li><span><span class="tsd-kind-parameter">millisecond</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Millisecond (0–999)</p>
|
|
504
|
+
</div></li><li><span><span class="tsd-kind-parameter">microsecond</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
505
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone (IANA timezone name or Zone object, defaults to local)</p>
|
|
506
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
507
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
508
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
509
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in the local zone</p>
|
|
510
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-63">Example<a href="#example-63" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">() </span><span class="hl-7">// now</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T00:00:00</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T10:30:45</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">) </span><span class="hl-7">// with millisecond 123 and microsecond 456</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> }) </span><span class="hl-7">// with zone option</span>
|
|
511
|
+
</code><button type="button">Copy</button></pre>
|
|
512
|
+
|
|
513
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L452">src/utils/datetime/DateTime.ts:452</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="local-2"><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">day</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">hour</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">minute</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">second</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">millisecond</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a local DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
514
|
+
The last argument may be an options object instead of a time component.</p>
|
|
515
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Month (1–12)</p>
|
|
516
|
+
</div></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Day of month</p>
|
|
517
|
+
</div></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Hour (0–23)</p>
|
|
518
|
+
</div></li><li><span><span class="tsd-kind-parameter">minute</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Minute (0–59)</p>
|
|
519
|
+
</div></li><li><span><span class="tsd-kind-parameter">second</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Second (0–59)</p>
|
|
520
|
+
</div></li><li><span><span class="tsd-kind-parameter">millisecond</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Millisecond (0–999)</p>
|
|
521
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
522
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone (IANA timezone name or Zone object, defaults to local)</p>
|
|
523
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
524
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
525
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
526
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in the local zone</p>
|
|
527
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-64">Example<a href="#example-64" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">() </span><span class="hl-7">// now</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T00:00:00</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T10:30:45</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">) </span><span class="hl-7">// with millisecond 123 and microsecond 456</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> }) </span><span class="hl-7">// with zone option</span>
|
|
528
|
+
</code><button type="button">Copy</button></pre>
|
|
529
|
+
|
|
530
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L463">src/utils/datetime/DateTime.ts:463</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="local-3"><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">day</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">hour</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">minute</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">second</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a local DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
531
|
+
The last argument may be an options object instead of a time component.</p>
|
|
532
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Month (1–12)</p>
|
|
533
|
+
</div></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Day of month</p>
|
|
534
|
+
</div></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Hour (0–23)</p>
|
|
535
|
+
</div></li><li><span><span class="tsd-kind-parameter">minute</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Minute (0–59)</p>
|
|
536
|
+
</div></li><li><span><span class="tsd-kind-parameter">second</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Second (0–59)</p>
|
|
537
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
538
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone (IANA timezone name or Zone object, defaults to local)</p>
|
|
539
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
540
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
541
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
542
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in the local zone</p>
|
|
543
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-65">Example<a href="#example-65" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">() </span><span class="hl-7">// now</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T00:00:00</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T10:30:45</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">) </span><span class="hl-7">// with millisecond 123 and microsecond 456</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> }) </span><span class="hl-7">// with zone option</span>
|
|
544
|
+
</code><button type="button">Copy</button></pre>
|
|
545
|
+
|
|
546
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L473">src/utils/datetime/DateTime.ts:473</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="local-4"><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">day</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">hour</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">minute</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a local DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
547
|
+
The last argument may be an options object instead of a time component.</p>
|
|
548
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Month (1–12)</p>
|
|
549
|
+
</div></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Day of month</p>
|
|
550
|
+
</div></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Hour (0–23)</p>
|
|
551
|
+
</div></li><li><span><span class="tsd-kind-parameter">minute</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Minute (0–59)</p>
|
|
552
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
553
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone (IANA timezone name or Zone object, defaults to local)</p>
|
|
554
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
555
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
556
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
557
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in the local zone</p>
|
|
558
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-66">Example<a href="#example-66" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">() </span><span class="hl-7">// now</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T00:00:00</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T10:30:45</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">) </span><span class="hl-7">// with millisecond 123 and microsecond 456</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> }) </span><span class="hl-7">// with zone option</span>
|
|
559
|
+
</code><button type="button">Copy</button></pre>
|
|
560
|
+
|
|
561
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L482">src/utils/datetime/DateTime.ts:482</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="local-5"><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">day</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">hour</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a local DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
562
|
+
The last argument may be an options object instead of a time component.</p>
|
|
563
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Month (1–12)</p>
|
|
564
|
+
</div></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Day of month</p>
|
|
565
|
+
</div></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Hour (0–23)</p>
|
|
566
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
567
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone (IANA timezone name or Zone object, defaults to local)</p>
|
|
568
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
569
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
570
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
571
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in the local zone</p>
|
|
572
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-67">Example<a href="#example-67" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">() </span><span class="hl-7">// now</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T00:00:00</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T10:30:45</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">) </span><span class="hl-7">// with millisecond 123 and microsecond 456</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> }) </span><span class="hl-7">// with zone option</span>
|
|
573
|
+
</code><button type="button">Copy</button></pre>
|
|
574
|
+
|
|
575
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L490">src/utils/datetime/DateTime.ts:490</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="local-6"><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">day</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a local DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
576
|
+
The last argument may be an options object instead of a time component.</p>
|
|
577
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Month (1–12)</p>
|
|
578
|
+
</div></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Day of month</p>
|
|
579
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
580
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone (IANA timezone name or Zone object, defaults to local)</p>
|
|
581
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
582
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
583
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
584
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in the local zone</p>
|
|
585
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-68">Example<a href="#example-68" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">() </span><span class="hl-7">// now</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T00:00:00</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T10:30:45</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">) </span><span class="hl-7">// with millisecond 123 and microsecond 456</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> }) </span><span class="hl-7">// with zone option</span>
|
|
586
|
+
</code><button type="button">Copy</button></pre>
|
|
587
|
+
|
|
588
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L497">src/utils/datetime/DateTime.ts:497</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="local-7"><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a local DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
589
|
+
The last argument may be an options object instead of a time component.</p>
|
|
590
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Month (1–12)</p>
|
|
591
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
592
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone (IANA timezone name or Zone object, defaults to local)</p>
|
|
593
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
594
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
595
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
596
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in the local zone</p>
|
|
597
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-69">Example<a href="#example-69" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">() </span><span class="hl-7">// now</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T00:00:00</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T10:30:45</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">) </span><span class="hl-7">// with millisecond 123 and microsecond 456</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> }) </span><span class="hl-7">// with zone option</span>
|
|
598
|
+
</code><button type="button">Copy</button></pre>
|
|
599
|
+
|
|
600
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L498">src/utils/datetime/DateTime.ts:498</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="local-8"><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a local DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
601
|
+
The last argument may be an options object instead of a time component.</p>
|
|
602
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
603
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone (IANA timezone name or Zone object, defaults to local)</p>
|
|
604
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
605
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
606
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
607
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in the local zone</p>
|
|
608
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-70">Example<a href="#example-70" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">() </span><span class="hl-7">// now</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T00:00:00</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T10:30:45</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">) </span><span class="hl-7">// with millisecond 123 and microsecond 456</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> }) </span><span class="hl-7">// with zone option</span>
|
|
455
609
|
</code><button type="button">Copy</button></pre>
|
|
456
610
|
|
|
457
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
611
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L499">src/utils/datetime/DateTime.ts:499</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="local-9"><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeJSOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a local DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
612
|
+
The last argument may be an options object instead of a time component.</p>
|
|
613
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional configuration</p>
|
|
614
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>zone</span></h5><div class="tsd-comment tsd-typography"><p>Timezone (IANA timezone name or Zone object, defaults to local)</p>
|
|
615
|
+
</div></li><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
616
|
+
</div></li><li class="tsd-parameter"><h5><span>numberingSystem</span></h5><div class="tsd-comment tsd-typography"><p>Numbering system (e.g., 'arab', 'beng')</p>
|
|
617
|
+
</div></li><li class="tsd-parameter"><h5><span>outputCalendar</span></h5><div class="tsd-comment tsd-typography"><p>Calendar system (e.g., 'islamic', 'hebrew')</p>
|
|
618
|
+
</div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in the local zone</p>
|
|
619
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-71">Example<a href="#example-71" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">() </span><span class="hl-7">// now</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T00:00:00</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">) </span><span class="hl-7">// 2017-03-12T10:30:45</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">, </span><span class="hl-8">456</span><span class="hl-1">) </span><span class="hl-7">// with millisecond 123 and microsecond 456</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">local</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">zone:</span><span class="hl-1"> </span><span class="hl-6">'America/New_York'</span><span class="hl-1"> }) </span><span class="hl-7">// with zone option</span>
|
|
620
|
+
</code><button type="button">Copy</button></pre>
|
|
621
|
+
|
|
622
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L500">src/utils/datetime/DateTime.ts:500</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="max"><code class="tsd-tag">Static</code><span>max</span><a href="#max" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="max-1"><span class="tsd-kind-call-signature">max</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">dateTimes</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><a href="#max-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the latest DateTime from the given arguments.</p>
|
|
623
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">dateTimes</span>: <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>DateTimes to compare</p>
|
|
624
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4><p>The latest DateTime, or null if empty</p>
|
|
625
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-72">Example<a href="#example-72" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">max</span><span class="hl-1">(</span><span class="hl-4">dt1</span><span class="hl-1">, </span><span class="hl-4">dt2</span><span class="hl-1">, </span><span class="hl-4">dt3</span><span class="hl-1">)</span>
|
|
626
|
+
</code><button type="button">Copy</button></pre>
|
|
627
|
+
|
|
628
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1274">src/utils/datetime/DateTime.ts:1274</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="min"><code class="tsd-tag">Static</code><span>min</span><a href="#min" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="min-1"><span class="tsd-kind-call-signature">min</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">dateTimes</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><a href="#min-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the earliest DateTime from the given arguments.</p>
|
|
629
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">dateTimes</span>: <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>DateTimes to compare</p>
|
|
630
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4><p>The earliest DateTime, or null if empty</p>
|
|
631
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-73">Example<a href="#example-73" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">min</span><span class="hl-1">(</span><span class="hl-4">dt1</span><span class="hl-1">, </span><span class="hl-4">dt2</span><span class="hl-1">, </span><span class="hl-4">dt3</span><span class="hl-1">)</span>
|
|
632
|
+
</code><button type="button">Copy</button></pre>
|
|
633
|
+
|
|
634
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L1257">src/utils/datetime/DateTime.ts:1257</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="now"><code class="tsd-tag">Static</code><span>now</span><a href="#now" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="now-1"><span class="tsd-kind-call-signature">now</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">zone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Zone</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#now-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the current time in the system's local zone.</p>
|
|
635
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">zone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Zone</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the current instant</p>
|
|
636
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-74">Example<a href="#example-74" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">now</span><span class="hl-1"> = </span><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">()</span>
|
|
637
|
+
</code><button type="button">Copy</button></pre>
|
|
638
|
+
|
|
639
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L178">src/utils/datetime/DateTime.ts:178</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="utc"><code class="tsd-tag">Static</code><span>utc</span><a href="#utc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="utc-1"><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">day</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">hour</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">minute</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">second</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">millisecond</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">microsecond</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a UTC DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
458
640
|
The last argument may be an options object instead of a time component.</p>
|
|
459
641
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Month (1–12)</p>
|
|
460
|
-
</div
|
|
461
|
-
</div
|
|
462
|
-
</div
|
|
463
|
-
</div
|
|
464
|
-
</div
|
|
465
|
-
</div
|
|
466
|
-
</div
|
|
467
|
-
<div class="tsd-comment tsd-typography"><
|
|
642
|
+
</div></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Day of month</p>
|
|
643
|
+
</div></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Hour (0–23)</p>
|
|
644
|
+
</div></li><li><span><span class="tsd-kind-parameter">minute</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Minute (0–59)</p>
|
|
645
|
+
</div></li><li><span><span class="tsd-kind-parameter">second</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Second (0–59)</p>
|
|
646
|
+
</div></li><li><span><span class="tsd-kind-parameter">millisecond</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Millisecond (0–999)</p>
|
|
647
|
+
</div></li><li><span><span class="tsd-kind-parameter">microsecond</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span><div class="tsd-comment tsd-typography"><p>Options (locale, etc.)</p>
|
|
648
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in UTC</p>
|
|
649
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-75">Example<a href="#example-75" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">() </span><span class="hl-7">// now in UTC</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">5</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">765</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">) </span><span class="hl-7">// with microsecond</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">locale:</span><span class="hl-1"> </span><span class="hl-6">'fr'</span><span class="hl-1"> }) </span><span class="hl-7">// with options</span>
|
|
468
650
|
</code><button type="button">Copy</button></pre>
|
|
469
651
|
|
|
470
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L452">src/utils/datetime/DateTime.ts:452</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="local.local-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span>, <span class="tsd-kind-parameter">month</span>, <span class="tsd-kind-parameter">day</span>, <span class="tsd-kind-parameter">hour</span>, <span class="tsd-kind-parameter">minute</span>, <span class="tsd-kind-parameter">second</span>, <span class="tsd-kind-parameter">millisecond</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local.local-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">minute</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">second</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">millisecond</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L463">src/utils/datetime/DateTime.ts:463</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="local.local-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span>, <span class="tsd-kind-parameter">month</span>, <span class="tsd-kind-parameter">day</span>, <span class="tsd-kind-parameter">hour</span>, <span class="tsd-kind-parameter">minute</span>, <span class="tsd-kind-parameter">second</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local.local-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">minute</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">second</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L473">src/utils/datetime/DateTime.ts:473</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="local.local-4" class="tsd-anchor"></a><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span>, <span class="tsd-kind-parameter">month</span>, <span class="tsd-kind-parameter">day</span>, <span class="tsd-kind-parameter">hour</span>, <span class="tsd-kind-parameter">minute</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local.local-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">minute</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L482">src/utils/datetime/DateTime.ts:482</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="local.local-5" class="tsd-anchor"></a><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span>, <span class="tsd-kind-parameter">month</span>, <span class="tsd-kind-parameter">day</span>, <span class="tsd-kind-parameter">hour</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local.local-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L490">src/utils/datetime/DateTime.ts:490</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="local.local-6" class="tsd-anchor"></a><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span>, <span class="tsd-kind-parameter">month</span>, <span class="tsd-kind-parameter">day</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local.local-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L497">src/utils/datetime/DateTime.ts:497</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="local.local-7" class="tsd-anchor"></a><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span>, <span class="tsd-kind-parameter">month</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local.local-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L498">src/utils/datetime/DateTime.ts:498</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="local.local-8" class="tsd-anchor"></a><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local.local-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L499">src/utils/datetime/DateTime.ts:499</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="local.local-9" class="tsd-anchor"></a><span class="tsd-kind-call-signature">local</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#local.local-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">DateTimeJSOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L500">src/utils/datetime/DateTime.ts:500</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="max" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>max</span><a href="#max" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="max.max-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">max</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">dateTimes</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#max.max-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the latest DateTime from the given arguments.</p>
|
|
471
|
-
|
|
472
|
-
</div><div class="tsd-
|
|
473
|
-
|
|
652
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L550">src/utils/datetime/DateTime.ts:550</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="utc-2"><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">day</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">hour</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">minute</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">second</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a UTC DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
653
|
+
The last argument may be an options object instead of a time component.</p>
|
|
654
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Month (1–12)</p>
|
|
655
|
+
</div></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Day of month</p>
|
|
656
|
+
</div></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Hour (0–23)</p>
|
|
657
|
+
</div></li><li><span><span class="tsd-kind-parameter">minute</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Minute (0–59)</p>
|
|
658
|
+
</div></li><li><span><span class="tsd-kind-parameter">second</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Second (0–59)</p>
|
|
659
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span><div class="tsd-comment tsd-typography"><p>Options (locale, etc.)</p>
|
|
660
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in UTC</p>
|
|
661
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-76">Example<a href="#example-76" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">() </span><span class="hl-7">// now in UTC</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">5</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">765</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">) </span><span class="hl-7">// with microsecond</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">locale:</span><span class="hl-1"> </span><span class="hl-6">'fr'</span><span class="hl-1"> }) </span><span class="hl-7">// with options</span>
|
|
474
662
|
</code><button type="button">Copy</button></pre>
|
|
475
663
|
|
|
476
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
477
|
-
|
|
478
|
-
</div><div class="tsd-
|
|
479
|
-
|
|
664
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L561">src/utils/datetime/DateTime.ts:561</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="utc-3"><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">day</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">hour</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">minute</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a UTC DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
665
|
+
The last argument may be an options object instead of a time component.</p>
|
|
666
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Month (1–12)</p>
|
|
667
|
+
</div></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Day of month</p>
|
|
668
|
+
</div></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Hour (0–23)</p>
|
|
669
|
+
</div></li><li><span><span class="tsd-kind-parameter">minute</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Minute (0–59)</p>
|
|
670
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span><div class="tsd-comment tsd-typography"><p>Options (locale, etc.)</p>
|
|
671
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in UTC</p>
|
|
672
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-77">Example<a href="#example-77" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">() </span><span class="hl-7">// now in UTC</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">5</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">765</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">) </span><span class="hl-7">// with microsecond</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">locale:</span><span class="hl-1"> </span><span class="hl-6">'fr'</span><span class="hl-1"> }) </span><span class="hl-7">// with options</span>
|
|
480
673
|
</code><button type="button">Copy</button></pre>
|
|
481
674
|
|
|
482
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
483
|
-
|
|
484
|
-
|
|
675
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L570">src/utils/datetime/DateTime.ts:570</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="utc-4"><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">day</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">hour</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a UTC DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
676
|
+
The last argument may be an options object instead of a time component.</p>
|
|
677
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Month (1–12)</p>
|
|
678
|
+
</div></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Day of month</p>
|
|
679
|
+
</div></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Hour (0–23)</p>
|
|
680
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span><div class="tsd-comment tsd-typography"><p>Options (locale, etc.)</p>
|
|
681
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in UTC</p>
|
|
682
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-78">Example<a href="#example-78" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">() </span><span class="hl-7">// now in UTC</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">5</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">765</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">) </span><span class="hl-7">// with microsecond</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">locale:</span><span class="hl-1"> </span><span class="hl-6">'fr'</span><span class="hl-1"> }) </span><span class="hl-7">// with options</span>
|
|
683
|
+
</code><button type="button">Copy</button></pre>
|
|
684
|
+
|
|
685
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L578">src/utils/datetime/DateTime.ts:578</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="utc-5"><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">day</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a UTC DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
686
|
+
The last argument may be an options object instead of a time component.</p>
|
|
687
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Month (1–12)</p>
|
|
688
|
+
</div></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Day of month</p>
|
|
689
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span><div class="tsd-comment tsd-typography"><p>Options (locale, etc.)</p>
|
|
690
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in UTC</p>
|
|
691
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-79">Example<a href="#example-79" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">() </span><span class="hl-7">// now in UTC</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">5</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">765</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">) </span><span class="hl-7">// with microsecond</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">locale:</span><span class="hl-1"> </span><span class="hl-6">'fr'</span><span class="hl-1"> }) </span><span class="hl-7">// with options</span>
|
|
485
692
|
</code><button type="button">Copy</button></pre>
|
|
486
693
|
|
|
487
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
694
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L579">src/utils/datetime/DateTime.ts:579</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="utc-6"><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">month</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a UTC DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
488
695
|
The last argument may be an options object instead of a time component.</p>
|
|
489
696
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Month (1–12)</p>
|
|
490
|
-
</div><
|
|
491
|
-
</div
|
|
492
|
-
|
|
493
|
-
</
|
|
494
|
-
|
|
495
|
-
</div><
|
|
496
|
-
|
|
497
|
-
|
|
697
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span><div class="tsd-comment tsd-typography"><p>Options (locale, etc.)</p>
|
|
698
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in UTC</p>
|
|
699
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-80">Example<a href="#example-80" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">() </span><span class="hl-7">// now in UTC</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">5</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">765</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">) </span><span class="hl-7">// with microsecond</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">locale:</span><span class="hl-1"> </span><span class="hl-6">'fr'</span><span class="hl-1"> }) </span><span class="hl-7">// with options</span>
|
|
700
|
+
</code><button type="button">Copy</button></pre>
|
|
701
|
+
|
|
702
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L580">src/utils/datetime/DateTime.ts:580</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="utc-7"><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a UTC DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
703
|
+
The last argument may be an options object instead of a time component.</p>
|
|
704
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span><div class="tsd-comment tsd-typography"><p>Options (locale, etc.)</p>
|
|
705
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in UTC</p>
|
|
706
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-81">Example<a href="#example-81" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">() </span><span class="hl-7">// now in UTC</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">5</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">765</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">) </span><span class="hl-7">// with microsecond</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">locale:</span><span class="hl-1"> </span><span class="hl-6">'fr'</span><span class="hl-1"> }) </span><span class="hl-7">// with options</span>
|
|
707
|
+
</code><button type="button">Copy</button></pre>
|
|
708
|
+
|
|
709
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L581">src/utils/datetime/DateTime.ts:581</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="utc-8"><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a UTC DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
710
|
+
The last argument may be an options object instead of a time component.</p>
|
|
711
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span><div class="tsd-comment tsd-typography"><p>Options (locale, etc.)</p>
|
|
712
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in UTC</p>
|
|
713
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-82">Example<a href="#example-82" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">() </span><span class="hl-7">// now in UTC</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, </span><span class="hl-8">5</span><span class="hl-1">, </span><span class="hl-8">45</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-8">765</span><span class="hl-1">, </span><span class="hl-8">123</span><span class="hl-1">) </span><span class="hl-7">// with microsecond</span><br/><span class="hl-4">DateTime</span><span class="hl-1">.</span><span class="hl-5">utc</span><span class="hl-1">(</span><span class="hl-8">2017</span><span class="hl-1">, </span><span class="hl-8">3</span><span class="hl-1">, </span><span class="hl-8">12</span><span class="hl-1">, { </span><span class="hl-4">locale:</span><span class="hl-1"> </span><span class="hl-6">'fr'</span><span class="hl-1"> }) </span><span class="hl-7">// with options</span>
|
|
498
714
|
</code><button type="button">Copy</button></pre>
|
|
499
715
|
|
|
500
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L550">src/utils/datetime/DateTime.ts:550</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="utc.utc-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span>, <span class="tsd-kind-parameter">month</span>, <span class="tsd-kind-parameter">day</span>, <span class="tsd-kind-parameter">hour</span>, <span class="tsd-kind-parameter">minute</span>, <span class="tsd-kind-parameter">second</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc.utc-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">minute</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">second</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L561">src/utils/datetime/DateTime.ts:561</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="utc.utc-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span>, <span class="tsd-kind-parameter">month</span>, <span class="tsd-kind-parameter">day</span>, <span class="tsd-kind-parameter">hour</span>, <span class="tsd-kind-parameter">minute</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc.utc-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">minute</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L570">src/utils/datetime/DateTime.ts:570</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="utc.utc-4" class="tsd-anchor"></a><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span>, <span class="tsd-kind-parameter">month</span>, <span class="tsd-kind-parameter">day</span>, <span class="tsd-kind-parameter">hour</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc.utc-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">hour</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L578">src/utils/datetime/DateTime.ts:578</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="utc.utc-5" class="tsd-anchor"></a><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span>, <span class="tsd-kind-parameter">month</span>, <span class="tsd-kind-parameter">day</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc.utc-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">day</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L579">src/utils/datetime/DateTime.ts:579</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="utc.utc-6" class="tsd-anchor"></a><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span>, <span class="tsd-kind-parameter">month</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc.utc-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">month</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L580">src/utils/datetime/DateTime.ts:580</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="utc.utc-7" class="tsd-anchor"></a><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">year</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc.utc-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">year</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L581">src/utils/datetime/DateTime.ts:581</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="utc.utc-8" class="tsd-anchor"></a><span class="tsd-kind-call-signature">utc</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#utc.utc-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">LocaleOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/3cc5b4b63c53a165555fb5fc62c39d1fbd285628/src/utils/datetime/DateTime.ts#L582">src/utils/datetime/DateTime.ts:582</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#_microseconds" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_microseconds</span></a><a href="#luxonDatetime" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>luxon<wbr/>Datetime</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#day" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>day</span></a><a href="#hour" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hour</span></a><a href="#invalidExplanation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>invalid<wbr/>Explanation</span></a><a href="#invalidReason" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>invalid<wbr/>Reason</span></a><a href="#locale" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>locale</span></a><a href="#microsecond" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>microsecond</span></a><a href="#millisecond" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>millisecond</span></a><a href="#minute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>minute</span></a><a href="#month" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>month</span></a><a href="#offset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>offset</span></a><a href="#ordinal" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ordinal</span></a><a href="#quarter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>quarter</span></a><a href="#second" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>second</span></a><a href="#unixIntegerMicroseconds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>unix<wbr/>Integer<wbr/>Microseconds</span></a><a href="#unixIntegerMilliseconds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>unix<wbr/>Integer<wbr/>Milliseconds</span></a><a href="#unixIntegerSeconds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>unix<wbr/>Integer<wbr/>Seconds</span></a><a href="#weekNumber" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>week<wbr/>Number</span></a><a href="#weekYear" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>week<wbr/>Year</span></a><a href="#weekday" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>weekday</span></a><a href="#weekdayName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>weekday<wbr/>Name</span></a><a href="#year" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>year</span></a><a href="#zone" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>zone</span></a><a href="#zoneName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>zone<wbr/>Name</span></a><a href="#DATETIME_FULL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>FULL</span></a><a href="#DATETIME_FULL_WITH_SECONDS" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>FULL_<wbr/>WITH_<wbr/>SECONDS</span></a><a href="#DATETIME_HUGE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>HUGE</span></a><a href="#DATETIME_HUGE_WITH_SECONDS" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>HUGE_<wbr/>WITH_<wbr/>SECONDS</span></a><a href="#DATETIME_MED" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>MED</span></a><a href="#DATETIME_MED_WITH_SECONDS" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>MED_<wbr/>WITH_<wbr/>SECONDS</span></a><a href="#DATETIME_MED_WITH_WEEKDAY" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>MED_<wbr/>WITH_<wbr/>WEEKDAY</span></a><a href="#DATETIME_SHORT" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>SHORT</span></a><a href="#DATETIME_SHORT_WITH_SECONDS" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>SHORT_<wbr/>WITH_<wbr/>SECONDS</span></a><a href="#DATE_FULL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>FULL</span></a><a href="#DATE_HUGE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>HUGE</span></a><a href="#DATE_MED" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>MED</span></a><a href="#DATE_MED_WITH_WEEKDAY" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>MED_<wbr/>WITH_<wbr/>WEEKDAY</span></a><a href="#DATE_SHORT" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>SHORT</span></a><a href="#TIME_24_SIMPLE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>24_<wbr/>SIMPLE</span></a><a href="#TIME_24_WITH_LONG_OFFSET" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>24_<wbr/>WITH_<wbr/>LONG_<wbr/>OFFSET</span></a><a href="#TIME_24_WITH_SECONDS" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>24_<wbr/>WITH_<wbr/>SECONDS</span></a><a href="#TIME_24_WITH_SHORT_OFFSET" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>24_<wbr/>WITH_<wbr/>SHORT_<wbr/>OFFSET</span></a><a href="#TIME_SIMPLE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>SIMPLE</span></a><a href="#TIME_WITH_LONG_OFFSET" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>WITH_<wbr/>LONG_<wbr/>OFFSET</span></a><a href="#TIME_WITH_SECONDS" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>WITH_<wbr/>SECONDS</span></a><a href="#TIME_WITH_SHORT_OFFSET" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>WITH_<wbr/>SHORT_<wbr/>OFFSET</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#diff" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>diff</span></a><a href="#diffNow" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>diff<wbr/>Now</span></a><a href="#endOf" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>end<wbr/>Of</span></a><a href="#equals" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>equals</span></a><a href="#hasSame" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Same</span></a><a href="#minus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>minus</span></a><a href="#plus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>plus</span></a><a href="#reconfigure" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reconfigure</span></a><a href="#set" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a><a href="#setLocale" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Locale</span></a><a href="#setZone" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Zone</span></a><a href="#startOf" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Of</span></a><a href="#toFormat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Format</span></a><a href="#toISO" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toISO</span></a><a href="#toISODate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toISODate</span></a><a href="#toISOTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toISOTime</span></a><a href="#toJSDate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toJSDate</span></a><a href="#toJSON" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toJSON</span></a><a href="#toLocal" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Local</span></a><a href="#toLocaleString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Locale<wbr/>String</span></a><a href="#toLuxon" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Luxon</span></a><a href="#toMicroseconds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Microseconds</span></a><a href="#toMillis" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Millis</span></a><a href="#toObject" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Object</span></a><a href="#toSQL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toSQL</span></a><a href="#toSQLDate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toSQLDate</span></a><a href="#toSQLTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toSQLTime</span></a><a href="#toSeconds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Seconds</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#toUTC" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toUTC</span></a><a href="#valueOf" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>value<wbr/>Of</span></a><a href="#fromFormat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Format</span></a><a href="#fromISO" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fromISO</span></a><a href="#fromJSDate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fromJSDate</span></a><a href="#fromMicroseconds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Microseconds</span></a><a href="#fromMillis" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Millis</span></a><a href="#fromObject" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Object</span></a><a href="#fromSQL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fromSQL</span></a><a href="#fromSeconds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Seconds</span></a><a href="#local" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>local</span></a><a href="#max" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>max</span></a><a href="#min" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>min</span></a><a href="#now" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>now</span></a><a href="#utc" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>utc</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@rvoh/dream</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
716
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b5aa57ff8eda0723eecfdd9491524a7d9267a2f8/src/utils/datetime/DateTime.ts#L582">src/utils/datetime/DateTime.ts:582</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#_microseconds" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>microseconds</span></a><a href="#luxondatetime" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>luxon<wbr/>Datetime</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#day"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>day</span></a><a href="#hour"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hour</span></a><a href="#invalidexplanation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>invalid<wbr/>Explanation</span></a><a href="#invalidreason"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>invalid<wbr/>Reason</span></a><a href="#locale"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>locale</span></a><a href="#microsecond"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>microsecond</span></a><a href="#millisecond"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>millisecond</span></a><a href="#minute"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>minute</span></a><a href="#month"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>month</span></a><a href="#offset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>offset</span></a><a href="#ordinal"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ordinal</span></a><a href="#quarter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>quarter</span></a><a href="#second"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>second</span></a><a href="#unixintegermicroseconds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>unix<wbr/>Integer<wbr/>Microseconds</span></a><a href="#unixintegermilliseconds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>unix<wbr/>Integer<wbr/>Milliseconds</span></a><a href="#unixintegerseconds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>unix<wbr/>Integer<wbr/>Seconds</span></a><a href="#weekday"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>weekday</span></a><a href="#weekdayname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>weekday<wbr/>Name</span></a><a href="#weeknumber"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>week<wbr/>Number</span></a><a href="#weekyear"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>week<wbr/>Year</span></a><a href="#year"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>year</span></a><a href="#zone"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>zone</span></a><a href="#zonename"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>zone<wbr/>Name</span></a><a href="#date_full"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>FULL</span></a><a href="#date_huge"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>HUGE</span></a><a href="#date_med"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>MED</span></a><a href="#date_med_with_weekday"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>MED_<wbr/>WITH_<wbr/>WEEKDAY</span></a><a href="#date_short"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATE_<wbr/>SHORT</span></a><a href="#datetime_full"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>FULL</span></a><a href="#datetime_full_with_seconds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>FULL_<wbr/>WITH_<wbr/>SECONDS</span></a><a href="#datetime_huge"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>HUGE</span></a><a href="#datetime_huge_with_seconds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>HUGE_<wbr/>WITH_<wbr/>SECONDS</span></a><a href="#datetime_med"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>MED</span></a><a href="#datetime_med_with_seconds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>MED_<wbr/>WITH_<wbr/>SECONDS</span></a><a href="#datetime_med_with_weekday"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>MED_<wbr/>WITH_<wbr/>WEEKDAY</span></a><a href="#datetime_short"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>SHORT</span></a><a href="#datetime_short_with_seconds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>DATETIME_<wbr/>SHORT_<wbr/>WITH_<wbr/>SECONDS</span></a><a href="#time_24_simple"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>24_<wbr/>SIMPLE</span></a><a href="#time_24_with_long_offset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>24_<wbr/>WITH_<wbr/>LONG_<wbr/>OFFSET</span></a><a href="#time_24_with_seconds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>24_<wbr/>WITH_<wbr/>SECONDS</span></a><a href="#time_24_with_short_offset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>24_<wbr/>WITH_<wbr/>SHORT_<wbr/>OFFSET</span></a><a href="#time_simple"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>SIMPLE</span></a><a href="#time_with_long_offset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>WITH_<wbr/>LONG_<wbr/>OFFSET</span></a><a href="#time_with_seconds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>WITH_<wbr/>SECONDS</span></a><a href="#time_with_short_offset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>TIME_<wbr/>WITH_<wbr/>SHORT_<wbr/>OFFSET</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#diff"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>diff</span></a><a href="#diffnow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>diff<wbr/>Now</span></a><a href="#endof"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>end<wbr/>Of</span></a><a href="#equals"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>equals</span></a><a href="#hassame"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Same</span></a><a href="#minus"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>minus</span></a><a href="#plus"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>plus</span></a><a href="#reconfigure"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reconfigure</span></a><a href="#set"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a><a href="#setlocale"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Locale</span></a><a href="#setzone"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Zone</span></a><a href="#startof"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Of</span></a><a href="#toformat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Format</span></a><a href="#toiso"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>ISO</span></a><a href="#toisodate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>ISO<wbr/>Date</span></a><a href="#toisotime"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>ISO<wbr/>Time</span></a><a href="#tojsdate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>JS<wbr/>Date</span></a><a href="#tojson"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>JSON</span></a><a href="#tolocal"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Local</span></a><a href="#tolocalestring"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Locale<wbr/>String</span></a><a href="#toluxon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Luxon</span></a><a href="#tomicroseconds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Microseconds</span></a><a href="#tomillis"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Millis</span></a><a href="#toobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Object</span></a><a href="#toseconds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Seconds</span></a><a href="#tosql"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>SQL</span></a><a href="#tosqldate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>SQL<wbr/>Date</span></a><a href="#tosqltime"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>SQL<wbr/>Time</span></a><a href="#tostring"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#toutc"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>UTC</span></a><a href="#valueof"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>value<wbr/>Of</span></a><a href="#fromformat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Format</span></a><a href="#fromiso"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>ISO</span></a><a href="#fromjsdate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>JS<wbr/>Date</span></a><a href="#frommicroseconds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Microseconds</span></a><a href="#frommillis"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Millis</span></a><a href="#fromobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Object</span></a><a href="#fromseconds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Seconds</span></a><a href="#fromsql"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>SQL</span></a><a href="#local"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>local</span></a><a href="#max"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>max</span></a><a href="#min"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>min</span></a><a href="#now"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>now</span></a><a href="#utc"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>utc</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@rvoh/dream</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|