@rvoh/dream 2.3.0-alpha.5 → 2.3.0-alpha.7
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/Dream.js +2 -40
- package/dist/cjs/src/cli/index.js +4 -0
- package/dist/cjs/src/dream/Query.js +14 -11
- package/dist/cjs/src/dream/QueryDriver/Base.js +0 -14
- package/dist/cjs/src/dream/QueryDriver/Kysely.js +86 -74
- package/dist/cjs/src/dream/QueryDriver/Postgres.js +10 -2
- package/dist/cjs/src/dream/internal/extractAssignableAssociationAttributes.js +9 -0
- package/dist/cjs/src/errors/db/DataIncompatibleWithDatabaseField.js +1 -3
- package/dist/cjs/src/helpers/areEqual.js +5 -0
- package/dist/cjs/src/helpers/cli/ASTBuilder.js +54 -2
- package/dist/cjs/src/helpers/cli/ASTKyselyCodegenEnhancer.js +84 -0
- package/dist/cjs/src/helpers/cli/ASTSchemaBuilder.js +17 -1
- package/dist/cjs/src/helpers/cli/generateFactoryContent.js +16 -0
- package/dist/cjs/src/helpers/cloneDeepSafe.js +21 -10
- package/dist/cjs/src/helpers/customPgParsers.js +18 -1
- package/dist/cjs/src/helpers/db/normalizeDataForDb.js +81 -0
- package/dist/cjs/src/helpers/db/types/helpers.js +5 -0
- package/dist/cjs/src/helpers/db/types/isDatetimeOrDatetimeArrayColumn.js +2 -1
- package/dist/cjs/src/helpers/sortBy.js +7 -5
- package/dist/cjs/src/helpers/sqlAttributes.js +4 -53
- package/dist/cjs/src/helpers/stringCasing.js +6 -5
- package/dist/cjs/src/helpers/toSafeObject.js +17 -0
- package/dist/cjs/src/package-exports/errors.js +2 -0
- package/dist/cjs/src/package-exports/index.js +2 -0
- package/dist/cjs/src/serializer/SerializerRenderer.js +11 -11
- package/dist/cjs/src/types/clocktime.js +1 -0
- package/dist/cjs/src/utils/datetime/BaseClockTime.js +363 -0
- package/dist/cjs/src/utils/datetime/CalendarDate.js +110 -119
- package/dist/cjs/src/utils/datetime/ClockTime.js +173 -0
- package/dist/cjs/src/utils/datetime/ClockTimeTz.js +232 -0
- package/dist/cjs/src/utils/datetime/DateTime.js +327 -221
- package/dist/cjs/src/utils/datetime/helpers/isoTimeDecimalString.js +8 -4
- package/dist/cjs/src/utils/datetime/helpers/replaceISOMicroseconds.js +4 -1
- package/dist/esm/src/Dream.js +2 -40
- package/dist/esm/src/cli/index.js +4 -0
- package/dist/esm/src/dream/Query.js +14 -11
- package/dist/esm/src/dream/QueryDriver/Base.js +0 -14
- package/dist/esm/src/dream/QueryDriver/Kysely.js +86 -74
- package/dist/esm/src/dream/QueryDriver/Postgres.js +10 -2
- package/dist/esm/src/dream/internal/extractAssignableAssociationAttributes.js +9 -0
- package/dist/esm/src/errors/db/DataIncompatibleWithDatabaseField.js +1 -3
- package/dist/esm/src/helpers/areEqual.js +5 -0
- package/dist/esm/src/helpers/cli/ASTBuilder.js +54 -2
- package/dist/esm/src/helpers/cli/ASTKyselyCodegenEnhancer.js +84 -0
- package/dist/esm/src/helpers/cli/ASTSchemaBuilder.js +17 -1
- package/dist/esm/src/helpers/cli/generateFactoryContent.js +16 -0
- package/dist/esm/src/helpers/cloneDeepSafe.js +21 -10
- package/dist/esm/src/helpers/customPgParsers.js +18 -1
- package/dist/esm/src/helpers/db/normalizeDataForDb.js +81 -0
- package/dist/esm/src/helpers/db/types/helpers.js +5 -0
- package/dist/esm/src/helpers/db/types/isDatetimeOrDatetimeArrayColumn.js +2 -1
- package/dist/esm/src/helpers/sortBy.js +7 -5
- package/dist/esm/src/helpers/sqlAttributes.js +4 -53
- package/dist/esm/src/helpers/stringCasing.js +6 -5
- package/dist/esm/src/helpers/toSafeObject.js +17 -0
- package/dist/esm/src/package-exports/errors.js +2 -0
- package/dist/esm/src/package-exports/index.js +2 -0
- package/dist/esm/src/serializer/SerializerRenderer.js +11 -11
- package/dist/esm/src/types/clocktime.js +1 -0
- package/dist/esm/src/utils/datetime/BaseClockTime.js +363 -0
- package/dist/esm/src/utils/datetime/CalendarDate.js +110 -119
- package/dist/esm/src/utils/datetime/ClockTime.js +173 -0
- package/dist/esm/src/utils/datetime/ClockTimeTz.js +232 -0
- package/dist/esm/src/utils/datetime/DateTime.js +327 -221
- package/dist/esm/src/utils/datetime/helpers/isoTimeDecimalString.js +8 -4
- package/dist/esm/src/utils/datetime/helpers/replaceISOMicroseconds.js +4 -1
- package/dist/types/src/Dream.d.ts +29 -33
- package/dist/types/src/dream/DreamClassTransactionBuilder.d.ts +9 -10
- package/dist/types/src/dream/DreamInstanceTransactionBuilder.d.ts +16 -16
- package/dist/types/src/dream/LeftJoinLoadBuilder.d.ts +1 -1
- package/dist/types/src/dream/LoadBuilder.d.ts +1 -1
- package/dist/types/src/dream/Query.d.ts +16 -16
- package/dist/types/src/dream/QueryDriver/Base.d.ts +0 -1
- package/dist/types/src/dream/QueryDriver/Kysely.d.ts +1 -0
- package/dist/types/src/dream/internal/associations/associationQuery.d.ts +1 -1
- package/dist/types/src/dream/internal/associations/associationUpdateQuery.d.ts +1 -1
- package/dist/types/src/dream/internal/associations/destroyAssociation.d.ts +1 -1
- package/dist/types/src/dream/internal/associations/throughAssociationHasOptionsBesidesThroughAndSource.d.ts +4 -2
- package/dist/types/src/dream/internal/associations/undestroyAssociation.d.ts +1 -1
- package/dist/types/src/dream/internal/extractAssignableAssociationAttributes.d.ts +3 -0
- package/dist/types/src/dream/internal/similarity/SimilarityBuilder.d.ts +7 -7
- package/dist/types/src/errors/db/DataIncompatibleWithDatabaseField.d.ts +2 -7
- package/dist/types/src/helpers/cli/ASTBuilder.d.ts +31 -0
- package/dist/types/src/helpers/cli/ASTKyselyCodegenEnhancer.d.ts +13 -0
- package/dist/types/src/helpers/customPgParsers.d.ts +5 -0
- package/dist/types/src/helpers/db/normalizeDataForDb.d.ts +6 -0
- package/dist/types/src/helpers/db/types/helpers.d.ts +5 -0
- package/dist/types/src/helpers/sort.d.ts +2 -1
- package/dist/types/src/helpers/sortBy.d.ts +3 -0
- package/dist/types/src/helpers/toSafeObject.d.ts +8 -0
- package/dist/types/src/package-exports/errors.d.ts +2 -0
- package/dist/types/src/package-exports/index.d.ts +2 -0
- package/dist/types/src/package-exports/types.d.ts +2 -1
- package/dist/types/src/types/associations/shared.d.ts +15 -13
- package/dist/types/src/types/associations/shared.ts +81 -41
- package/dist/types/src/types/calendardate.d.ts +22 -1
- package/dist/types/src/types/calendardate.ts +33 -1
- package/dist/types/src/types/clocktime.d.ts +22 -0
- package/dist/types/src/types/clocktime.ts +59 -0
- package/dist/types/src/types/datetime.d.ts +13 -18
- package/dist/types/src/types/datetime.ts +18 -21
- package/dist/types/src/types/dream.d.ts +27 -13
- package/dist/types/src/types/dream.ts +40 -14
- package/dist/types/src/types/variadic.d.ts +10 -9
- package/dist/types/src/types/variadic.ts +30 -5
- package/dist/types/src/utils/datetime/BaseClockTime.d.ts +287 -0
- package/dist/types/src/utils/datetime/CalendarDate.d.ts +65 -47
- package/dist/types/src/utils/datetime/ClockTime.d.ts +138 -0
- package/dist/types/src/utils/datetime/ClockTimeTz.d.ts +194 -0
- package/dist/types/src/utils/datetime/DateTime.d.ts +169 -66
- package/dist/types/src/utils/datetime/helpers/isoTimeDecimalString.d.ts +3 -2
- package/dist/types/src/utils/datetime/helpers/replaceISOMicroseconds.d.ts +4 -2
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/db.DreamMigrationHelpers.html +9 -9
- package/docs/classes/db.KyselyQueryDriver.html +33 -34
- package/docs/classes/db.PostgresQueryDriver.html +34 -35
- package/docs/classes/db.QueryDriverBase.html +32 -33
- package/docs/classes/errors.CheckConstraintViolation.html +4 -6
- package/docs/classes/errors.ColumnOverflow.html +4 -6
- package/docs/classes/errors.CreateOrFindByFailedToCreateAndFind.html +3 -3
- package/docs/classes/errors.DataIncompatibleWithDatabaseField.html +4 -6
- package/docs/classes/errors.DataTypeColumnTypeMismatch.html +4 -6
- package/docs/classes/errors.GlobalNameNotSet.html +3 -3
- package/docs/classes/errors.InvalidCalendarDate.html +2 -2
- package/docs/classes/errors.InvalidClockTime.html +17 -0
- package/docs/classes/errors.InvalidClockTimeTz.html +17 -0
- package/docs/classes/errors.InvalidDateTime.html +2 -2
- package/docs/classes/errors.MissingSerializersDefinition.html +3 -3
- package/docs/classes/errors.NonLoadedAssociation.html +3 -3
- package/docs/classes/errors.NotNullViolation.html +4 -6
- package/docs/classes/errors.RecordNotFound.html +3 -3
- package/docs/classes/errors.ValidationError.html +3 -3
- package/docs/classes/index.CalendarDate.html +80 -92
- package/docs/classes/index.ClockTime.html +232 -0
- package/docs/classes/index.ClockTimeTz.html +253 -0
- package/docs/classes/index.DateTime.html +176 -173
- package/docs/classes/index.Decorators.html +19 -19
- package/docs/classes/index.Dream.html +127 -127
- package/docs/classes/index.DreamApp.html +5 -5
- package/docs/classes/index.DreamTransaction.html +2 -2
- package/docs/classes/index.Env.html +2 -2
- package/docs/classes/index.Query.html +71 -71
- package/docs/classes/system.CliFileWriter.html +2 -2
- package/docs/classes/system.DreamBin.html +2 -2
- package/docs/classes/system.DreamCLI.html +5 -5
- package/docs/classes/system.DreamImporter.html +2 -2
- package/docs/classes/system.DreamLogos.html +2 -2
- package/docs/classes/system.DreamSerializerBuilder.html +8 -8
- package/docs/classes/system.ObjectSerializerBuilder.html +8 -8
- package/docs/classes/system.PathHelpers.html +3 -3
- package/docs/classes/utils.Encrypt.html +2 -2
- package/docs/classes/utils.Range.html +2 -2
- 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 +1 -1
- package/docs/functions/utils.camelize.html +1 -1
- package/docs/functions/utils.capitalize.html +1 -1
- package/docs/functions/utils.cloneDeepSafe.html +1 -1
- package/docs/functions/utils.compact.html +1 -1
- package/docs/functions/utils.groupBy.html +1 -1
- package/docs/functions/utils.hyphenize.html +1 -1
- package/docs/functions/utils.intersection.html +1 -1
- package/docs/functions/utils.isEmpty.html +1 -1
- package/docs/functions/utils.normalizeUnicode.html +1 -1
- package/docs/functions/utils.pascalize.html +1 -1
- package/docs/functions/utils.percent.html +1 -1
- package/docs/functions/utils.range-1.html +1 -1
- package/docs/functions/utils.round.html +1 -1
- package/docs/functions/utils.sanitizeString.html +1 -1
- package/docs/functions/utils.snakeify.html +1 -1
- package/docs/functions/utils.sort.html +1 -1
- package/docs/functions/utils.sortBy.html +1 -1
- 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 +1 -1
- 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 +2 -2
- package/docs/interfaces/types.DecoratorContext.html +2 -2
- package/docs/interfaces/types.DreamAppInitOptions.html +2 -2
- package/docs/interfaces/types.DreamAppOpts.html +2 -2
- package/docs/interfaces/types.DurationObject.html +5 -5
- package/docs/interfaces/types.EncryptOptions.html +2 -2
- package/docs/interfaces/types.InternalAnyTypedSerializerRendersMany.html +2 -2
- package/docs/interfaces/types.InternalAnyTypedSerializerRendersOne.html +2 -2
- package/docs/interfaces/types.SerializerRendererOpts.html +2 -2
- package/docs/modules/db.html +1 -1
- package/docs/modules/errors.html +3 -1
- package/docs/modules/index.html +3 -1
- package/docs/modules/openapi.html +1 -1
- package/docs/modules/system.html +1 -1
- package/docs/modules/types.html +3 -1
- package/docs/modules/utils.html +1 -1
- 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 +1 -1
- package/docs/types/openapi.OpenapiSchemaExpressionAnyOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaExpressionOneOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaExpressionRef.html +1 -1
- package/docs/types/openapi.OpenapiSchemaExpressionRefSchemaShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaInteger.html +1 -1
- package/docs/types/openapi.OpenapiSchemaNull.html +1 -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 +1 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionAnyOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionOneOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializableRef.html +1 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializerRef.html +1 -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 -0
- package/docs/types/types.Camelized.html +1 -1
- package/docs/types/types.ClockTimeObject.html +2 -0
- 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 +1 -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 -4
- 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 +1 -1
- package/docs/types/types.ViewModelClass.html +1 -1
- package/docs/types/types.WeekdayName.html +1 -1
- 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-1.html +1 -1
- package/docs/variables/openapi.openapiShorthandPrimitiveTypes-1.html +1 -1
- package/docs/variables/system.DreamAppAllowedPackageManagersEnumValues.html +1 -1
- package/docs/variables/system.primaryKeyTypes.html +1 -1
- package/package.json +2 -2
- package/dist/cjs/src/helpers/db/types/isDateOrDateArrayColumn.js +0 -3
- package/dist/cjs/src/helpers/db/types/isTextOrTextArrayColumn.js +0 -3
- package/dist/esm/src/helpers/db/types/isDateOrDateArrayColumn.js +0 -3
- package/dist/esm/src/helpers/db/types/isTextOrTextArrayColumn.js +0 -3
- package/dist/types/src/helpers/db/types/isDateOrDateArrayColumn.d.ts +0 -2
- package/dist/types/src/helpers/db/types/isTextOrTextArrayColumn.d.ts +0 -2
|
@@ -1,13 +1,14 @@
|
|
|
1
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"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@rvoh/dream</a></li><li><a href="../modules/index.html">index</a></li><li><a href="index.DateTime.html">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 (toISO, toSQL) is normalized to UTC.
|
|
4
|
+
Time-only output (toISOTime, toSQLTime) omits timezone offset by default.</p>
|
|
5
|
+
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L35">src/utils/datetime/DateTime.ts:35</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"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> 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="index.DateTime.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
4
6
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="index.DateTime.html#_microseconds" class="tsd-index-link 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>
|
|
5
7
|
<a href="index.DateTime.html#luxonDatetime" class="tsd-index-link 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>
|
|
6
8
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="index.DateTime.html#day" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>day</span></a>
|
|
7
9
|
<a href="index.DateTime.html#hour" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hour</span></a>
|
|
8
10
|
<a href="index.DateTime.html#invalidExplanation" class="tsd-index-link"><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>
|
|
9
11
|
<a href="index.DateTime.html#invalidReason" class="tsd-index-link"><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>
|
|
10
|
-
<a href="index.DateTime.html#isValid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Valid</span></a>
|
|
11
12
|
<a href="index.DateTime.html#locale" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>locale</span></a>
|
|
12
13
|
<a href="index.DateTime.html#microsecond" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>microsecond</span></a>
|
|
13
14
|
<a href="index.DateTime.html#millisecond" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>millisecond</span></a>
|
|
@@ -17,6 +18,9 @@ The decimal part in ISO/SQL is 6 digits: first 3 = milliseconds, next 3 = micros
|
|
|
17
18
|
<a href="index.DateTime.html#ordinal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ordinal</span></a>
|
|
18
19
|
<a href="index.DateTime.html#quarter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>quarter</span></a>
|
|
19
20
|
<a href="index.DateTime.html#second" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>second</span></a>
|
|
21
|
+
<a href="index.DateTime.html#unixIntegerMicroseconds" class="tsd-index-link"><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>
|
|
22
|
+
<a href="index.DateTime.html#unixIntegerMilliseconds" class="tsd-index-link"><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>
|
|
23
|
+
<a href="index.DateTime.html#unixIntegerSeconds" class="tsd-index-link"><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>
|
|
20
24
|
<a href="index.DateTime.html#weekNumber" class="tsd-index-link"><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>
|
|
21
25
|
<a href="index.DateTime.html#weekYear" class="tsd-index-link"><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>
|
|
22
26
|
<a href="index.DateTime.html#weekday" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>weekday</span></a>
|
|
@@ -76,7 +80,6 @@ The decimal part in ISO/SQL is 6 digits: first 3 = milliseconds, next 3 = micros
|
|
|
76
80
|
<a href="index.DateTime.html#toSeconds" class="tsd-index-link"><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>
|
|
77
81
|
<a href="index.DateTime.html#toString" class="tsd-index-link"><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>
|
|
78
82
|
<a href="index.DateTime.html#toUTC" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toUTC</span></a>
|
|
79
|
-
<a href="index.DateTime.html#toUnixInteger" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Unix<wbr/>Integer</span></a>
|
|
80
83
|
<a href="index.DateTime.html#valueOf" class="tsd-index-link"><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>
|
|
81
84
|
<a href="index.DateTime.html#fromFormat" class="tsd-index-link"><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>
|
|
82
85
|
<a href="index.DateTime.html#fromISO" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fromISO</span></a>
|
|
@@ -91,307 +94,306 @@ The decimal part in ISO/SQL is 6 digits: first 3 = milliseconds, next 3 = micros
|
|
|
91
94
|
<a href="index.DateTime.html#min" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>min</span></a>
|
|
92
95
|
<a href="index.DateTime.html#now" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>now</span></a>
|
|
93
96
|
<a href="index.DateTime.html#utc" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>utc</span></a>
|
|
94
|
-
</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 tsd-is-protected"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><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 tsd-is-protected"><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"><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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L143">src/utils/datetime/DateTime.ts:143</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L29">src/utils/datetime/DateTime.ts:29</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L28">src/utils/datetime/DateTime.ts:28</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L52">src/utils/datetime/DateTime.ts:52</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L56">src/utils/datetime/DateTime.ts:56</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L131">src/utils/datetime/DateTime.ts:131</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L127">src/utils/datetime/DateTime.ts:127</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isValid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Valid</span><a href="#isValid" 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="isValid.isValid-1"><span class="tsd-signature-keyword">get</span> isValid<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L123">src/utils/datetime/DateTime.ts:123</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L135">src/utils/datetime/DateTime.ts:135</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>
|
|
97
|
+
</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L150">src/utils/datetime/DateTime.ts:150</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L37">src/utils/datetime/DateTime.ts:37</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L36">src/utils/datetime/DateTime.ts:36</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L60">src/utils/datetime/DateTime.ts:60</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L64">src/utils/datetime/DateTime.ts:64</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L135">src/utils/datetime/DateTime.ts:135</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L131">src/utils/datetime/DateTime.ts:131</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L139">src/utils/datetime/DateTime.ts:139</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>
|
|
95
98
|
<p>This value will not exceed 999 because above that will carry over to the
|
|
96
99
|
millisecond part of the DateTime</p>
|
|
97
100
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The microsecond of the second (0–999)</p>
|
|
98
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L39">src/utils/datetime/DateTime.ts:39</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="millisecond" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>millisecond</span><a href="#millisecond" 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="millisecond.millisecond-1"><span class="tsd-signature-keyword">get</span> millisecond<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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L68">src/utils/datetime/DateTime.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="minute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>minute</span><a href="#minute" 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="minute.minute-1"><span class="tsd-signature-keyword">get</span> minute<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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L60">src/utils/datetime/DateTime.ts:60</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="month" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>month</span><a href="#month" 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="month.month-1"><span class="tsd-signature-keyword">get</span> month<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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L48">src/utils/datetime/DateTime.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="offset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>offset</span><a href="#offset" 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="offset.offset-1"><span class="tsd-signature-keyword">get</span> offset<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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L119">src/utils/datetime/DateTime.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="ordinal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ordinal</span><a href="#ordinal" 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="ordinal.ordinal-1"><span class="tsd-signature-keyword">get</span> ordinal<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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L107">src/utils/datetime/DateTime.ts:107</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="quarter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>quarter</span><a href="#quarter" 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="quarter.quarter-1"><span class="tsd-signature-keyword">get</span> quarter<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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L111">src/utils/datetime/DateTime.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="second" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>second</span><a href="#second" 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="second.second-1"><span class="tsd-signature-keyword">get</span> second<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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L64">src/utils/datetime/DateTime.ts:64</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="weekNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>week<wbr/>Number</span><a href="#weekNumber" 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="weekNumber.weekNumber-1"><span class="tsd-signature-keyword">get</span> weekNumber<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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L99">src/utils/datetime/DateTime.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="weekYear" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>week<wbr/>Year</span><a href="#weekYear" 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="weekYear.weekYear-1"><span class="tsd-signature-keyword">get</span> weekYear<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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L103">src/utils/datetime/DateTime.ts:103</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="weekday" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>weekday</span><a href="#weekday" 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="weekday.weekday-1"><span class="tsd-signature-keyword">get</span> weekday<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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L72">src/utils/datetime/DateTime.ts:72</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="weekdayName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>weekday<wbr/>Name</span><a href="#weekdayName" 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="weekdayName.weekdayName-1"><span class="tsd-signature-keyword">get</span> weekdayName<span class="tsd-signature-symbol">(</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></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the lowercase name of the weekday.</p>
|
|
101
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L47">src/utils/datetime/DateTime.ts:47</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="millisecond" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>millisecond</span><a href="#millisecond" 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="millisecond.millisecond-1"><span class="tsd-signature-keyword">get</span> millisecond<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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L76">src/utils/datetime/DateTime.ts:76</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="minute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>minute</span><a href="#minute" 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="minute.minute-1"><span class="tsd-signature-keyword">get</span> minute<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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L68">src/utils/datetime/DateTime.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="month" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>month</span><a href="#month" 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="month.month-1"><span class="tsd-signature-keyword">get</span> month<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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L56">src/utils/datetime/DateTime.ts:56</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="offset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>offset</span><a href="#offset" 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="offset.offset-1"><span class="tsd-signature-keyword">get</span> offset<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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L127">src/utils/datetime/DateTime.ts:127</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="ordinal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ordinal</span><a href="#ordinal" 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="ordinal.ordinal-1"><span class="tsd-signature-keyword">get</span> ordinal<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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L115">src/utils/datetime/DateTime.ts:115</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="quarter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>quarter</span><a href="#quarter" 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="quarter.quarter-1"><span class="tsd-signature-keyword">get</span> quarter<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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L119">src/utils/datetime/DateTime.ts:119</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="second" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>second</span><a href="#second" 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="second.second-1"><span class="tsd-signature-keyword">get</span> second<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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L72">src/utils/datetime/DateTime.ts:72</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="unixIntegerMicroseconds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unix<wbr/>Integer<wbr/>Microseconds</span><a href="#unixIntegerMicroseconds" 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="unixIntegerMicroseconds.unixIntegerMicroseconds-1"><span class="tsd-signature-keyword">get</span> unixIntegerMicroseconds<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>Returns the epoch time in microseconds as an integer.
|
|
102
|
+
Equivalent to <code>toMicroseconds()</code> since microseconds are always whole numbers.</p>
|
|
103
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" 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">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>
|
|
104
|
+
</code><button type="button">Copy</button></pre>
|
|
105
|
+
|
|
106
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1244">src/utils/datetime/DateTime.ts:1244</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="unixIntegerMilliseconds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unix<wbr/>Integer<wbr/>Milliseconds</span><a href="#unixIntegerMilliseconds" 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="unixIntegerMilliseconds.unixIntegerMilliseconds-1"><span class="tsd-signature-keyword">get</span> unixIntegerMilliseconds<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>Returns the epoch time in milliseconds as an integer, truncating any fractional part.</p>
|
|
107
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" 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">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>
|
|
108
|
+
</code><button type="button">Copy</button></pre>
|
|
109
|
+
|
|
110
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1232">src/utils/datetime/DateTime.ts:1232</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="unixIntegerSeconds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unix<wbr/>Integer<wbr/>Seconds</span><a href="#unixIntegerSeconds" 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="unixIntegerSeconds.unixIntegerSeconds-1"><span class="tsd-signature-keyword">get</span> unixIntegerSeconds<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>Returns the epoch time in seconds as an integer, truncating any fractional part.</p>
|
|
111
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-2" class="tsd-anchor"></a>Example<a href="#Example-2" 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">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>
|
|
112
|
+
</code><button type="button">Copy</button></pre>
|
|
113
|
+
|
|
114
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1220">src/utils/datetime/DateTime.ts:1220</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="weekNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>week<wbr/>Number</span><a href="#weekNumber" 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="weekNumber.weekNumber-1"><span class="tsd-signature-keyword">get</span> weekNumber<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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L107">src/utils/datetime/DateTime.ts:107</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="weekYear" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>week<wbr/>Year</span><a href="#weekYear" 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="weekYear.weekYear-1"><span class="tsd-signature-keyword">get</span> weekYear<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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L111">src/utils/datetime/DateTime.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="weekday" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>weekday</span><a href="#weekday" 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="weekday.weekday-1"><span class="tsd-signature-keyword">get</span> weekday<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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L80">src/utils/datetime/DateTime.ts:80</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="weekdayName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>weekday<wbr/>Name</span><a href="#weekdayName" 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="weekdayName.weekdayName-1"><span class="tsd-signature-keyword">get</span> weekdayName<span class="tsd-signature-symbol">(</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></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the lowercase name of the weekday.</p>
|
|
99
115
|
</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>
|
|
100
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" 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">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>
|
|
116
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-3" class="tsd-anchor"></a>Example<a href="#Example-3" 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">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>
|
|
101
117
|
</code><button type="button">Copy</button></pre>
|
|
102
118
|
|
|
103
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
104
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
119
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L93">src/utils/datetime/DateTime.ts:93</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="year" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>year</span><a href="#year" 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="year.year-1"><span class="tsd-signature-keyword">get</span> year<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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L52">src/utils/datetime/DateTime.ts:52</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="zone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>zone</span><a href="#zone" 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="zone.zone-1"><span class="tsd-signature-keyword">get</span> zone<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Zone</span></li><li 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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L143">src/utils/datetime/DateTime.ts:143</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="zoneName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>zone<wbr/>Name</span><a href="#zoneName" 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="zoneName.zoneName-1"><span class="tsd-signature-keyword">get</span> zoneName<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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L123">src/utils/datetime/DateTime.ts:123</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATETIME_FULL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATETIME_FULL.DATETIME_FULL-1"><span class="tsd-signature-keyword">get</span> DATETIME_FULL<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#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>
|
|
120
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-4" class="tsd-anchor"></a>Example<a href="#Example-4" 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">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>
|
|
105
121
|
</code><button type="button">Copy</button></pre>
|
|
106
122
|
|
|
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">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
123
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L388">src/utils/datetime/DateTime.ts:388</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATETIME_FULL_WITH_SECONDS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATETIME_FULL_WITH_SECONDS.DATETIME_FULL_WITH_SECONDS-1"><span class="tsd-signature-keyword">get</span> DATETIME_FULL_WITH_SECONDS<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#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>
|
|
124
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-5" class="tsd-anchor"></a>Example<a href="#Example-5" 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">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>
|
|
109
125
|
</code><button type="button">Copy</button></pre>
|
|
110
126
|
|
|
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">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
127
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L399">src/utils/datetime/DateTime.ts:399</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATETIME_HUGE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATETIME_HUGE.DATETIME_HUGE-1"><span class="tsd-signature-keyword">get</span> DATETIME_HUGE<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#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>
|
|
128
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-6" class="tsd-anchor"></a>Example<a href="#Example-6" 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">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>
|
|
113
129
|
</code><button type="button">Copy</button></pre>
|
|
114
130
|
|
|
115
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
116
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
131
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L410">src/utils/datetime/DateTime.ts:410</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATETIME_HUGE_WITH_SECONDS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATETIME_HUGE_WITH_SECONDS.DATETIME_HUGE_WITH_SECONDS-1"><span class="tsd-signature-keyword">get</span> DATETIME_HUGE_WITH_SECONDS<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#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>
|
|
132
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-7" class="tsd-anchor"></a>Example<a href="#Example-7" 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">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>
|
|
117
133
|
</code><button type="button">Copy</button></pre>
|
|
118
134
|
|
|
119
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
120
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
135
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L421">src/utils/datetime/DateTime.ts:421</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATETIME_MED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATETIME_MED.DATETIME_MED-1"><span class="tsd-signature-keyword">get</span> DATETIME_MED<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'Oct 14, 1983, 9:30 AM'. Only 12-hour if the locale is.</p>
|
|
136
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-8" class="tsd-anchor"></a>Example<a href="#Example-8" 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">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>
|
|
121
137
|
</code><button type="button">Copy</button></pre>
|
|
122
138
|
|
|
123
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
124
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
139
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L355">src/utils/datetime/DateTime.ts:355</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATETIME_MED_WITH_SECONDS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATETIME_MED_WITH_SECONDS.DATETIME_MED_WITH_SECONDS-1"><span class="tsd-signature-keyword">get</span> DATETIME_MED_WITH_SECONDS<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#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>
|
|
140
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-9" class="tsd-anchor"></a>Example<a href="#Example-9" 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">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>
|
|
125
141
|
</code><button type="button">Copy</button></pre>
|
|
126
142
|
|
|
127
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
128
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
143
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L366">src/utils/datetime/DateTime.ts:366</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATETIME_MED_WITH_WEEKDAY" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATETIME_MED_WITH_WEEKDAY.DATETIME_MED_WITH_WEEKDAY-1"><span class="tsd-signature-keyword">get</span> DATETIME_MED_WITH_WEEKDAY<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#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>
|
|
144
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-10" class="tsd-anchor"></a>Example<a href="#Example-10" 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">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>
|
|
129
145
|
</code><button type="button">Copy</button></pre>
|
|
130
146
|
|
|
131
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
132
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
147
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L377">src/utils/datetime/DateTime.ts:377</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATETIME_SHORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATETIME_SHORT.DATETIME_SHORT-1"><span class="tsd-signature-keyword">get</span> DATETIME_SHORT<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like '10/14/1983, 9:30 AM'. Only 12-hour if the locale is.</p>
|
|
148
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-11" class="tsd-anchor"></a>Example<a href="#Example-11" 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">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>
|
|
133
149
|
</code><button type="button">Copy</button></pre>
|
|
134
150
|
|
|
135
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
136
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
151
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L333">src/utils/datetime/DateTime.ts:333</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATETIME_SHORT_WITH_SECONDS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATETIME_SHORT_WITH_SECONDS.DATETIME_SHORT_WITH_SECONDS-1"><span class="tsd-signature-keyword">get</span> DATETIME_SHORT_WITH_SECONDS<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#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>
|
|
152
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-12" class="tsd-anchor"></a>Example<a href="#Example-12" 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">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>
|
|
137
153
|
</code><button type="button">Copy</button></pre>
|
|
138
154
|
|
|
139
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
140
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
155
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L344">src/utils/datetime/DateTime.ts:344</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATE_FULL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATE_FULL.DATE_FULL-1"><span class="tsd-signature-keyword">get</span> DATE_FULL<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'October 14, 1983'</p>
|
|
156
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-13" class="tsd-anchor"></a>Example<a href="#Example-13" 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">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>
|
|
141
157
|
</code><button type="button">Copy</button></pre>
|
|
142
158
|
|
|
143
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
144
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
159
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L223">src/utils/datetime/DateTime.ts:223</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATE_HUGE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATE_HUGE.DATE_HUGE-1"><span class="tsd-signature-keyword">get</span> DATE_HUGE<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'Tuesday, October 14, 1983'</p>
|
|
160
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-14" class="tsd-anchor"></a>Example<a href="#Example-14" 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">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>
|
|
145
161
|
</code><button type="button">Copy</button></pre>
|
|
146
162
|
|
|
147
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
148
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
163
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L234">src/utils/datetime/DateTime.ts:234</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATE_MED" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATE_MED.DATE_MED-1"><span class="tsd-signature-keyword">get</span> DATE_MED<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'Oct 14, 1983'</p>
|
|
164
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-15" class="tsd-anchor"></a>Example<a href="#Example-15" 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">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>
|
|
149
165
|
</code><button type="button">Copy</button></pre>
|
|
150
166
|
|
|
151
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
152
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
167
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L201">src/utils/datetime/DateTime.ts:201</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATE_MED_WITH_WEEKDAY" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATE_MED_WITH_WEEKDAY.DATE_MED_WITH_WEEKDAY-1"><span class="tsd-signature-keyword">get</span> DATE_MED_WITH_WEEKDAY<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like 'Fri, Oct 14, 1983'</p>
|
|
168
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-16" class="tsd-anchor"></a>Example<a href="#Example-16" 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">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>
|
|
153
169
|
</code><button type="button">Copy</button></pre>
|
|
154
170
|
|
|
155
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
156
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
171
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L212">src/utils/datetime/DateTime.ts:212</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="DATE_SHORT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="DATE_SHORT.DATE_SHORT-1"><span class="tsd-signature-keyword">get</span> DATE_SHORT<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like 10/14/1983</p>
|
|
172
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-17" class="tsd-anchor"></a>Example<a href="#Example-17" 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">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>
|
|
157
173
|
</code><button type="button">Copy</button></pre>
|
|
158
174
|
|
|
159
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
160
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
175
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L190">src/utils/datetime/DateTime.ts:190</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="TIME_24_SIMPLE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="TIME_24_SIMPLE.TIME_24_SIMPLE-1"><span class="tsd-signature-keyword">get</span> TIME_24_SIMPLE<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30', always 24-hour.</p>
|
|
176
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-18" class="tsd-anchor"></a>Example<a href="#Example-18" 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">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>
|
|
161
177
|
</code><button type="button">Copy</button></pre>
|
|
162
178
|
|
|
163
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
164
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
179
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L289">src/utils/datetime/DateTime.ts:289</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="TIME_24_WITH_LONG_OFFSET" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="TIME_24_WITH_LONG_OFFSET.TIME_24_WITH_LONG_OFFSET-1"><span class="tsd-signature-keyword">get</span> TIME_24_WITH_LONG_OFFSET<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30:23 Eastern Daylight Time', always 24-hour.</p>
|
|
180
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-19" class="tsd-anchor"></a>Example<a href="#Example-19" 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">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>
|
|
165
181
|
</code><button type="button">Copy</button></pre>
|
|
166
182
|
|
|
167
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
168
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
183
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L322">src/utils/datetime/DateTime.ts:322</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="TIME_24_WITH_SECONDS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="TIME_24_WITH_SECONDS.TIME_24_WITH_SECONDS-1"><span class="tsd-signature-keyword">get</span> TIME_24_WITH_SECONDS<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30:23', always 24-hour.</p>
|
|
184
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-20" class="tsd-anchor"></a>Example<a href="#Example-20" 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">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>
|
|
169
185
|
</code><button type="button">Copy</button></pre>
|
|
170
186
|
|
|
171
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
172
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
187
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L300">src/utils/datetime/DateTime.ts:300</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="TIME_24_WITH_SHORT_OFFSET" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="TIME_24_WITH_SHORT_OFFSET.TIME_24_WITH_SHORT_OFFSET-1"><span class="tsd-signature-keyword">get</span> TIME_24_WITH_SHORT_OFFSET<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30:23 EDT', always 24-hour.</p>
|
|
188
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-21" class="tsd-anchor"></a>Example<a href="#Example-21" 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">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>
|
|
173
189
|
</code><button type="button">Copy</button></pre>
|
|
174
190
|
|
|
175
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
176
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
191
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L311">src/utils/datetime/DateTime.ts:311</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="TIME_SIMPLE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="TIME_SIMPLE.TIME_SIMPLE-1"><span class="tsd-signature-keyword">get</span> TIME_SIMPLE<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30 AM'. Only 12-hour if the locale is.</p>
|
|
192
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-22" class="tsd-anchor"></a>Example<a href="#Example-22" 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">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>
|
|
177
193
|
</code><button type="button">Copy</button></pre>
|
|
178
194
|
|
|
179
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
180
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
195
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L245">src/utils/datetime/DateTime.ts:245</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="TIME_WITH_LONG_OFFSET" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="TIME_WITH_LONG_OFFSET.TIME_WITH_LONG_OFFSET-1"><span class="tsd-signature-keyword">get</span> TIME_WITH_LONG_OFFSET<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#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>
|
|
196
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-23" class="tsd-anchor"></a>Example<a href="#Example-23" 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">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>
|
|
181
197
|
</code><button type="button">Copy</button></pre>
|
|
182
198
|
|
|
183
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
184
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
199
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L278">src/utils/datetime/DateTime.ts:278</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="TIME_WITH_SECONDS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="TIME_WITH_SECONDS.TIME_WITH_SECONDS-1"><span class="tsd-signature-keyword">get</span> TIME_WITH_SECONDS<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30:23 AM'. Only 12-hour if the locale is.</p>
|
|
200
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-24" class="tsd-anchor"></a>Example<a href="#Example-24" 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">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>
|
|
185
201
|
</code><button type="button">Copy</button></pre>
|
|
186
202
|
|
|
187
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
188
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
203
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L256">src/utils/datetime/DateTime.ts:256</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="TIME_WITH_SHORT_OFFSET" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="TIME_WITH_SHORT_OFFSET.TIME_WITH_SHORT_OFFSET-1"><span class="tsd-signature-keyword">get</span> TIME_WITH_SHORT_OFFSET<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeFormatOptions</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p><a href="index.DateTime.html#toLocaleString" class="tsd-kind-method">DateTime.toLocaleString</a> format like '09:30:23 AM EDT'. Only 12-hour if the locale is.</p>
|
|
204
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatOptions</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-25" class="tsd-anchor"></a>Example<a href="#Example-25" 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">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>
|
|
189
205
|
</code><button type="button">Copy</button></pre>
|
|
190
206
|
|
|
191
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
207
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L267">src/utils/datetime/DateTime.ts:267</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-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="diff" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>diff</span><a href="#diff" 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="diff.diff-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">diff</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.DateTime.html#diff.diff-1.U">U</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">other</span>, <span class="tsd-kind-parameter">unit</span><span class="tsd-signature-symbol">?</span><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="index.DateTime.html#diff.diff-1.U">U</a><span class="tsd-signature-symbol">></span><a href="#diff.diff-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 difference between this and another DateTime.</p>
|
|
192
208
|
<p>Supports microsecond precision when 'microseconds' is included in the unit parameter.</p>
|
|
193
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="diff.diff-1.U" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">U</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><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><
|
|
209
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="diff.diff-1.U" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">U</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><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><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-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="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></span><div class="tsd-comment tsd-typography"><p>DateTime to diff against</p>
|
|
194
210
|
</div><div class="tsd-comment tsd-typography"></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="index.DateTime.html#diff.diff-1.U">U</a></span><div class="tsd-comment tsd-typography"><p>Unit or units to return (e.g., 'days', 'hours', ['days', 'hours', 'microseconds'])</p>
|
|
195
211
|
</div><div class="tsd-comment tsd-typography"></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="index.DateTime.html#diff.diff-1.U">U</a><span class="tsd-signature-symbol">></span></h4><p>Object with only the specified units (or all units if not specified)</p>
|
|
196
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
212
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-26" class="tsd-anchor"></a>Example<a href="#Example-26" 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">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>
|
|
197
213
|
</code><button type="button">Copy</button></pre>
|
|
198
214
|
|
|
199
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
215
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1418">src/utils/datetime/DateTime.ts:1418</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="diffNow" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>diff<wbr/>Now</span><a href="#diffNow" 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="diffNow.diffNow-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">diff<wbr/>Now</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.DateTime.html#diffNow.diffNow-1.U-1">U</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">unit</span><span class="tsd-signature-symbol">?</span><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="index.DateTime.html#diffNow.diffNow-1.U-1">U</a><span class="tsd-signature-symbol">></span><a href="#diffNow.diffNow-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 difference between this DateTime and now.</p>
|
|
200
216
|
<p>Supports microsecond precision when 'microseconds' is included in the unit parameter.</p>
|
|
201
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="diffNow.diffNow-1.U-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">U</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><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><
|
|
217
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="diffNow.diffNow-1.U-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">U</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><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><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-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="index.DateTime.html#diffNow.diffNow-1.U-1">U</a></span><div class="tsd-comment tsd-typography"><p>Unit or units to return</p>
|
|
202
218
|
</div><div class="tsd-comment tsd-typography"></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="index.DateTime.html#diffNow.diffNow-1.U-1">U</a><span class="tsd-signature-symbol">></span></h4><p>Object with only the specified units (or all units if not specified)</p>
|
|
203
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
219
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-27" class="tsd-anchor"></a>Example<a href="#Example-27" 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">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>
|
|
204
220
|
</code><button type="button">Copy</button></pre>
|
|
205
221
|
|
|
206
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
222
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1478">src/utils/datetime/DateTime.ts:1478</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="endOf" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>end<wbr/>Of</span><a href="#endOf" 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="endOf.endOf-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">end<wbr/>Of</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">unit</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="#endOf.endOf-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 a new DateTime at the end of the given unit.
|
|
207
223
|
Microsecond is 999 when unit is 'millisecond', else 0.</p>
|
|
208
224
|
</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>
|
|
209
225
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </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><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Optional options</p>
|
|
210
226
|
</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">use<wbr/>Locale<wbr/>Weeks</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
211
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
227
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-28" class="tsd-anchor"></a>Example<a href="#Example-28" 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-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>
|
|
212
228
|
</code><button type="button">Copy</button></pre>
|
|
213
229
|
|
|
214
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
230
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1354">src/utils/datetime/DateTime.ts:1354</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="equals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>equals</span><a href="#equals" 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="equals.equals-1" class="tsd-anchor"></a><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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#equals.equals-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 true if this and other represent the same instant and microsecond.</p>
|
|
215
231
|
</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="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></span><div class="tsd-comment tsd-typography"><p>DateTime to compare</p>
|
|
216
232
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if equal</p>
|
|
217
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
233
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-29" class="tsd-anchor"></a>Example<a href="#Example-29" 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">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>
|
|
218
234
|
</code><button type="button">Copy</button></pre>
|
|
219
235
|
|
|
220
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
236
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1163">src/utils/datetime/DateTime.ts:1163</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hasSame" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Same</span><a href="#hasSame" 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="hasSame.hasSame-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">has<wbr/>Same</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">other</span>, <span class="tsd-kind-parameter">unit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasSame.hasSame-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 true if this DateTime is in the same unit as another.</p>
|
|
221
237
|
</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="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></span><div class="tsd-comment tsd-typography"><p>DateTime to compare</p>
|
|
222
238
|
</div><div class="tsd-comment tsd-typography"></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>
|
|
223
239
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if same</p>
|
|
224
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
240
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-30" class="tsd-anchor"></a>Example<a href="#Example-30" 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">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>
|
|
225
241
|
</code><button type="button">Copy</button></pre>
|
|
226
242
|
|
|
227
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
243
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1398">src/utils/datetime/DateTime.ts:1398</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="minus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>minus</span><a href="#minus" 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="minus.minus-1" class="tsd-anchor"></a><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-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#minus.minus-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>Subtracts a duration from this DateTime. Supports microsecond via DurationLikeObject.
|
|
228
244
|
Fractional milliseconds are converted to microseconds (e.g., 1.5 ms = 1 ms + 500 µs).</p>
|
|
229
245
|
</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>
|
|
230
246
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
231
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
247
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-31" class="tsd-anchor"></a>Example<a href="#Example-31" 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">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>
|
|
232
248
|
</code><button type="button">Copy</button></pre>
|
|
233
249
|
|
|
234
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
250
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1105">src/utils/datetime/DateTime.ts:1105</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="plus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>plus</span><a href="#plus" 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="plus.plus-1" class="tsd-anchor"></a><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-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#plus.plus-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>Adds a duration to this DateTime. Supports microsecond via DurationLikeObject.
|
|
235
251
|
Fractional milliseconds are converted to microseconds (e.g., 1.5 ms = 1 ms + 500 µs).</p>
|
|
236
252
|
</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>
|
|
237
253
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
238
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
254
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-32" class="tsd-anchor"></a>Example<a href="#Example-32" 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-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>
|
|
239
255
|
</code><button type="button">Copy</button></pre>
|
|
240
256
|
|
|
241
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
257
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1084">src/utils/datetime/DateTime.ts:1084</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="reconfigure" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reconfigure</span><a href="#reconfigure" 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="reconfigure.reconfigure-1" class="tsd-anchor"></a><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-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#reconfigure.reconfigure-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 a new DateTime with the given locale/zone options. Microsecond is preserved.</p>
|
|
242
258
|
</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>
|
|
243
259
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
244
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
260
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-33" class="tsd-anchor"></a>Example<a href="#Example-33" 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-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>
|
|
245
261
|
</code><button type="button">Copy</button></pre>
|
|
246
262
|
|
|
247
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
248
|
-
</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">DateTimeObject</span></span><div class="tsd-comment tsd-typography"><p>Object with units to set (year, month, day, hour, minute, second, millisecond, microsecond)</p>
|
|
263
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1369">src/utils/datetime/DateTime.ts:1369</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="set" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set</span><a href="#set" 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="set.set-1" class="tsd-anchor"></a><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-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#set.set-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 a new DateTime with the given units set.</p>
|
|
264
|
+
</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>
|
|
249
265
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
250
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
266
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-34" class="tsd-anchor"></a>Example<a href="#Example-34" 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-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>
|
|
251
267
|
</code><button type="button">Copy</button></pre>
|
|
252
268
|
|
|
253
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
269
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1124">src/utils/datetime/DateTime.ts:1124</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setLocale" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Locale</span><a href="#setLocale" 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="setLocale.setLocale-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Locale</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">locale</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="#setLocale.setLocale-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 a new DateTime with the given locale. Microsecond is preserved.</p>
|
|
254
270
|
</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>
|
|
255
271
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
256
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
272
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-35" class="tsd-anchor"></a>Example<a href="#Example-35" 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-5">setLocale</span><span class="hl-1">(</span><span class="hl-6">'fr'</span><span class="hl-1">)</span>
|
|
257
273
|
</code><button type="button">Copy</button></pre>
|
|
258
274
|
|
|
259
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
275
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1383">src/utils/datetime/DateTime.ts:1383</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setZone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Zone</span><a href="#setZone" 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="setZone.setZone-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Zone</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">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-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#setZone.setZone-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 a new DateTime in the given zone. Microsecond is preserved.</p>
|
|
260
276
|
</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>
|
|
261
277
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </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><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Optional zone options (keepLocalTime, etc.)</p>
|
|
262
278
|
</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">keep<wbr/>Local<wbr/>Time</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
263
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
279
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-36" class="tsd-anchor"></a>Example<a href="#Example-36" 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-5">setZone</span><span class="hl-1">(</span><span class="hl-6">'utc'</span><span class="hl-1">)</span>
|
|
264
280
|
</code><button type="button">Copy</button></pre>
|
|
265
281
|
|
|
266
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
282
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1292">src/utils/datetime/DateTime.ts:1292</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="startOf" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start<wbr/>Of</span><a href="#startOf" 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="startOf.startOf-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start<wbr/>Of</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">unit</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="#startOf.startOf-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 a new DateTime at the start of the given unit.
|
|
267
283
|
Microsecond is 0 except when unit is 'millisecond' (then preserved).</p>
|
|
268
284
|
</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>
|
|
269
285
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </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><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Optional options</p>
|
|
270
286
|
</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">use<wbr/>Locale<wbr/>Weeks</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime</p>
|
|
271
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
287
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-37" class="tsd-anchor"></a>Example<a href="#Example-37" 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">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>
|
|
272
288
|
</code><button type="button">Copy</button></pre>
|
|
273
289
|
|
|
274
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
290
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1336">src/utils/datetime/DateTime.ts:1336</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Format</span><a href="#toFormat" 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="toFormat.toFormat-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Format</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fmt</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><span class="tsd-signature-type">string</span><a href="#toFormat.toFormat-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 a string representation using a format string.
|
|
275
291
|
Supports all Luxon format tokens. Fractional second tokens (S, SSS, SSSSSS) are enhanced
|
|
276
292
|
to include microseconds beyond Luxon's millisecond precision.</p>
|
|
277
293
|
</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>
|
|
278
294
|
</div><div class="tsd-comment tsd-typography"></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>
|
|
279
295
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>Formatted string</p>
|
|
280
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
296
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-38" class="tsd-anchor"></a>Example<a href="#Example-38" 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-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>
|
|
281
297
|
</code><button type="button">Copy</button></pre>
|
|
282
298
|
|
|
283
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
284
|
-
|
|
285
|
-
</div><div class="tsd-
|
|
286
|
-
|
|
299
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1048">src/utils/datetime/DateTime.ts:1048</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toISO" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toISO</span><a href="#toISO" 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="toISO.toISO-1" class="tsd-anchor"></a><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-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toISO.toISO-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 an ISO 8601 string with 6 fractional second digits (milliseconds + microseconds).</p>
|
|
300
|
+
<p>Always converts to UTC before formatting (e.g., '2024-03-15T15:30:45.123456Z').</p>
|
|
301
|
+
</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>
|
|
302
|
+
</div><div class="tsd-comment tsd-typography"></div></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>
|
|
303
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-39" class="tsd-anchor"></a>Example<a href="#Example-39" 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">fromISO</span><span class="hl-1">(</span><span class="hl-6">'2024-03-15T10:30:45.123456'</span><span class="hl-1">).</span><span class="hl-5">toISO</span><span class="hl-1">() </span><span class="hl-7">// Converts to UTC</span>
|
|
287
304
|
</code><button type="button">Copy</button></pre>
|
|
288
305
|
|
|
289
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
306
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L847">src/utils/datetime/DateTime.ts:847</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toISODate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toISODate</span><a href="#toISODate" 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="toISODate.toISODate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toISODate</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="#toISODate.toISODate-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 an ISO date string (date only, no time).</p>
|
|
290
307
|
</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>
|
|
291
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
308
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-40" class="tsd-anchor"></a>Example<a href="#Example-40" 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-5">toISODate</span><span class="hl-1">()</span>
|
|
292
309
|
</code><button type="button">Copy</button></pre>
|
|
293
310
|
|
|
294
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
311
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L860">src/utils/datetime/DateTime.ts:860</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toISOTime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toISOTime</span><a href="#toISOTime" 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="toISOTime.toISOTime-1" class="tsd-anchor"></a><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-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toISOTime.toISOTime-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 time portion in ISO format with 6 fractional second digits.</p>
|
|
312
|
+
<p>Omits timezone offset by default (e.g., '10:30:45.123456').</p>
|
|
295
313
|
</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>
|
|
296
|
-
</div><div class="tsd-comment tsd-typography"></div></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-05:00")</p>
|
|
297
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
314
|
+
</div><div class="tsd-comment tsd-typography"></div></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>
|
|
315
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-41" class="tsd-anchor"></a>Example<a href="#Example-41" 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">toISOTime</span><span class="hl-1">() </span><span class="hl-7">// '10:30:45.123456'</span>
|
|
298
316
|
</code><button type="button">Copy</button></pre>
|
|
299
317
|
|
|
300
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
318
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L880">src/utils/datetime/DateTime.ts:880</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toJSDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSDate</span><a href="#toJSDate" 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="toJSDate.toJSDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toJSDate</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><a href="#toJSDate.toJSDate-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 a JavaScript Date object.</p>
|
|
301
319
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4><p>JavaScript Date</p>
|
|
302
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
320
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-42" class="tsd-anchor"></a>Example<a href="#Example-42" 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-5">toJSDate</span><span class="hl-1">()</span>
|
|
303
321
|
</code><button type="button">Copy</button></pre>
|
|
304
322
|
|
|
305
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
323
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L954">src/utils/datetime/DateTime.ts:954</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" 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="toJSON.toJSON-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toJSON</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="#toJSON.toJSON-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 an ISO 8601 formatted string for JSON serialization.
|
|
306
324
|
This ensures DateTime objects are properly serialized to ISO format.</p>
|
|
325
|
+
<p>Converts to UTC before formatting.</p>
|
|
307
326
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>ISO datetime string with microsecond precision</p>
|
|
308
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
327
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-43" class="tsd-anchor"></a>Example<a href="#Example-43" 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">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>
|
|
309
328
|
</code><button type="button">Copy</button></pre>
|
|
310
329
|
|
|
311
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
330
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L990">src/utils/datetime/DateTime.ts:990</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toLocal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Local</span><a href="#toLocal" 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="toLocal.toLocal-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Local</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="#toLocal.toLocal-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 a new DateTime in the system's local zone. Microsecond is preserved.</p>
|
|
312
331
|
</div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime in local zone</p>
|
|
313
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
332
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-44" class="tsd-anchor"></a>Example<a href="#Example-44" 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">dtUTC</span><span class="hl-1">.</span><span class="hl-5">toLocal</span><span class="hl-1">()</span>
|
|
314
333
|
</code><button type="button">Copy</button></pre>
|
|
315
334
|
|
|
316
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
317
|
-
</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>
|
|
318
|
-
</div><div class="tsd-comment tsd-typography"></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
|
|
335
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1320">src/utils/datetime/DateTime.ts:1320</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toLocaleString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Locale<wbr/>String</span><a href="#toLocaleString" 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="toLocaleString.toLocaleString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Locale<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formatOpts</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><span class="tsd-signature-type">string</span><a href="#toLocaleString.toLocaleString-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 a localized string representation.</p>
|
|
336
|
+
</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>
|
|
337
|
+
</div><div class="tsd-comment tsd-typography"></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>
|
|
319
338
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>Localized string</p>
|
|
320
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
339
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-45" class="tsd-anchor"></a>Example<a href="#Example-45" 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-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>
|
|
321
340
|
</code><button type="button">Copy</button></pre>
|
|
322
341
|
|
|
323
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
342
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1027">src/utils/datetime/DateTime.ts:1027</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toLuxon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Luxon</span><a href="#toLuxon" 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="toLuxon.toLuxon-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Luxon</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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><a href="#toLuxon.toLuxon-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 underlying Luxon DateTime instance.
|
|
324
343
|
Since Luxon is immutable, it is safe to return the actual object.</p>
|
|
325
344
|
</div><h4 class="tsd-returns-title">Returns <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></h4><p>The Luxon DateTime instance</p>
|
|
326
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
345
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-46" class="tsd-anchor"></a>Example<a href="#Example-46" 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-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>
|
|
327
346
|
</code><button type="button">Copy</button></pre>
|
|
328
347
|
|
|
329
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
348
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L165">src/utils/datetime/DateTime.ts:165</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toMicroseconds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Microseconds</span><a href="#toMicroseconds" 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="toMicroseconds.toMicroseconds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Microseconds</span><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><a href="#toMicroseconds.toMicroseconds-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 epoch time in microseconds (toMillis * 1000 + microsecond).</p>
|
|
330
349
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>Unix timestamp in microseconds</p>
|
|
331
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
350
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-47" class="tsd-anchor"></a>Example<a href="#Example-47" 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">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>
|
|
332
351
|
</code><button type="button">Copy</button></pre>
|
|
333
352
|
|
|
334
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
353
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1187">src/utils/datetime/DateTime.ts:1187</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toMillis" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Millis</span><a href="#toMillis" 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="toMillis.toMillis-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Millis</span><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><a href="#toMillis.toMillis-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 epoch time in milliseconds (toMillis * 1000 + millisecond).</p>
|
|
335
354
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>Unix timestamp in milliseconds</p>
|
|
336
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
355
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-48" class="tsd-anchor"></a>Example<a href="#Example-48" 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">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>
|
|
337
356
|
</code><button type="button">Copy</button></pre>
|
|
338
357
|
|
|
339
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
340
|
-
</div><
|
|
341
|
-
|
|
342
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-46" class="tsd-anchor"></a>Example<a href="#Example-46" 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">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>
|
|
358
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1175">src/utils/datetime/DateTime.ts:1175</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toObject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Object</span><a href="#toObject" 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="toObject.toObject-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Object</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DateTimeObject</span><a href="#toObject.toObject-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 an object with date/time components including microsecond.</p>
|
|
359
|
+
</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>
|
|
360
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-49" class="tsd-anchor"></a>Example<a href="#Example-49" 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">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>
|
|
343
361
|
</code><button type="button">Copy</button></pre>
|
|
344
362
|
|
|
345
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
346
|
-
</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">ToSQLOptions</span></span><div class="tsd-comment tsd-typography"><p>Optional format options</p>
|
|
347
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>SQL string (e.g. "2024-03-15 10:30:45.123456")</p>
|
|
348
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-47" class="tsd-anchor"></a>Example<a href="#Example-47" 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">toSQL</span><span class="hl-1">()</span>
|
|
349
|
-
</code><button type="button">Copy</button></pre>
|
|
350
|
-
|
|
351
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L833">src/utils/datetime/DateTime.ts:833</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toSQLDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toSQLDate</span><a href="#toSQLDate" 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="toSQLDate.toSQLDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toSQLDate</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="#toSQLDate.toSQLDate-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 an SQL date string (date only, no time).</p>
|
|
363
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1140">src/utils/datetime/DateTime.ts:1140</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toSQL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toSQL</span><a href="#toSQL" 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="toSQL.toSQL-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toSQL</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="#toSQL.toSQL-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"><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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L903">src/utils/datetime/DateTime.ts:903</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toSQLDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toSQLDate</span><a href="#toSQLDate" 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="toSQLDate.toSQLDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toSQLDate</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="#toSQLDate.toSQLDate-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 an SQL date string (date only, no time).</p>
|
|
352
364
|
</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>
|
|
353
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
365
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-50" class="tsd-anchor"></a>Example<a href="#Example-50" 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-5">toSQLDate</span><span class="hl-1">()</span>
|
|
354
366
|
</code><button type="button">Copy</button></pre>
|
|
355
367
|
|
|
356
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
357
|
-
|
|
358
|
-
</div><div class="tsd-
|
|
359
|
-
|
|
368
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L918">src/utils/datetime/DateTime.ts:918</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toSQLTime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toSQLTime</span><a href="#toSQLTime" 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="toSQLTime.toSQLTime-1" class="tsd-anchor"></a><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-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toSQLTime.toSQLTime-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 an SQL time string with 6 fractional second digits.</p>
|
|
369
|
+
<p>Omits timezone offset by default.</p>
|
|
370
|
+
</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><br/><span> </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><br/><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>
|
|
371
|
+
</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>
|
|
372
|
+
</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>
|
|
373
|
+
<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>
|
|
360
374
|
</code><button type="button">Copy</button></pre>
|
|
361
375
|
|
|
362
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
376
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L936">src/utils/datetime/DateTime.ts:936</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toSeconds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Seconds</span><a href="#toSeconds" 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="toSeconds.toSeconds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Seconds</span><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><a href="#toSeconds.toSeconds-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 epoch time in seconds, including fractional milliseconds.
|
|
363
377
|
Includes microsecond precision in the fractional part.</p>
|
|
364
378
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>Unix timestamp in seconds (with fractional milliseconds)</p>
|
|
365
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
379
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-52" class="tsd-anchor"></a>Example<a href="#Example-52" 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">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>
|
|
366
380
|
</code><button type="button">Copy</button></pre>
|
|
367
381
|
|
|
368
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
382
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1201">src/utils/datetime/DateTime.ts:1201</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" 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="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</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="#toString.toString-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 an ISO 8601 formatted string representation.
|
|
369
383
|
Alias for toISO().</p>
|
|
384
|
+
<p>Converts to UTC before formatting.</p>
|
|
370
385
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>ISO datetime string with microsecond precision</p>
|
|
371
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
386
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-53" class="tsd-anchor"></a>Example<a href="#Example-53" 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">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>
|
|
372
387
|
</code><button type="button">Copy</button></pre>
|
|
373
388
|
|
|
374
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
389
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1008">src/utils/datetime/DateTime.ts:1008</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toUTC" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toUTC</span><a href="#toUTC" 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="toUTC.toUTC-1" class="tsd-anchor"></a><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-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="#toUTC.toUTC-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 a new DateTime in UTC. Microsecond is preserved.</p>
|
|
375
390
|
</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>
|
|
376
391
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </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><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Optional zone options</p>
|
|
377
392
|
</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">keep<wbr/>Local<wbr/>Time</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A new DateTime in UTC</p>
|
|
378
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-
|
|
379
|
-
</code><button type="button">Copy</button></pre>
|
|
380
|
-
|
|
381
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L1242">src/utils/datetime/DateTime.ts:1242</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toUnixInteger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Unix<wbr/>Integer</span><a href="#toUnixInteger" 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="toUnixInteger.toUnixInteger-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Unix<wbr/>Integer</span><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><a href="#toUnixInteger.toUnixInteger-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 epoch time in seconds as an integer (floor of toSeconds).
|
|
382
|
-
Truncates any fractional seconds, returning only the whole seconds portion.
|
|
383
|
-
Equivalent to Math.floor(toSeconds()).</p>
|
|
384
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>Unix timestamp in seconds (integer only, no fractional part)</p>
|
|
385
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-53" class="tsd-anchor"></a>Example<a href="#Example-53" 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">fromSeconds</span><span class="hl-1">(</span><span class="hl-8">1707234567</span><span class="hl-1">).</span><span class="hl-5">toUnixInteger</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">toUnixInteger</span><span class="hl-1">() </span><span class="hl-7">// 1770455024 (fractional part truncated)</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-5">toUnixInteger</span><span class="hl-1">() </span><span class="hl-7">// 1770455024 (not rounded up)</span>
|
|
386
|
-
</code><button type="button">Copy</button></pre>
|
|
387
|
-
|
|
388
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L1179">src/utils/datetime/DateTime.ts:1179</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="valueOf" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value<wbr/>Of</span><a href="#valueOf" 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="valueOf.valueOf-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">value<wbr/>Of</span><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><a href="#valueOf.valueOf-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 epoch time in microseconds (for valueOf() operations).
|
|
389
|
-
Includes full microsecond precision.</p>
|
|
390
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>Unix timestamp in microseconds</p>
|
|
391
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-54" class="tsd-anchor"></a>Example<a href="#Example-54" 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-5">valueOf</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">'2026-02-07T09:03:44.123456Z'</span><span class="hl-1">).</span><span class="hl-5">valueOf</span><span class="hl-1">() </span><span class="hl-7">// includes microseconds</span>
|
|
393
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-54" class="tsd-anchor"></a>Example<a href="#Example-54" 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-5">toUTC</span><span class="hl-1">()</span>
|
|
392
394
|
</code><button type="button">Copy</button></pre>
|
|
393
395
|
|
|
394
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
396
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1307">src/utils/datetime/DateTime.ts:1307</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="valueOf" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value<wbr/>Of</span><a href="#valueOf" 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="valueOf.valueOf-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">value<wbr/>Of</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="#valueOf.valueOf-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"><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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L971">src/utils/datetime/DateTime.ts:971</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromFormat.fromFormat-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Format</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">text</span>, <span class="tsd-kind-parameter">format</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="#fromFormat.fromFormat-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>Create a DateTime from a custom format string.
|
|
395
397
|
Supports standard Luxon format tokens plus 'u' or 'SSSSSS' for microseconds (6 decimal places).</p>
|
|
396
398
|
</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>
|
|
397
399
|
</div><div class="tsd-comment tsd-typography"></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>
|
|
@@ -401,56 +403,57 @@ Supports standard Luxon format tokens plus 'u' or 'SSSSSS' for microseconds (6 d
|
|
|
401
403
|
<h4 class="tsd-anchor-link"><a id="Example-55" class="tsd-anchor"></a>Example<a href="#Example-55" 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">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>
|
|
402
404
|
</code><button type="button">Copy</button></pre>
|
|
403
405
|
|
|
404
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
406
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L817">src/utils/datetime/DateTime.ts:817</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromISO" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>fromISO</span><a href="#fromISO" 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="fromISO.fromISO-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fromISO</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">text</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="#fromISO.fromISO-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>Create a DateTime from an ISO 8601 string.</p>
|
|
405
407
|
</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>
|
|
406
|
-
</div><div class="tsd-comment tsd-typography"></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
|
|
408
|
+
</div><div class="tsd-comment tsd-typography"></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>
|
|
407
409
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the parsed instant</p>
|
|
408
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-56" class="tsd-anchor"></a>Example<a href="#Example-56" 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">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>
|
|
410
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-56" class="tsd-anchor"></a>Example<a href="#Example-56" 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">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>
|
|
409
411
|
</code><button type="button">Copy</button></pre>
|
|
410
412
|
|
|
411
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
413
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L760">src/utils/datetime/DateTime.ts:760</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromJSDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>fromJSDate</span><a href="#fromJSDate" 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="fromJSDate.fromJSDate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fromJSDate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">date</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="#fromJSDate.fromJSDate-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>Create a DateTime from a JavaScript Date.</p>
|
|
412
414
|
</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>
|
|
413
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">
|
|
415
|
+
</div><div class="tsd-comment tsd-typography"></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>
|
|
414
416
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime representing the same instant</p>
|
|
415
417
|
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-57" class="tsd-anchor"></a>Example<a href="#Example-57" 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">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>
|
|
416
418
|
</code><button type="button">Copy</button></pre>
|
|
417
419
|
|
|
418
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
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">microsecondsInput</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">
|
|
420
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L625">src/utils/datetime/DateTime.ts:625</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromMicroseconds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromMicroseconds.fromMicroseconds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Microseconds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">microsecondsInput</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="#fromMicroseconds.fromMicroseconds-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>Create a DateTime from epoch microseconds.</p>
|
|
421
|
+
</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>
|
|
420
422
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the given instant</p>
|
|
421
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-58" class="tsd-anchor"></a>Example<a href="#Example-58" 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">fromMicroseconds</span><span class="hl-1">(</span><span class="hl-8">1707234567890123</span><span class="hl-1">)</span>
|
|
423
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-58" class="tsd-anchor"></a>Example<a href="#Example-58" 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">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>
|
|
422
424
|
</code><button type="button">Copy</button></pre>
|
|
423
425
|
|
|
424
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
425
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">
|
|
426
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">
|
|
426
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L672">src/utils/datetime/DateTime.ts:672</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromMillis" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromMillis.fromMillis-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Millis</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">millisecondInput</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="#fromMillis.fromMillis-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>Create a DateTime from epoch milliseconds.</p>
|
|
427
|
+
</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>
|
|
428
|
+
</div><div class="tsd-comment tsd-typography"></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>
|
|
427
429
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the given instant</p>
|
|
428
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-59" class="tsd-anchor"></a>Example<a href="#Example-59" 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">fromMillis</span><span class="hl-1">(</span><span class="hl-8">1707234567890</span><span class="hl-1">)</span>
|
|
430
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-59" class="tsd-anchor"></a>Example<a href="#Example-59" 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">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>
|
|
429
431
|
</code><button type="button">Copy</button></pre>
|
|
430
432
|
|
|
431
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
433
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L649">src/utils/datetime/DateTime.ts:649</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromObject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromObject.fromObject-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Object</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</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="#fromObject.fromObject-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>Create a DateTime from an object with date/time units.
|
|
432
434
|
Fractional milliseconds are converted to microseconds (e.g., 1.5 ms = 1 ms + 500 µs).</p>
|
|
433
|
-
</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">DateTimeObject</span></span><div class="tsd-comment tsd-typography"><p>Object with year, month, day,
|
|
434
|
-
</div><div class="tsd-comment tsd-typography"></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
|
|
435
|
+
</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>
|
|
436
|
+
</div><div class="tsd-comment tsd-typography"></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>
|
|
435
437
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the given components</p>
|
|
436
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-60" class="tsd-anchor"></a>Example<a href="#Example-60" 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">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>
|
|
438
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-60" class="tsd-anchor"></a>Example<a href="#Example-60" 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">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>
|
|
437
439
|
</code><button type="button">Copy</button></pre>
|
|
438
440
|
|
|
439
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
441
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L721">src/utils/datetime/DateTime.ts:721</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromSQL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>fromSQL</span><a href="#fromSQL" 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="fromSQL.fromSQL-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fromSQL</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">text</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="#fromSQL.fromSQL-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>Create a DateTime from an SQL datetime string.</p>
|
|
440
442
|
</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>
|
|
441
|
-
</div><div class="tsd-comment tsd-typography"></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
|
|
443
|
+
</div><div class="tsd-comment tsd-typography"></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>
|
|
442
444
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the parsed instant</p>
|
|
443
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-61" class="tsd-anchor"></a>Example<a href="#Example-61" 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">fromSQL</span><span class="hl-1">(</span><span class="hl-6">'2024-03-15 10:30:45.123456'</span><span class="hl-1">)</span>
|
|
445
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-61" class="tsd-anchor"></a>Example<a href="#Example-61" 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">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>
|
|
444
446
|
</code><button type="button">Copy</button></pre>
|
|
445
447
|
|
|
446
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
447
|
-
|
|
448
|
-
</div><div class="tsd-
|
|
448
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L790">src/utils/datetime/DateTime.ts:790</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromSeconds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromSeconds.fromSeconds-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Seconds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seconds</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="#fromSeconds.fromSeconds-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>Create a DateTime from epoch seconds.
|
|
449
|
+
Fractional seconds are converted to milliseconds and microseconds.</p>
|
|
450
|
+
</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>
|
|
451
|
+
</div><div class="tsd-comment tsd-typography"></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>
|
|
449
452
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the given instant</p>
|
|
450
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-62" class="tsd-anchor"></a>Example<a href="#Example-62" 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">fromSeconds</span><span class="hl-1">(</span><span class="hl-8">1707234567</span><span class="hl-1">)</span>
|
|
453
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-62" class="tsd-anchor"></a>Example<a href="#Example-62" 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">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>
|
|
451
454
|
</code><button type="button">Copy</button></pre>
|
|
452
455
|
|
|
453
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
456
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L695">src/utils/datetime/DateTime.ts:695</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="local" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="local.local-1" 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">microsecond</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-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>Create a local DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
454
457
|
The last argument may be an options object instead of a time component.</p>
|
|
455
458
|
</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>
|
|
456
459
|
</div><div class="tsd-comment tsd-typography"></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>
|
|
@@ -458,29 +461,29 @@ The last argument may be an options object instead of a time component.</p>
|
|
|
458
461
|
</div><div class="tsd-comment tsd-typography"></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>
|
|
459
462
|
</div><div class="tsd-comment tsd-typography"></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>
|
|
460
463
|
</div><div class="tsd-comment tsd-typography"></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>
|
|
461
|
-
</div><div class="tsd-comment tsd-typography"></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>
|
|
464
|
+
</div><div class="tsd-comment tsd-typography"></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>
|
|
462
465
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in the local zone</p>
|
|
463
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-63" class="tsd-anchor"></a>Example<a href="#Example-63" 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-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">
|
|
466
|
+
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-63" class="tsd-anchor"></a>Example<a href="#Example-63" 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-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>
|
|
464
467
|
</code><button type="button">Copy</button></pre>
|
|
465
468
|
|
|
466
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L439">src/utils/datetime/DateTime.ts:439</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L450">src/utils/datetime/DateTime.ts:450</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L460">src/utils/datetime/DateTime.ts:460</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L469">src/utils/datetime/DateTime.ts:469</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L477">src/utils/datetime/DateTime.ts:477</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L484">src/utils/datetime/DateTime.ts:484</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L485">src/utils/datetime/DateTime.ts:485</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L486">src/utils/datetime/DateTime.ts:486</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L487">src/utils/datetime/DateTime.ts:487</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>
|
|
469
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L451">src/utils/datetime/DateTime.ts:451</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L462">src/utils/datetime/DateTime.ts:462</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L472">src/utils/datetime/DateTime.ts:472</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L481">src/utils/datetime/DateTime.ts:481</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L489">src/utils/datetime/DateTime.ts:489</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L496">src/utils/datetime/DateTime.ts:496</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/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-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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/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-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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L499">src/utils/datetime/DateTime.ts:499</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>
|
|
467
470
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">dateTimes</span>: <a href="index.DateTime.html" 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>
|
|
468
471
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <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></h4><p>The latest DateTime, or null if empty</p>
|
|
469
472
|
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-64" class="tsd-anchor"></a>Example<a href="#Example-64" 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">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>
|
|
470
473
|
</code><button type="button">Copy</button></pre>
|
|
471
474
|
|
|
472
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
475
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1274">src/utils/datetime/DateTime.ts:1274</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="min" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="min.min-1" class="tsd-anchor"></a><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><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="#min.min-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 earliest DateTime from the given arguments.</p>
|
|
473
476
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">dateTimes</span>: <a href="index.DateTime.html" 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>
|
|
474
477
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <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></h4><p>The earliest DateTime, or null if empty</p>
|
|
475
478
|
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-65" class="tsd-anchor"></a>Example<a href="#Example-65" 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">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>
|
|
476
479
|
</code><button type="button">Copy</button></pre>
|
|
477
480
|
|
|
478
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
479
|
-
</div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the current instant</p>
|
|
481
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L1257">src/utils/datetime/DateTime.ts:1257</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="now" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="now.now-1" class="tsd-anchor"></a><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-signature-symbol">: </span><a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><a href="#now.now-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 current time in the system's local zone.</p>
|
|
482
|
+
</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><br/><span> </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><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><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></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime for the current instant</p>
|
|
480
483
|
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-66" class="tsd-anchor"></a>Example<a href="#Example-66" 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-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>
|
|
481
484
|
</code><button type="button">Copy</button></pre>
|
|
482
485
|
|
|
483
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
486
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L177">src/utils/datetime/DateTime.ts:177</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="utc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="utc.utc-1" 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">millisecond</span>, <span class="tsd-kind-parameter">microsecond</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-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>Create a UTC DateTime. Accepts the same overloads as Luxon plus an optional microsecond (8th numeric arg).
|
|
484
487
|
The last argument may be an options object instead of a time component.</p>
|
|
485
488
|
</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>
|
|
486
489
|
</div><div class="tsd-comment tsd-typography"></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>
|
|
@@ -488,9 +491,9 @@ The last argument may be an options object instead of a time component.</p>
|
|
|
488
491
|
</div><div class="tsd-comment tsd-typography"></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>
|
|
489
492
|
</div><div class="tsd-comment tsd-typography"></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>
|
|
490
493
|
</div><div class="tsd-comment tsd-typography"></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>
|
|
491
|
-
</div><div class="tsd-comment tsd-typography"></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">
|
|
494
|
+
</div><div class="tsd-comment tsd-typography"></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>
|
|
492
495
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></h4><p>A DateTime in UTC</p>
|
|
493
496
|
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-67" class="tsd-anchor"></a>Example<a href="#Example-67" 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">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>
|
|
494
497
|
</code><button type="button">Copy</button></pre>
|
|
495
498
|
|
|
496
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L537">src/utils/datetime/DateTime.ts:537</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">options</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">options</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L548">src/utils/datetime/DateTime.ts:548</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">options</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">options</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L557">src/utils/datetime/DateTime.ts:557</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">options</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">options</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L565">src/utils/datetime/DateTime.ts:565</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">options</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">options</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L566">src/utils/datetime/DateTime.ts:566</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">options</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">options</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L567">src/utils/datetime/DateTime.ts:567</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">options</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">options</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L568">src/utils/datetime/DateTime.ts:568</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">options</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">options</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/32ea4a39c1e101c0029845e1bd6c95d479bbbd1f/src/utils/datetime/DateTime.ts#L569">src/utils/datetime/DateTime.ts:569</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="tsd-is-protected"><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="#isValid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Valid</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="#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="#toUnixInteger" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Unix<wbr/>Integer</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>
|
|
499
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L549">src/utils/datetime/DateTime.ts:549</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L560">src/utils/datetime/DateTime.ts:560</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L569">src/utils/datetime/DateTime.ts:569</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L577">src/utils/datetime/DateTime.ts:577</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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/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-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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/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-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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/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-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/9efc4c20c15d9ebf7ab6790d8b17e16c804ced82/src/utils/datetime/DateTime.ts#L581">src/utils/datetime/DateTime.ts:581</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>
|