@rvoh/dream 2.5.0 → 2.5.2
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 +0 -9
- package/dist/cjs/src/decorators/field/Encrypted.js +2 -1
- package/dist/cjs/src/helpers/db/columnAllowsNull.js +3 -0
- package/dist/cjs/src/helpers/db/normalizeDataForDb.js +2 -1
- package/dist/cjs/src/helpers/db/types/isDatabaseArrayColumn.js +2 -1
- package/dist/cjs/src/helpers/db/types/isDatetimeOrDatetimeArrayColumn.js +2 -1
- package/dist/cjs/src/helpers/db/types/isJsonColumn.js +2 -1
- package/dist/cjs/src/ops/index.js +2 -1
- package/dist/esm/src/Dream.js +0 -9
- package/dist/esm/src/decorators/field/Encrypted.js +2 -1
- package/dist/esm/src/helpers/db/columnAllowsNull.js +3 -0
- package/dist/esm/src/helpers/db/normalizeDataForDb.js +2 -1
- package/dist/esm/src/helpers/db/types/isDatabaseArrayColumn.js +2 -1
- package/dist/esm/src/helpers/db/types/isDatetimeOrDatetimeArrayColumn.js +2 -1
- package/dist/esm/src/helpers/db/types/isJsonColumn.js +2 -1
- package/dist/esm/src/ops/index.js +2 -1
- package/dist/types/src/Dream.d.ts +0 -6
- package/dist/types/src/helpers/db/columnAllowsNull.d.ts +2 -0
- package/dist/types/src/serializer/builders/DreamSerializerBuilder.d.ts +2 -2
- package/dist/types/src/types/dream.d.ts +34 -0
- package/dist/types/src/types/dream.ts +46 -0
- package/dist/types/src/types/serializer.d.ts +4 -4
- package/dist/types/src/types/serializer.ts +4 -14
- package/dist/types/src/types/variadic.d.ts +15 -6
- package/dist/types/src/types/variadic.ts +129 -31
- package/docs/classes/db.DreamMigrationHelpers.html +9 -9
- package/docs/classes/db.KyselyQueryDriver.html +32 -32
- package/docs/classes/db.PostgresQueryDriver.html +33 -33
- package/docs/classes/db.QueryDriverBase.html +31 -31
- package/docs/classes/errors.CheckConstraintViolation.html +3 -3
- package/docs/classes/errors.ColumnOverflow.html +3 -3
- package/docs/classes/errors.CreateOrFindByFailedToCreateAndFind.html +3 -3
- package/docs/classes/errors.DataIncompatibleWithDatabaseField.html +3 -3
- package/docs/classes/errors.DataTypeColumnTypeMismatch.html +3 -3
- package/docs/classes/errors.GlobalNameNotSet.html +3 -3
- package/docs/classes/errors.InvalidCalendarDate.html +2 -2
- package/docs/classes/errors.InvalidClockTime.html +2 -2
- package/docs/classes/errors.InvalidClockTimeTz.html +2 -2
- 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 +3 -3
- package/docs/classes/errors.RecordNotFound.html +3 -3
- package/docs/classes/errors.ValidationError.html +3 -3
- package/docs/classes/index.CalendarDate.html +33 -33
- package/docs/classes/index.ClockTime.html +32 -32
- package/docs/classes/index.ClockTimeTz.html +35 -35
- package/docs/classes/index.DateTime.html +86 -86
- package/docs/classes/index.Decorators.html +19 -19
- package/docs/classes/index.Dream.html +118 -118
- 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 +56 -56
- package/docs/classes/system.CliFileWriter.html +4 -4
- package/docs/classes/system.DreamBin.html +2 -2
- package/docs/classes/system.DreamCLI.html +6 -6
- package/docs/classes/system.DreamImporter.html +2 -2
- package/docs/classes/system.DreamLogos.html +2 -2
- package/docs/classes/system.DreamSerializerBuilder.html +13 -13
- 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.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 +2 -2
- 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/types/openapi.CommonOpenapiSchemaObjectFields.html +1 -1
- package/docs/types/openapi.OpenapiAllTypes.html +1 -1
- package/docs/types/openapi.OpenapiFormats.html +1 -1
- package/docs/types/openapi.OpenapiNumberFormats.html +1 -1
- package/docs/types/openapi.OpenapiPrimitiveBaseTypes.html +1 -1
- package/docs/types/openapi.OpenapiPrimitiveTypes.html +1 -1
- package/docs/types/openapi.OpenapiSchemaArray.html +1 -1
- package/docs/types/openapi.OpenapiSchemaArrayShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaBase.html +1 -1
- package/docs/types/openapi.OpenapiSchemaBody.html +1 -1
- package/docs/types/openapi.OpenapiSchemaBodyShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaCommonFields.html +1 -1
- package/docs/types/openapi.OpenapiSchemaExpressionAllOf.html +2 -2
- package/docs/types/openapi.OpenapiSchemaExpressionAnyOf.html +2 -2
- package/docs/types/openapi.OpenapiSchemaExpressionOneOf.html +2 -2
- package/docs/types/openapi.OpenapiSchemaExpressionRef.html +2 -2
- package/docs/types/openapi.OpenapiSchemaExpressionRefSchemaShorthand.html +2 -2
- package/docs/types/openapi.OpenapiSchemaInteger.html +1 -1
- package/docs/types/openapi.OpenapiSchemaNull.html +2 -2
- package/docs/types/openapi.OpenapiSchemaNumber.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObject.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectAllOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectAllOfShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectAnyOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectAnyOfShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectBase.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectBaseShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectOneOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectOneOfShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaPrimitiveGeneric.html +1 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionAllOf.html +2 -2
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionAnyOf.html +2 -2
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionOneOf.html +2 -2
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializableRef.html +2 -2
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializerRef.html +2 -2
- 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 +1 -1
- package/docs/types/types.Camelized.html +1 -1
- package/docs/types/types.ClockTimeObject.html +1 -1
- 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 +2 -2
- 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 +1 -1
- package/docs/types/types.EncryptAlgorithm.html +1 -1
- package/docs/types/types.HasManyStatement.html +1 -1
- package/docs/types/types.HasOneStatement.html +1 -1
- package/docs/types/types.Hyphenized.html +1 -1
- package/docs/types/types.Pascalized.html +1 -1
- package/docs/types/types.PrimaryKeyType.html +1 -1
- package/docs/types/types.RoundingPrecision.html +1 -1
- package/docs/types/types.SerializerCasing.html +1 -1
- package/docs/types/types.SimpleObjectSerializerType.html +1 -1
- package/docs/types/types.Snakeified.html +1 -1
- package/docs/types/types.StrictInterface.html +1 -1
- package/docs/types/types.UpdateableAssociationProperties.html +1 -1
- package/docs/types/types.UpdateableProperties.html +1 -1
- package/docs/types/types.ValidationType.html +1 -1
- package/docs/types/types.ViewModel.html +2 -2
- 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.html +1 -1
- package/docs/variables/openapi.openapiShorthandPrimitiveTypes.html +1 -1
- package/docs/variables/system.DreamAppAllowedPackageManagersEnumValues.html +1 -1
- package/docs/variables/system.primaryKeyTypes.html +1 -1
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ClockTime | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@rvoh/dream</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/index.html">index</a></li><li><a href="" aria-current="page">ClockTime</a></li></ul><h1>Class ClockTime</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ClockTime represents a time of day without timezone information.</p>
|
|
2
2
|
<p>Useful for representing TIME WITHOUT TIME ZONE fields from a Postgres database.
|
|
3
3
|
All output methods strip timezone offset information.</p>
|
|
4
|
-
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="
|
|
4
|
+
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="4341"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">default</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ClockTime</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/ClockTime.ts#L12">src/utils/datetime/ClockTime.ts:12</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
5
5
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#_tosql" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>to<wbr/>SQL?</span></a>
|
|
6
6
|
<a href="#datetime" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>date<wbr/>Time</span></a>
|
|
7
7
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#hour" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hour</span></a>
|
|
@@ -37,32 +37,32 @@ All output methods strip timezone offset information.</p>
|
|
|
37
37
|
<a href="#min" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>min</span></a>
|
|
38
38
|
<a href="#now" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>now</span></a>
|
|
39
39
|
<a href="#wrapluxonerror-2" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wrap<wbr/>Luxon<wbr/>Error</span></a>
|
|
40
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorclocktime"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ClockTime</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">?:</span> <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a><a href="#constructorclocktime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><code class="tsd-tag">Internal</code><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">source</span>: <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a></h4><aside class="tsd-sources"><p>Inherited from BaseClockTime.constructor</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
40
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorclocktime"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ClockTime</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">?:</span> <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a><a href="#constructorclocktime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><code class="tsd-tag">Internal</code><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">source</span>: <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a></h4><aside class="tsd-sources"><p>Inherited from BaseClockTime.constructor</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L18">src/utils/datetime/BaseClockTime.ts:18</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="_tosql"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Optional</code><span>_<wbr/>to<wbr/>SQL</span><a href="#_tosql" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_toSQL</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseClockTime._toSQL</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L13">src/utils/datetime/BaseClockTime.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="datetime"><code class="tsd-tag">Protected</code><span>date<wbr/>Time</span><a href="#datetime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dateTime</span><span class="tsd-signature-symbol">:</span> <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.dateTime</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L12">src/utils/datetime/BaseClockTime.ts:12</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hour"><span>hour</span><a href="#hour" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="hourhour"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">hour</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the hour (0-23).</p>
|
|
41
41
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The hour number</p>
|
|
42
42
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1"> }).</span><span class="hl-4">hour</span><span class="hl-1"> </span><span class="hl-7">// 14</span>
|
|
43
43
|
</code><button type="button">Copy</button></pre>
|
|
44
44
|
|
|
45
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.hour</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
45
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.hour</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L224">src/utils/datetime/BaseClockTime.ts:224</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="microsecond"><span>microsecond</span><a href="#microsecond" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="microsecondmicrosecond"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">microsecond</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the microsecond (0-999).</p>
|
|
46
46
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The microsecond number</p>
|
|
47
47
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'14:30:45.123456'</span><span class="hl-1">).</span><span class="hl-4">microsecond</span><span class="hl-1"> </span><span class="hl-7">// 456</span>
|
|
48
48
|
</code><button type="button">Copy</button></pre>
|
|
49
49
|
|
|
50
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.microsecond</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
50
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.microsecond</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L272">src/utils/datetime/BaseClockTime.ts:272</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="millisecond"><span>millisecond</span><a href="#millisecond" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="millisecondmillisecond"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">millisecond</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the millisecond (0-999).</p>
|
|
51
51
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The millisecond number</p>
|
|
52
52
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-4">millisecond:</span><span class="hl-1"> </span><span class="hl-8">123</span><span class="hl-1"> }).</span><span class="hl-4">millisecond</span><span class="hl-1"> </span><span class="hl-7">// 123</span>
|
|
53
53
|
</code><button type="button">Copy</button></pre>
|
|
54
54
|
|
|
55
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.millisecond</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
55
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.millisecond</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L260">src/utils/datetime/BaseClockTime.ts:260</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="minute"><span>minute</span><a href="#minute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="minuteminute"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">minute</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the minute (0-59).</p>
|
|
56
56
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The minute number</p>
|
|
57
57
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-3">Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1"> }).</span><span class="hl-4">minute</span><span class="hl-1"> </span><span class="hl-7">// 30</span>
|
|
58
58
|
</code><button type="button">Copy</button></pre>
|
|
59
59
|
|
|
60
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.minute</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
60
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.minute</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L236">src/utils/datetime/BaseClockTime.ts:236</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="second"><span>second</span><a href="#second" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="secondsecond"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">second</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the second (0-59).</p>
|
|
61
61
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The second number</p>
|
|
62
62
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-4">second:</span><span class="hl-1"> </span><span class="hl-8">45</span><span class="hl-1"> }).</span><span class="hl-4">second</span><span class="hl-1"> </span><span class="hl-7">// 45</span>
|
|
63
63
|
</code><button type="button">Copy</button></pre>
|
|
64
64
|
|
|
65
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.second</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
65
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.second</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L248">src/utils/datetime/BaseClockTime.ts:248</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="diff"><span>diff</span><a href="#diff" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="diff-1"><span class="tsd-kind-call-signature">diff</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#difft">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#diffu">U</a> <span class="tsd-signature-keyword">extends</span><br/> <span class="tsd-signature-type">ClockTimeDurationUnit</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">ClockTimeDurationUnit</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#difft">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">other</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#difft">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">unit</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#diffu">U</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ClockTimeDiffResult</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#diffu">U</a><span class="tsd-signature-symbol">></span><a href="#diff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the difference between this ClockTime and another in the specified unit(s).
|
|
66
66
|
Supports microsecond precision when 'microseconds' is included in the unit parameter.</p>
|
|
67
67
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="difft"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</span></span></li><li><span id="diffu"><span class="tsd-kind-type-parameter">U</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">ClockTimeDurationUnit</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">ClockTimeDurationUnit</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span> = <span class="tsd-signature-type">undefined</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#difft">T</a></span></li><li><span><span class="tsd-kind-parameter">other</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#difft">T</a></span><div class="tsd-comment tsd-typography"><p>ClockTime to compare against</p>
|
|
68
68
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">unit</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#diffu">U</a></span><div class="tsd-comment tsd-typography"><p>Unit or units to return (hours, minutes, seconds, milliseconds, microseconds)</p>
|
|
@@ -70,56 +70,56 @@ Supports microsecond precision when 'microseconds' is included in the unit param
|
|
|
70
70
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-5">Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">t1</span><span class="hl-1"> = </span><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</span><span class="hl-1">({ </span><span class="hl-4">hour:</span><span class="hl-1"> </span><span class="hl-8">15</span><span class="hl-1">, </span><span class="hl-4">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1"> })</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">t2</span><span class="hl-1"> = </span><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">0</span><span class="hl-1"> })</span><br/><span class="hl-4">t1</span><span class="hl-1">.</span><span class="hl-5">diff</span><span class="hl-1">(</span><span class="hl-4">t2</span><span class="hl-1">, </span><span class="hl-6">'hours'</span><span class="hl-1">) </span><span class="hl-7">// { hours: 1 }</span><br/><span class="hl-4">t1</span><span class="hl-1">.</span><span class="hl-5">diff</span><span class="hl-1">(</span><span class="hl-4">t2</span><span class="hl-1">, [</span><span class="hl-6">'hours'</span><span class="hl-1">, </span><span class="hl-6">'minutes'</span><span class="hl-1">]) </span><span class="hl-7">// { hours: 1, minutes: 30 }</span><br/><span class="hl-4">t1</span><span class="hl-1">.</span><span class="hl-5">diff</span><span class="hl-1">(</span><span class="hl-4">t2</span><span class="hl-1">) </span><span class="hl-7">// { hours: 1, minutes: 30, seconds: 0, milliseconds: 0, microseconds: 0 }</span>
|
|
71
71
|
</code><button type="button">Copy</button></pre>
|
|
72
72
|
|
|
73
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.diff</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
73
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.diff</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L386">src/utils/datetime/BaseClockTime.ts:386</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="endof"><span>end<wbr/>Of</span><a href="#endof" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="endof-1"><span class="tsd-kind-call-signature">endOf</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#endoft">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#endoft">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">period</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ClockTimeUnit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#endoft">T</a><a href="#endof-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new ClockTime at the end of the given period.</p>
|
|
74
74
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="endoft"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</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">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#endoft">T</a></span></li><li><span><span class="tsd-kind-parameter">period</span>: <span class="tsd-signature-type">ClockTimeUnit</span></span><div class="tsd-comment tsd-typography"><p>Unit to extend to end of ('hour', 'minute', or 'second')</p>
|
|
75
75
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#endoft">T</a></h4><p>A ClockTime at the end of the period</p>
|
|
76
76
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-6">Example<a href="#example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1"> }).</span><span class="hl-5">endOf</span><span class="hl-1">(</span><span class="hl-6">'hour'</span><span class="hl-1">)</span><br/><span class="hl-7">// hour: 14, minute: 59, second: 59, millisecond: 999</span>
|
|
77
77
|
</code><button type="button">Copy</button></pre>
|
|
78
78
|
|
|
79
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.endOf</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
79
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.endOf</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L95">src/utils/datetime/BaseClockTime.ts:95</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="equals"><span>equals</span><a href="#equals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="equals-1"><span class="tsd-kind-call-signature">equals</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#equalst">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#equalst">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">otherClockTime</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#equalst">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#equals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if this ClockTime equals another ClockTime.</p>
|
|
80
80
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="equalst"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</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">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#equalst">T</a></span></li><li><span><span class="tsd-kind-parameter">otherClockTime</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#equalst">T</a></span><div class="tsd-comment tsd-typography"><p>ClockTime to compare</p>
|
|
81
81
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if times are equal</p>
|
|
82
82
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-7">Example<a href="#example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">t1</span><span class="hl-1"> = </span><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1"> })</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">t2</span><span class="hl-1"> = </span><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1"> })</span><br/><span class="hl-4">t1</span><span class="hl-1">.</span><span class="hl-5">equals</span><span class="hl-1">(</span><span class="hl-4">t2</span><span class="hl-1">) </span><span class="hl-7">// true</span>
|
|
83
83
|
</code><button type="button">Copy</button></pre>
|
|
84
84
|
|
|
85
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.equals</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
85
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.equals</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L50">src/utils/datetime/BaseClockTime.ts:50</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hassame"><span>has<wbr/>Same</span><a href="#hassame" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="hassame-1"><span class="tsd-kind-call-signature">hasSame</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#hassamet">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#hassamet">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">otherClockTime</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#hassamet">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">period</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ClockTimeUnit</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#hassame-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if this and other are in the same unit of time.</p>
|
|
86
86
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="hassamet"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</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">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#hassamet">T</a></span></li><li><span><span class="tsd-kind-parameter">otherClockTime</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#hassamet">T</a></span><div class="tsd-comment tsd-typography"><p>ClockTime to compare against</p>
|
|
87
87
|
</div></li><li><span><span class="tsd-kind-parameter">period</span>: <span class="tsd-signature-type">ClockTimeUnit</span></span><div class="tsd-comment tsd-typography"><p>Unit to check ('hour', 'minute', or 'second')</p>
|
|
88
88
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if same period</p>
|
|
89
89
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-8">Example<a href="#example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">t1</span><span class="hl-1"> = </span><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1"> })</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">t2</span><span class="hl-1"> = </span><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">45</span><span class="hl-1"> })</span><br/><span class="hl-4">t1</span><span class="hl-1">.</span><span class="hl-5">hasSame</span><span class="hl-1">(</span><span class="hl-4">t2</span><span class="hl-1">, </span><span class="hl-6">'hour'</span><span class="hl-1">) </span><span class="hl-7">// true</span><br/><span class="hl-4">t1</span><span class="hl-1">.</span><span class="hl-5">hasSame</span><span class="hl-1">(</span><span class="hl-4">t2</span><span class="hl-1">, </span><span class="hl-6">'minute'</span><span class="hl-1">) </span><span class="hl-7">// false</span>
|
|
90
90
|
</code><button type="button">Copy</button></pre>
|
|
91
91
|
|
|
92
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.hasSame</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
92
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.hasSame</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L351">src/utils/datetime/BaseClockTime.ts:351</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="minus"><span>minus</span><a href="#minus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="minus-1"><span class="tsd-kind-call-signature">minus</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#minust">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#minust">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">duration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ClockTimeDurationLikeObject</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#minust">T</a><a href="#minus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new ClockTime/ClockTimeTz with the given duration subtracted.</p>
|
|
93
93
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="minust"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</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">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#minust">T</a></span></li><li><span><span class="tsd-kind-parameter">duration</span>: <span class="tsd-signature-type">ClockTimeDurationLikeObject</span></span><div class="tsd-comment tsd-typography"><p>Duration to subtract (object with hours, minutes, seconds, etc.)</p>
|
|
94
94
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#minust">T</a></h4><p>A new ClockTime/ClockTimeTz</p>
|
|
95
95
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-9">Example<a href="#example-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</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><span class="hl-4">minutes:</span><span class="hl-1"> </span><span class="hl-8">15</span><span class="hl-1"> })</span><br/><span class="hl-7">// hour: 12, minute: 15</span>
|
|
96
96
|
</code><button type="button">Copy</button></pre>
|
|
97
97
|
|
|
98
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.minus</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
98
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.minus</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L334">src/utils/datetime/BaseClockTime.ts:334</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="plus"><span>plus</span><a href="#plus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="plus-1"><span class="tsd-kind-call-signature">plus</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#plust">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#plust">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">duration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ClockTimeDurationLikeObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#plust">T</a><a href="#plus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new ClockTime/ClockTimeTz with the given duration added.</p>
|
|
99
99
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="plust"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</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">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#plust">T</a></span></li><li><span><span class="tsd-kind-parameter">duration</span>: <span class="tsd-signature-type">ClockTimeDurationLikeObject</span></span><div class="tsd-comment tsd-typography"><p>Duration to add (object with hours, minutes, seconds, etc.)</p>
|
|
100
100
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#plust">T</a></h4><p>A new ClockTime/ClockTimeTz</p>
|
|
101
101
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-10">Example<a href="#example-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</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><span class="hl-4">minutes:</span><span class="hl-1"> </span><span class="hl-8">15</span><span class="hl-1"> })</span><br/><span class="hl-7">// hour: 16, minute: 45</span>
|
|
102
102
|
</code><button type="button">Copy</button></pre>
|
|
103
103
|
|
|
104
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.plus</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
104
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.plus</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L320">src/utils/datetime/BaseClockTime.ts:320</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="set"><span>set</span><a href="#set" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="set-1"><span class="tsd-kind-call-signature">set</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#sett">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#sett">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">values</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../types/types.ClockTimeObject.html" class="tsd-signature-type tsd-kind-type-alias">ClockTimeObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#sett">T</a><a href="#set-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new ClockTime with the given time units set.</p>
|
|
105
105
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="sett"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</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">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#sett">T</a></span></li><li><span><span class="tsd-kind-parameter">values</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../types/types.ClockTimeObject.html" class="tsd-signature-type tsd-kind-type-alias">ClockTimeObject</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Object with time units to set (hour, minute, second, millisecond, microsecond)</p>
|
|
106
106
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#sett">T</a></h4><p>A new ClockTime</p>
|
|
107
107
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>When the underlying DateTime operation fails</p>
|
|
108
108
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-11">Example<a href="#example-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</span><span class="hl-1">({ </span><span class="hl-4">hour:</span><span class="hl-1"> </span><span class="hl-8">10</span><span class="hl-1">, </span><span class="hl-4">minute:</span><span class="hl-1"> </span><span class="hl-8">30</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><br/><span class="hl-7">// hour: 14, minute: 30, microsecond: 500</span>
|
|
109
109
|
</code><button type="button">Copy</button></pre>
|
|
110
110
|
|
|
111
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.set</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
111
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.set</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L65">src/utils/datetime/BaseClockTime.ts:65</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="startof"><span>start<wbr/>Of</span><a href="#startof" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="startof-1"><span class="tsd-kind-call-signature">startOf</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#startoft">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#startoft">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">period</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ClockTimeUnit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#startoft">T</a><a href="#startof-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new ClockTime at the start of the given period.</p>
|
|
112
112
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="startoft"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">BaseClockTime</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">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#startoft">T</a></span></li><li><span><span class="tsd-kind-parameter">period</span>: <span class="tsd-signature-type">ClockTimeUnit</span></span><div class="tsd-comment tsd-typography"><p>Unit to truncate to ('hour', 'minute', or 'second')</p>
|
|
113
113
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#startoft">T</a></h4><p>A ClockTime at the start of the period</p>
|
|
114
114
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-12">Example<a href="#example-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-4">second:</span><span class="hl-1"> </span><span class="hl-8">45</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><br/><span class="hl-7">// hour: 14, minute: 0, second: 0</span>
|
|
115
115
|
</code><button type="button">Copy</button></pre>
|
|
116
116
|
|
|
117
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.startOf</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
117
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.startOf</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L81">src/utils/datetime/BaseClockTime.ts:81</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="todatetime"><span>to<wbr/>Date<wbr/>Time</span><a href="#todatetime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="todatetime-1"><span class="tsd-kind-call-signature">toDateTime</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="#todatetime-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the underlying DateTime instance.</p>
|
|
118
118
|
</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 this time with zone</p>
|
|
119
119
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-13">Example<a href="#example-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">dt</span><span class="hl-1"> = </span><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toDateTime</span><span class="hl-1">()</span>
|
|
120
120
|
</code><button type="button">Copy</button></pre>
|
|
121
121
|
|
|
122
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.toDateTime</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
122
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.toDateTime</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L212">src/utils/datetime/BaseClockTime.ts:212</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="toiso"><span>to<wbr/>ISO</span><a href="#toiso" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="toiso-1"><span class="tsd-kind-call-signature">toISO</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">format</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"basic"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"extended"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">suppressMilliseconds</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">suppressSeconds</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><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#toiso-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the time as an ISO 8601 time string without timezone offset.
|
|
123
123
|
Alias for <code>toISOTime()</code>.</p>
|
|
124
124
|
</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-symbol">{</span><br/> <span class="tsd-kind-property">format</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"basic"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"extended"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">suppressMilliseconds</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">suppressSeconds</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 format options</p>
|
|
125
125
|
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">format</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"basic"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"extended"</span></h5><div class="tsd-comment tsd-typography"><p>Format variant: 'basic' (compact) or 'extended' (default, with colons)</p>
|
|
@@ -129,7 +129,7 @@ Alias for <code>toISOTime()</code>.</p>
|
|
|
129
129
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-14">Example<a href="#example-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-4">second:</span><span class="hl-1"> </span><span class="hl-8">45</span><span class="hl-1"> }).</span><span class="hl-5">toISO</span><span class="hl-1">() </span><span class="hl-7">// '14:30:45.000000'</span><br/><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'14:30:45-05:00'</span><span class="hl-1">).</span><span class="hl-5">toISO</span><span class="hl-1">() </span><span class="hl-7">// '14:30:45.000000' (timezone stripped)</span>
|
|
130
130
|
</code><button type="button">Copy</button></pre>
|
|
131
131
|
|
|
132
|
-
</div></div><aside class="tsd-sources"><p>Overrides BaseClockTime.toISO</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
132
|
+
</div></div><aside class="tsd-sources"><p>Overrides BaseClockTime.toISO</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/ClockTime.ts#L138">src/utils/datetime/ClockTime.ts:138</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="toisotime"><span>to<wbr/>ISO<wbr/>Time</span><a href="#toisotime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="toisotime-1"><span class="tsd-kind-call-signature">toISOTime</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">format</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"basic"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"extended"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">suppressMilliseconds</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">suppressSeconds</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><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#toisotime-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the time as an ISO 8601 time string with timezone offset.
|
|
133
133
|
Alias for <code>toISO()</code>.</p>
|
|
134
134
|
</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-symbol">{</span><br/> <span class="tsd-kind-property">format</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"basic"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"extended"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">suppressMilliseconds</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">suppressSeconds</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 format options</p>
|
|
135
135
|
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">format</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"basic"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"extended"</span></h5><div class="tsd-comment tsd-typography"><p>Format variant: 'basic' (compact) or 'extended' (default, with colons)</p>
|
|
@@ -139,12 +139,12 @@ Alias for <code>toISO()</code>.</p>
|
|
|
139
139
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-15">Example<a href="#example-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-4">second:</span><span class="hl-1"> </span><span class="hl-8">45</span><span class="hl-1"> }).</span><span class="hl-5">toISOTime</span><span class="hl-1">() </span><span class="hl-7">// '14:30:45.000000+00:00'</span><br/><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'14:30:45-05:00'</span><span class="hl-1">).</span><span class="hl-5">toISOTime</span><span class="hl-1">() </span><span class="hl-7">// '14:30:45.000000-05:00'</span>
|
|
140
140
|
</code><button type="button">Copy</button></pre>
|
|
141
141
|
|
|
142
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.toISOTime</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
142
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.toISOTime</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L142">src/utils/datetime/BaseClockTime.ts:142</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tojson"><span>to<wbr/>JSON</span><a href="#tojson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="tojson-1"><span class="tsd-kind-call-signature">toJSON</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tojson-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the time as an ISO time string for JSON serialization.</p>
|
|
143
143
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>ISO time string</p>
|
|
144
144
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-16">Example<a href="#example-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-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">ClockTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">() })</span>
|
|
145
145
|
</code><button type="button">Copy</button></pre>
|
|
146
146
|
|
|
147
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.toJSON</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
147
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.toJSON</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L158">src/utils/datetime/BaseClockTime.ts:158</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tolocalestring"><span>to<wbr/>Locale<wbr/>String</span><a href="#tolocalestring" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="tolocalestring-1"><span class="tsd-kind-call-signature">toLocaleString</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formatOpts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DateTimeFormatOptions</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tolocalestring-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a localized string representation of the time.</p>
|
|
148
148
|
</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>
|
|
149
149
|
</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>
|
|
150
150
|
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale string (e.g., 'en-US', 'fr-FR')</p>
|
|
@@ -154,28 +154,28 @@ Alias for <code>toISO()</code>.</p>
|
|
|
154
154
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-17">Example<a href="#example-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</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><br/><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</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">hour:</span><span class="hl-1"> </span><span class="hl-6">'numeric'</span><span class="hl-1">, </span><span class="hl-4">minute:</span><span class="hl-1"> </span><span class="hl-6">'2-digit'</span><span class="hl-1"> })</span><br/><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</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">hour:</span><span class="hl-1"> </span><span class="hl-6">'2-digit'</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>
|
|
155
155
|
</code><button type="button">Copy</button></pre>
|
|
156
156
|
|
|
157
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.toLocaleString</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
157
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.toLocaleString</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L188">src/utils/datetime/BaseClockTime.ts:188</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tosql"><span>to<wbr/>SQL</span><a href="#tosql" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tosql-1"><span class="tsd-kind-call-signature">toSQL</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tosql-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the SQL time string without timezone offset.
|
|
158
158
|
Result is memoized for performance.</p>
|
|
159
159
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>SQL time string without timezone offset (e.g., '14:30:45.123456')</p>
|
|
160
160
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-18">Example<a href="#example-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'14:30:45'</span><span class="hl-1">).</span><span class="hl-5">toSQL</span><span class="hl-1">() </span><span class="hl-7">// '14:30:45.000000'</span>
|
|
161
161
|
</code><button type="button">Copy</button></pre>
|
|
162
162
|
|
|
163
|
-
</div></div><aside class="tsd-sources"><p>Overrides BaseClockTime.toSQL</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
163
|
+
</div></div><aside class="tsd-sources"><p>Overrides BaseClockTime.toSQL</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/ClockTime.ts#L156">src/utils/datetime/ClockTime.ts:156</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tosqltime"><span>to<wbr/>SQL<wbr/>Time</span><a href="#tosqltime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="tosqltime-1"><span class="tsd-kind-call-signature">toSQLTime</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tosqltime-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Alias of <code>toSQL</code>.
|
|
164
164
|
Returns the SQL time string without timezone offset.
|
|
165
165
|
Result is memoized for performance.</p>
|
|
166
166
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>SQL time string without timezone offset (e.g., '14:30:45.123456')</p>
|
|
167
|
-
<aside class="tsd-sources"><p>Inherited from BaseClockTime.toSQLTime</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
167
|
+
<aside class="tsd-sources"><p>Inherited from BaseClockTime.toSQLTime</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L169">src/utils/datetime/BaseClockTime.ts:169</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tostring"><span>to<wbr/>String</span><a href="#tostring" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="tostring-1"><span class="tsd-kind-call-signature">toString</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tostring-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the time as an ISO string (same as toISO).</p>
|
|
168
168
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>ISO datetime string</p>
|
|
169
169
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-19">Example<a href="#example-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">().</span><span class="hl-5">toString</span><span class="hl-1">()</span>
|
|
170
170
|
</code><button type="button">Copy</button></pre>
|
|
171
171
|
|
|
172
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.toString</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
172
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.toString</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L200">src/utils/datetime/BaseClockTime.ts:200</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="valueof"><span>value<wbr/>Of</span><a href="#valueof" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="valueof-1"><span class="tsd-kind-call-signature">valueOf</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#valueof-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from BaseClockTime.valueOf</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L108">src/utils/datetime/BaseClockTime.ts:108</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="wrapluxonerror"><code class="tsd-tag">Protected</code><span>wrap<wbr/>Luxon<wbr/>Error</span><a href="#wrapluxonerror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected"><li class=""><div class="tsd-signature tsd-anchor-link" id="wrapluxonerror-1"><span class="tsd-kind-call-signature">wrapLuxonError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort">T</a><a href="#wrapluxonerror-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="wrapluxonerrort"><span class="tsd-kind-type-parameter">T</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">fn</span>: <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort">T</a></h4><aside class="tsd-sources"><p>Overrides BaseClockTime.wrapLuxonError</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/ClockTime.ts#L171">src/utils/datetime/ClockTime.ts:171</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="fromdatetime"><code class="tsd-tag">Static</code><span>from<wbr/>Date<wbr/>Time</span><a href="#fromdatetime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="fromdatetime-1"><span class="tsd-kind-call-signature">fromDateTime</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#fromdatetimet">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">default</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#fromdatetimet">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">dateTime</span><span class="tsd-signature-symbol">:</span> <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#fromdatetimet">T</a><span class="tsd-signature-symbol">></span><a href="#fromdatetime-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a ClockTimeTz from a DateTime instance.</p>
|
|
173
173
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="fromdatetimet"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">default</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">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#fromdatetimet">T</a></span></li><li><span><span class="tsd-kind-parameter">dateTime</span>: <a href="index.DateTime.html" class="tsd-signature-type tsd-kind-class">DateTime</a></span><div class="tsd-comment tsd-typography"><p>A DateTime instance</p>
|
|
174
174
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#fromdatetimet">T</a><span class="tsd-signature-symbol">></span></h4><p>A ClockTimeTz for the time portion of the DateTime</p>
|
|
175
175
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-20">Example<a href="#example-20" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</span><span class="hl-1">.</span><span class="hl-5">fromDateTime</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>
|
|
176
176
|
</code><button type="button">Copy</button></pre>
|
|
177
177
|
|
|
178
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.fromDateTime</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
178
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.fromDateTime</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L35">src/utils/datetime/BaseClockTime.ts:35</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromformat"><code class="tsd-tag">Static</code><span>from<wbr/>Format</span><a href="#fromformat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromformat-1"><span class="tsd-kind-call-signature">fromFormat</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">format</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a><a href="#fromformat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a ClockTime from a custom format string.
|
|
179
179
|
Uses Luxon format tokens (e.g., 'HH:mm:ss', 'hh:mm a').</p>
|
|
180
180
|
</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>
|
|
181
181
|
</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</p>
|
|
@@ -188,7 +188,7 @@ Uses Luxon format tokens (e.g., 'HH:mm:ss', 'hh:mm a').</p>
|
|
|
188
188
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-21">Example<a href="#example-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromFormat</span><span class="hl-1">(</span><span class="hl-6">'14:30:45'</span><span class="hl-1">, </span><span class="hl-6">'HH:mm:ss'</span><span class="hl-1">)</span><br/><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromFormat</span><span class="hl-1">(</span><span class="hl-6">'2:30 PM'</span><span class="hl-1">, </span><span class="hl-6">'h:mm a'</span><span class="hl-1">)</span>
|
|
189
189
|
</code><button type="button">Copy</button></pre>
|
|
190
190
|
|
|
191
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
191
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/ClockTime.ts#L78">src/utils/datetime/ClockTime.ts:78</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromiso"><code class="tsd-tag">Static</code><span>from<wbr/>ISO</span><a href="#fromiso" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromiso-1"><span class="tsd-kind-call-signature">fromISO</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a><a href="#fromiso-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a ClockTime from an ISO 8601 time string.
|
|
192
192
|
Preserves the time values as-is, regardless of any timezone info in the string.</p>
|
|
193
193
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>ISO time string (e.g., '14:30:45.123456')</p>
|
|
194
194
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a></h4><p>A ClockTime for the given time</p>
|
|
@@ -196,13 +196,13 @@ Preserves the time values as-is, regardless of any timezone info in the string.<
|
|
|
196
196
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-22">Example<a href="#example-22" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'14:30:45.123456'</span><span class="hl-1">) </span><span class="hl-7">// stores 14:30:45.123456</span><br/><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromISO</span><span class="hl-1">(</span><span class="hl-6">'14:30:45.123456-05:00'</span><span class="hl-1">) </span><span class="hl-7">// stores 14:30:45.123456 (timezone ignored)</span>
|
|
197
197
|
</code><button type="button">Copy</button></pre>
|
|
198
198
|
|
|
199
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
199
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/ClockTime.ts#L39">src/utils/datetime/ClockTime.ts:39</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromjsdate"><code class="tsd-tag">Static</code><span>from<wbr/>JS<wbr/>Date</span><a href="#fromjsdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromjsdate-1"><span class="tsd-kind-call-signature">fromJSDate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">javascriptDate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a><a href="#fromjsdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a ClockTime from a JavaScript Date.</p>
|
|
200
200
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">javascriptDate</span>: <span class="tsd-signature-type">Date</span></span><div class="tsd-comment tsd-typography"><p>A JavaScript Date instance</p>
|
|
201
201
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a></h4><p>A ClockTime for the time portion</p>
|
|
202
202
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-23">Example<a href="#example-23" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</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>
|
|
203
203
|
</code><button type="button">Copy</button></pre>
|
|
204
204
|
|
|
205
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
205
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/ClockTime.ts#L22">src/utils/datetime/ClockTime.ts:22</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromobject"><code class="tsd-tag">Static</code><span>from<wbr/>Object</span><a href="#fromobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromobject-1"><span class="tsd-kind-call-signature">fromObject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../types/types.ClockTimeObject.html" class="tsd-signature-type tsd-kind-type-alias">ClockTimeObject</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LocaleOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a><a href="#fromobject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a ClockTime from an object with time units.</p>
|
|
206
206
|
</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><a href="../types/types.ClockTimeObject.html" class="tsd-signature-type tsd-kind-type-alias">ClockTimeObject</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Object with hour, minute, second, millisecond, microsecond properties</p>
|
|
207
207
|
</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 configuration</p>
|
|
208
208
|
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span>locale</span></h5><div class="tsd-comment tsd-typography"><p>Locale (e.g., 'en-US', 'fr-FR')</p>
|
|
@@ -213,7 +213,7 @@ Preserves the time values as-is, regardless of any timezone info in the string.<
|
|
|
213
213
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-24">Example<a href="#example-24" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1">, </span><span class="hl-4">second:</span><span class="hl-1"> </span><span class="hl-8">45</span><span class="hl-1"> })</span><br/><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromObject</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">minute:</span><span class="hl-1"> </span><span class="hl-8">30</span><span class="hl-1"> })</span>
|
|
214
214
|
</code><button type="button">Copy</button></pre>
|
|
215
215
|
|
|
216
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
216
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/ClockTime.ts#L98">src/utils/datetime/ClockTime.ts:98</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fromsql"><code class="tsd-tag">Static</code><span>from<wbr/>SQL</span><a href="#fromsql" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="fromsql-1"><span class="tsd-kind-call-signature">fromSQL</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a><a href="#fromsql-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a ClockTime from an SQL time string.
|
|
217
217
|
Preserves the time values as-is, regardless of any timezone info in the string.</p>
|
|
218
218
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>SQL time string (e.g., '14:30:45.123456')</p>
|
|
219
219
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a></h4><p>A ClockTime for the given time</p>
|
|
@@ -221,21 +221,21 @@ Preserves the time values as-is, regardless of any timezone info in the string.<
|
|
|
221
221
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-25">Example<a href="#example-25" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromSQL</span><span class="hl-1">(</span><span class="hl-6">'14:30:45.123456'</span><span class="hl-1">) </span><span class="hl-7">// stores 14:30:45.123456</span><br/><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">fromSQL</span><span class="hl-1">(</span><span class="hl-6">'14:30:45.123456+05:30'</span><span class="hl-1">) </span><span class="hl-7">// stores 14:30:45.123456 (timezone ignored)</span>
|
|
222
222
|
</code><button type="button">Copy</button></pre>
|
|
223
223
|
|
|
224
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
224
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/ClockTime.ts#L56">src/utils/datetime/ClockTime.ts:56</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="max"><code class="tsd-tag">Static</code><span>max</span><a href="#max" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="max-1"><span class="tsd-kind-call-signature">max</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#maxt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">default</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#maxt">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">clockTimes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#maxt">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#maxt">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><a href="#max-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the latest ClockTime/ClockTimeTz from the given arguments.</p>
|
|
225
225
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="maxt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">default</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">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#maxt">T</a></span></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">clockTimes</span>: <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#maxt">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>ClockTime/ClockTimeTz instances to compare</p>
|
|
226
226
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#maxt">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4><p>The latest ClockTime/ClockTimeTz</p>
|
|
227
227
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-26">Example<a href="#example-26" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</span><span class="hl-1">.</span><span class="hl-5">max</span><span class="hl-1">(</span><span class="hl-4">time1</span><span class="hl-1">, </span><span class="hl-4">time2</span><span class="hl-1">, </span><span class="hl-4">time3</span><span class="hl-1">)</span>
|
|
228
228
|
</code><button type="button">Copy</button></pre>
|
|
229
229
|
|
|
230
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.max</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
230
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.max</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L302">src/utils/datetime/BaseClockTime.ts:302</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="min"><code class="tsd-tag">Static</code><span>min</span><a href="#min" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="min-1"><span class="tsd-kind-call-signature">min</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#mint">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">default</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#mint">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">clockTimes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#mint">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#mint">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><a href="#min-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the earliest ClockTime/ClockTimeTz from the given arguments.</p>
|
|
231
231
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="mint"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">default</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">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#mint">T</a></span></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">clockTimes</span>: <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#mint">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>ClockTime/ClockTimeTz instances to compare</p>
|
|
232
232
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#mint">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4><p>The earliest ClockTime/ClockTimeTz</p>
|
|
233
233
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-27">Example<a href="#example-27" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">/</span><span class="hl-4">ClockTimeTz</span><span class="hl-1">.</span><span class="hl-5">min</span><span class="hl-1">(</span><span class="hl-4">time1</span><span class="hl-1">, </span><span class="hl-4">time2</span><span class="hl-1">, </span><span class="hl-4">time3</span><span class="hl-1">)</span>
|
|
234
234
|
</code><button type="button">Copy</button></pre>
|
|
235
235
|
|
|
236
|
-
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.min</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
236
|
+
</div></div><aside class="tsd-sources"><p>Inherited from BaseClockTime.min</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/BaseClockTime.ts#L285">src/utils/datetime/BaseClockTime.ts:285</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="now"><code class="tsd-tag">Static</code><span>now</span><a href="#now" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="now-1"><span class="tsd-kind-call-signature">now</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a><a href="#now-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a ClockTime for the current time.</p>
|
|
237
237
|
</div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ClockTime</a></h4><p>A ClockTime for now</p>
|
|
238
238
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-28">Example<a href="#example-28" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">ClockTime</span><span class="hl-1">.</span><span class="hl-5">now</span><span class="hl-1">()</span>
|
|
239
239
|
</code><button type="button">Copy</button></pre>
|
|
240
240
|
|
|
241
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/20d63fe34b3b5ed9b4b1952e7514c11cf44d78e5/src/utils/datetime/ClockTime.ts#L119">src/utils/datetime/ClockTime.ts:119</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="wrapluxonerror-2"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Static</code><span>wrap<wbr/>Luxon<wbr/>Error</span><a href="#wrapluxonerror-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected"><li class=""><div class="tsd-signature tsd-anchor-link" id="wrapluxonerror-3"><span class="tsd-kind-call-signature">wrapLuxonError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort-1">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort-1">T</a><a href="#wrapluxonerror-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="wrapluxonerrort-1"><span class="tsd-kind-type-parameter">T</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">fn</span>: <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort-1">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort-1">T</a></h4><aside class="tsd-sources"><p>Overrides BaseClockTime.wrapLuxonError</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/20d63fe34b3b5ed9b4b1952e7514c11cf44d78e5/src/utils/datetime/ClockTime.ts#L162">src/utils/datetime/ClockTime.ts:162</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#_tosql" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>to<wbr/>SQL</span></a><a href="#datetime" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>date<wbr/>Time</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#hour" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hour</span></a><a href="#microsecond" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>microsecond</span></a><a href="#millisecond" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>millisecond</span></a><a href="#minute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>minute</span></a><a href="#second" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>second</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#diff" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>diff</span></a><a href="#endof" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>end<wbr/>Of</span></a><a href="#equals" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>equals</span></a><a href="#hassame" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Same</span></a><a href="#minus" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>minus</span></a><a href="#plus" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>plus</span></a><a href="#set" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a><a href="#startof" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Of</span></a><a href="#todatetime" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Date<wbr/>Time</span></a><a href="#toiso"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>ISO</span></a><a href="#toisotime" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>ISO<wbr/>Time</span></a><a href="#tojson" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>JSON</span></a><a href="#tolocalestring" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Locale<wbr/>String</span></a><a href="#tosql"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>SQL</span></a><a href="#tosqltime" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>SQL<wbr/>Time</span></a><a href="#tostring" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#valueof" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>value<wbr/>Of</span></a><a href="#wrapluxonerror" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wrap<wbr/>Luxon<wbr/>Error</span></a><a href="#fromdatetime" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Date<wbr/>Time</span></a><a href="#fromformat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Format</span></a><a href="#fromiso"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>ISO</span></a><a href="#fromjsdate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>JS<wbr/>Date</span></a><a href="#fromobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Object</span></a><a href="#fromsql"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>SQL</span></a><a href="#max" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>max</span></a><a href="#min" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>min</span></a><a href="#now"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>now</span></a><a href="#wrapluxonerror-2" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wrap<wbr/>Luxon<wbr/>Error</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@rvoh/dream</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
241
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/ClockTime.ts#L119">src/utils/datetime/ClockTime.ts:119</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="wrapluxonerror-2"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Static</code><span>wrap<wbr/>Luxon<wbr/>Error</span><a href="#wrapluxonerror-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected"><li class=""><div class="tsd-signature tsd-anchor-link" id="wrapluxonerror-3"><span class="tsd-kind-call-signature">wrapLuxonError</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort-1">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort-1">T</a><a href="#wrapluxonerror-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="wrapluxonerrort-1"><span class="tsd-kind-type-parameter">T</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">fn</span>: <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort-1">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#wrapluxonerrort-1">T</a></h4><aside class="tsd-sources"><p>Overrides BaseClockTime.wrapLuxonError</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/53db2f0763b4f10bfb20911f61846371bd7ab36d/src/utils/datetime/ClockTime.ts#L162">src/utils/datetime/ClockTime.ts:162</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#_tosql" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>to<wbr/>SQL</span></a><a href="#datetime" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>date<wbr/>Time</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#hour" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hour</span></a><a href="#microsecond" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>microsecond</span></a><a href="#millisecond" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>millisecond</span></a><a href="#minute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>minute</span></a><a href="#second" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>second</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#diff" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>diff</span></a><a href="#endof" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>end<wbr/>Of</span></a><a href="#equals" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>equals</span></a><a href="#hassame" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Same</span></a><a href="#minus" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>minus</span></a><a href="#plus" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>plus</span></a><a href="#set" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a><a href="#startof" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Of</span></a><a href="#todatetime" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Date<wbr/>Time</span></a><a href="#toiso"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>ISO</span></a><a href="#toisotime" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>ISO<wbr/>Time</span></a><a href="#tojson" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>JSON</span></a><a href="#tolocalestring" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Locale<wbr/>String</span></a><a href="#tosql"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>SQL</span></a><a href="#tosqltime" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>SQL<wbr/>Time</span></a><a href="#tostring" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#valueof" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>value<wbr/>Of</span></a><a href="#wrapluxonerror" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wrap<wbr/>Luxon<wbr/>Error</span></a><a href="#fromdatetime" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Date<wbr/>Time</span></a><a href="#fromformat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Format</span></a><a href="#fromiso"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>ISO</span></a><a href="#fromjsdate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>JS<wbr/>Date</span></a><a href="#fromobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Object</span></a><a href="#fromsql"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>SQL</span></a><a href="#max" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>max</span></a><a href="#min" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>min</span></a><a href="#now"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>now</span></a><a href="#wrapluxonerror-2" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wrap<wbr/>Luxon<wbr/>Error</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@rvoh/dream</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|