@rvoh/dream 2.1.0 → 2.1.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/CHANGELOG.md +332 -0
- package/dist/cjs/src/helpers/cli/generateDreamContent.js +5 -4
- package/dist/cjs/src/helpers/cli/generateFactoryContent.js +3 -2
- package/dist/cjs/src/helpers/cli/generateMigrationContent.js +6 -4
- package/dist/cjs/src/helpers/cli/generateSerializerContent.js +1 -1
- package/dist/esm/src/helpers/cli/generateDreamContent.js +5 -4
- package/dist/esm/src/helpers/cli/generateFactoryContent.js +3 -2
- package/dist/esm/src/helpers/cli/generateMigrationContent.js +6 -4
- package/dist/esm/src/helpers/cli/generateSerializerContent.js +1 -1
- package/docs/classes/db.DreamMigrationHelpers.html +9 -9
- package/docs/classes/db.KyselyQueryDriver.html +30 -30
- package/docs/classes/db.PostgresQueryDriver.html +31 -31
- package/docs/classes/db.QueryDriverBase.html +29 -29
- 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.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 +2 -2
- package/docs/classes/index.Decorators.html +19 -19
- package/docs/classes/index.Dream.html +113 -113
- 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 +53 -53
- package/docs/classes/system.CliFileWriter.html +2 -2
- package/docs/classes/system.DreamBin.html +2 -2
- package/docs/classes/system.DreamCLI.html +5 -5
- package/docs/classes/system.DreamImporter.html +2 -2
- package/docs/classes/system.DreamLogos.html +2 -2
- package/docs/classes/system.DreamSerializerBuilder.html +8 -8
- package/docs/classes/system.ObjectSerializerBuilder.html +8 -8
- package/docs/classes/utils.Encrypt.html +2 -2
- package/docs/classes/utils.Range.html +2 -2
- package/docs/functions/db.closeAllDbConnections.html +1 -1
- package/docs/functions/db.dreamDbConnections.html +1 -1
- package/docs/functions/db.untypedDb.html +1 -1
- package/docs/functions/db.validateColumn.html +1 -1
- package/docs/functions/db.validateTable.html +1 -1
- package/docs/functions/errors.pgErrorType.html +1 -1
- package/docs/functions/index.DreamSerializer.html +1 -1
- package/docs/functions/index.ObjectSerializer.html +1 -1
- package/docs/functions/index.ReplicaSafe.html +1 -1
- package/docs/functions/index.STI.html +1 -1
- package/docs/functions/index.SoftDelete.html +1 -1
- package/docs/functions/utils.camelize.html +1 -1
- package/docs/functions/utils.capitalize.html +1 -1
- package/docs/functions/utils.cloneDeepSafe.html +1 -1
- package/docs/functions/utils.compact.html +1 -1
- package/docs/functions/utils.groupBy.html +1 -1
- package/docs/functions/utils.hyphenize.html +1 -1
- package/docs/functions/utils.intersection.html +1 -1
- package/docs/functions/utils.isEmpty.html +1 -1
- package/docs/functions/utils.normalizeUnicode.html +1 -1
- package/docs/functions/utils.pascalize.html +1 -1
- package/docs/functions/utils.percent.html +1 -1
- package/docs/functions/utils.range-1.html +1 -1
- package/docs/functions/utils.round.html +1 -1
- package/docs/functions/utils.sanitizeString.html +1 -1
- package/docs/functions/utils.snakeify.html +1 -1
- package/docs/functions/utils.sort.html +1 -1
- package/docs/functions/utils.sortBy.html +1 -1
- package/docs/functions/utils.sortObjectByKey.html +1 -1
- package/docs/functions/utils.sortObjectByValue.html +1 -1
- package/docs/functions/utils.uncapitalize.html +1 -1
- package/docs/functions/utils.uniq.html +1 -1
- package/docs/interfaces/openapi.OpenapiDescription.html +2 -2
- package/docs/interfaces/openapi.OpenapiSchemaProperties.html +1 -1
- package/docs/interfaces/openapi.OpenapiSchemaPropertiesShorthand.html +1 -1
- package/docs/interfaces/openapi.OpenapiTypeFieldObject.html +1 -1
- package/docs/interfaces/types.BelongsToStatement.html +2 -2
- package/docs/interfaces/types.DecoratorContext.html +2 -2
- package/docs/interfaces/types.DreamAppInitOptions.html +2 -2
- package/docs/interfaces/types.DreamAppOpts.html +2 -2
- package/docs/interfaces/types.EncryptOptions.html +2 -2
- package/docs/interfaces/types.InternalAnyTypedSerializerRendersMany.html +2 -2
- package/docs/interfaces/types.InternalAnyTypedSerializerRendersOne.html +2 -2
- package/docs/interfaces/types.SerializerRendererOpts.html +2 -2
- package/docs/modules/db.html +1 -1
- package/docs/modules/errors.html +1 -1
- package/docs/modules/index.html +1 -1
- package/docs/modules/openapi.html +1 -1
- package/docs/modules/system.html +1 -1
- package/docs/modules/types.html +1 -1
- package/docs/modules/utils.html +1 -1
- package/docs/types/index.DateTime.html +1 -1
- package/docs/types/openapi.CommonOpenapiSchemaObjectFields.html +1 -1
- package/docs/types/openapi.OpenapiAllTypes.html +1 -1
- package/docs/types/openapi.OpenapiFormats.html +1 -1
- package/docs/types/openapi.OpenapiNumberFormats.html +1 -1
- package/docs/types/openapi.OpenapiPrimitiveBaseTypes.html +1 -1
- package/docs/types/openapi.OpenapiPrimitiveTypes.html +1 -1
- package/docs/types/openapi.OpenapiSchemaArray.html +1 -1
- package/docs/types/openapi.OpenapiSchemaArrayShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaBase.html +1 -1
- package/docs/types/openapi.OpenapiSchemaBody.html +1 -1
- package/docs/types/openapi.OpenapiSchemaBodyShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaCommonFields.html +1 -1
- package/docs/types/openapi.OpenapiSchemaExpressionAllOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaExpressionAnyOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaExpressionOneOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaExpressionRef.html +1 -1
- package/docs/types/openapi.OpenapiSchemaExpressionRefSchemaShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaInteger.html +1 -1
- package/docs/types/openapi.OpenapiSchemaNull.html +1 -1
- package/docs/types/openapi.OpenapiSchemaNumber.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObject.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectAllOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectAllOfShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectAnyOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectAnyOfShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectBase.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectBaseShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectOneOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectOneOfShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaObjectShorthand.html +1 -1
- package/docs/types/openapi.OpenapiSchemaPrimitiveGeneric.html +1 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionAllOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionAnyOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionOneOf.html +1 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializableRef.html +1 -1
- package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializerRef.html +1 -1
- package/docs/types/openapi.OpenapiSchemaShorthandPrimitiveGeneric.html +1 -1
- package/docs/types/openapi.OpenapiSchemaString.html +1 -1
- package/docs/types/openapi.OpenapiShorthandAllTypes.html +1 -1
- package/docs/types/openapi.OpenapiShorthandPrimitiveBaseTypes.html +1 -1
- package/docs/types/openapi.OpenapiShorthandPrimitiveTypes.html +1 -1
- package/docs/types/openapi.OpenapiTypeField.html +1 -1
- package/docs/types/system.DreamAppAllowedPackageManagersEnum.html +1 -1
- package/docs/types/types.Camelized.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 +1 -1
- package/docs/types/types.DreamModelSerializerType.html +1 -1
- package/docs/types/types.DreamOrViewModelClassSerializerKey.html +1 -1
- package/docs/types/types.DreamOrViewModelSerializerKey.html +1 -1
- package/docs/types/types.DreamParamSafeAttributes.html +1 -1
- package/docs/types/types.DreamParamSafeColumnNames.html +1 -1
- package/docs/types/types.DreamSerializable.html +1 -1
- package/docs/types/types.DreamSerializableArray.html +1 -1
- package/docs/types/types.DreamSerializerKey.html +1 -1
- package/docs/types/types.DreamSerializers.html +1 -1
- package/docs/types/types.DreamVirtualColumns.html +1 -1
- package/docs/types/types.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.RoundingPrecision.html +1 -1
- package/docs/types/types.SerializerCasing.html +1 -1
- package/docs/types/types.SimpleObjectSerializerType.html +1 -1
- package/docs/types/types.Snakeified.html +1 -1
- package/docs/types/types.StrictInterface.html +1 -1
- package/docs/types/types.UpdateableAssociationProperties.html +1 -1
- package/docs/types/types.UpdateableProperties.html +1 -1
- package/docs/types/types.ValidationType.html +1 -1
- package/docs/types/types.ViewModel.html +1 -1
- package/docs/types/types.ViewModelClass.html +1 -1
- package/docs/types/types.WhereStatementForDream.html +1 -1
- package/docs/types/types.WhereStatementForDreamClass.html +1 -1
- package/docs/variables/index.DateTime-1.html +1 -1
- package/docs/variables/index.DreamConst.html +1 -1
- package/docs/variables/index.ops.html +1 -1
- package/docs/variables/openapi.openapiPrimitiveTypes-1.html +1 -1
- package/docs/variables/openapi.openapiShorthandPrimitiveTypes-1.html +1 -1
- package/docs/variables/system.DreamAppAllowedPackageManagersEnumValues.html +1 -1
- package/docs/variables/types.TRIGRAM_OPERATORS.html +1 -1
- package/docs/variables/types.primaryKeyTypes.html +1 -1
- package/package.json +7 -3
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Decorators | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@rvoh/dream</a></li><li><a href="../modules/index.html">index</a></li><li><a href="index.Decorators.html">Decorators</a></li></ul><h1>Class Decorators<TD, T></h1></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="TD" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TD</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">typeof </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a> = <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Decorators | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@rvoh/dream</a></li><li><a href="../modules/index.html">index</a></li><li><a href="index.Decorators.html">Decorators</a></li></ul><h1>Class Decorators<TD, T></h1></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="TD" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TD</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">typeof </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a> = <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L42">src/decorators/Decorators.ts:42</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="index.Decorators.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
2
2
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="index.Decorators.html#AfterCreate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>After<wbr/>Create</span></a>
|
|
3
3
|
<a href="index.Decorators.html#AfterCreateCommit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>After<wbr/>Create<wbr/>Commit</span></a>
|
|
4
4
|
<a href="index.Decorators.html#AfterDestroy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>After<wbr/>Destroy</span></a>
|
|
@@ -25,62 +25,62 @@
|
|
|
25
25
|
</code><button type="button">Copy</button></pre>
|
|
26
26
|
|
|
27
27
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">AfterHookOpts</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The AfterCreate decorator</p>
|
|
28
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
28
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L510">src/decorators/Decorators.ts:510</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="AfterCreateCommit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>After<wbr/>Create<wbr/>Commit</span><a href="#AfterCreateCommit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AfterCreateCommit.AfterCreateCommit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">After<wbr/>Create<wbr/>Commit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#AfterCreateCommit.AfterCreateCommit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>AfterCreateCommit decorator</p>
|
|
29
29
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">AfterCreateCommit</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">doSomething</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'hi!'</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
30
30
|
</code><button type="button">Copy</button></pre>
|
|
31
31
|
|
|
32
32
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">AfterHookOpts</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The AfterCreateCommit decorator</p>
|
|
33
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
33
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L528">src/decorators/Decorators.ts:528</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="AfterDestroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>After<wbr/>Destroy</span><a href="#AfterDestroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AfterDestroy.AfterDestroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">After<wbr/>Destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#AfterDestroy.AfterDestroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>AfterDestroy decorator</p>
|
|
34
34
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">AfterDestroy</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">doSomething</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'hi!'</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
35
35
|
</code><button type="button">Copy</button></pre>
|
|
36
36
|
|
|
37
37
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The AfterDestroy decorator</p>
|
|
38
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
38
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L623">src/decorators/Decorators.ts:623</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="AfterDestroyCommit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>After<wbr/>Destroy<wbr/>Commit</span><a href="#AfterDestroyCommit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AfterDestroyCommit.AfterDestroyCommit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">After<wbr/>Destroy<wbr/>Commit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#AfterDestroyCommit.AfterDestroyCommit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>AfterDestroyCommit decorator</p>
|
|
39
39
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">AfterDestroyCommit</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">doSomething</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'hi!'</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
40
40
|
</code><button type="button">Copy</button></pre>
|
|
41
41
|
|
|
42
42
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The AfterDestroyCommit decorator</p>
|
|
43
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
43
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L642">src/decorators/Decorators.ts:642</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="AfterSave" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>After<wbr/>Save</span><a href="#AfterSave" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AfterSave.AfterSave-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">After<wbr/>Save</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#AfterSave.AfterSave-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>AfterSave decorator</p>
|
|
44
44
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">AfterSave</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">doSomething</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'hi!'</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
45
45
|
</code><button type="button">Copy</button></pre>
|
|
46
46
|
|
|
47
47
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">AfterHookOpts</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The AfterSave decorator</p>
|
|
48
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
48
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L547">src/decorators/Decorators.ts:547</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="AfterSaveCommit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>After<wbr/>Save<wbr/>Commit</span><a href="#AfterSaveCommit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AfterSaveCommit.AfterSaveCommit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">After<wbr/>Save<wbr/>Commit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#AfterSaveCommit.AfterSaveCommit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>AfterSaveCommit decorator</p>
|
|
49
49
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">AfterSaveCommit</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">doSomething</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'hi!'</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
50
50
|
</code><button type="button">Copy</button></pre>
|
|
51
51
|
|
|
52
52
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">AfterHookOpts</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The AfterSaveCommit decorator</p>
|
|
53
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
53
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L566">src/decorators/Decorators.ts:566</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="AfterUpdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>After<wbr/>Update</span><a href="#AfterUpdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AfterUpdate.AfterUpdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">After<wbr/>Update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#AfterUpdate.AfterUpdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>AfterUpdate decorator</p>
|
|
54
54
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">AfterUpdate</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">doSomething</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'hi!'</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
55
55
|
</code><button type="button">Copy</button></pre>
|
|
56
56
|
|
|
57
57
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">AfterHookOpts</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The AfterUpdate decorator</p>
|
|
58
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
58
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L585">src/decorators/Decorators.ts:585</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="AfterUpdateCommit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>After<wbr/>Update<wbr/>Commit</span><a href="#AfterUpdateCommit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="AfterUpdateCommit.AfterUpdateCommit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">After<wbr/>Update<wbr/>Commit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#AfterUpdateCommit.AfterUpdateCommit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>AfterUpdateCommit decorator</p>
|
|
59
59
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">AfterUpdateCommit</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">doSomething</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'hi!'</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
60
60
|
</code><button type="button">Copy</button></pre>
|
|
61
61
|
|
|
62
62
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">AfterHookOpts</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The AfterUpdateCommit decorator</p>
|
|
63
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
63
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L604">src/decorators/Decorators.ts:604</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="BeforeCreate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Before<wbr/>Create</span><a href="#BeforeCreate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="BeforeCreate.BeforeCreate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Before<wbr/>Create</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#BeforeCreate.BeforeCreate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>BeforeCreate decorator</p>
|
|
64
64
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">BeforeCreate</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">doSomething</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'hi!'</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
65
65
|
</code><button type="button">Copy</button></pre>
|
|
66
66
|
|
|
67
67
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">BeforeHookOpts</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The BeforeCreate decorator</p>
|
|
68
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
68
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L435">src/decorators/Decorators.ts:435</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="BeforeDestroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Before<wbr/>Destroy</span><a href="#BeforeDestroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="BeforeDestroy.BeforeDestroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Before<wbr/>Destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#BeforeDestroy.BeforeDestroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>BeforeDestroy decorator</p>
|
|
69
69
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">BeforeDestroy</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">doSomething</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'hi!'</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
70
70
|
</code><button type="button">Copy</button></pre>
|
|
71
71
|
|
|
72
72
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The BeforeDestroy decorator</p>
|
|
73
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
73
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L491">src/decorators/Decorators.ts:491</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="BeforeSave" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Before<wbr/>Save</span><a href="#BeforeSave" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="BeforeSave.BeforeSave-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Before<wbr/>Save</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#BeforeSave.BeforeSave-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>BeforeSave decorator</p>
|
|
74
74
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">BeforeSave</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">doSomething</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'hi!'</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
75
75
|
</code><button type="button">Copy</button></pre>
|
|
76
76
|
|
|
77
77
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">BeforeHookOpts</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The BeforeSave decorator</p>
|
|
78
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
78
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L454">src/decorators/Decorators.ts:454</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="BeforeUpdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Before<wbr/>Update</span><a href="#BeforeUpdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="BeforeUpdate.BeforeUpdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Before<wbr/>Update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#BeforeUpdate.BeforeUpdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>BeforeUpdate decorator</p>
|
|
79
79
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">BeforeUpdate</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">doSomething</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'hi!'</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
80
80
|
</code><button type="button">Copy</button></pre>
|
|
81
81
|
|
|
82
82
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">BeforeHookOpts</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>The BeforeUpdate decorator</p>
|
|
83
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/0f04f133ec4cfe9272c9b9bc3495f6be237bede5/src/decorators/Decorators.ts#L473">src/decorators/Decorators.ts:473</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="BelongsTo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Belongs<wbr/>To</span><a href="#BelongsTo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="BelongsTo.BelongsTo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Belongs<wbr/>To</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#BelongsTo.BelongsTo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalNameOrNames</span><span class="tsd-signature-keyword"> extends </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">number</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">symbol</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type">GlobalModelNameTableMap</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">NonPolymorphicBelongsToOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">0</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TableNameForGlobalModelName</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-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="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">0</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><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><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type">GlobalModelNameTableMap</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"connectionTypeConfig"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"connectionTypeConfig"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"globalNames"</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">AssociationTableNames</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"DB"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"schema"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"DB"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/0f04f133ec4cfe9272c9b9bc3495f6be237bede5/src/decorators/Decorators.ts#L43">src/decorators/Decorators.ts:43</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="BelongsTo.BelongsTo-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Belongs<wbr/>To</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#BelongsTo.BelongsTo-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalNameOrNames</span><span class="tsd-signature-keyword"> extends </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">number</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">symbol</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type">GlobalModelNameTableMap</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">PolymorphicBelongsToOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">0</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TableNameForGlobalModelName</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-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="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">0</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><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><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type">GlobalModelNameTableMap</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"connectionTypeConfig"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"connectionTypeConfig"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"globalNames"</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">AssociationTableNames</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"DB"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"schema"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"DB"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/0f04f133ec4cfe9272c9b9bc3495f6be237bede5/src/decorators/Decorators.ts#L53">src/decorators/Decorators.ts:53</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="Encrypted" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Encrypted</span><a href="#Encrypted" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="Encrypted.Encrypted-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Encrypted</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">column</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#Encrypted.Encrypted-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The Encrypted decorator automatically encrypts (upon setting)
|
|
83
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L473">src/decorators/Decorators.ts:473</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="BelongsTo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Belongs<wbr/>To</span><a href="#BelongsTo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="BelongsTo.BelongsTo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Belongs<wbr/>To</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#BelongsTo.BelongsTo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalNameOrNames</span><span class="tsd-signature-keyword"> extends </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">number</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">symbol</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type">GlobalModelNameTableMap</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">NonPolymorphicBelongsToOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">0</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TableNameForGlobalModelName</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-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="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">0</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-1.AssociationGlobalNameOrNames">AssociationGlobalNameOrNames</a><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><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type">GlobalModelNameTableMap</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"connectionTypeConfig"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"connectionTypeConfig"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"globalNames"</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">AssociationTableNames</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"DB"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"schema"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"DB"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L43">src/decorators/Decorators.ts:43</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="BelongsTo.BelongsTo-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Belongs<wbr/>To</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#BelongsTo.BelongsTo-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalNameOrNames</span><span class="tsd-signature-keyword"> extends </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">number</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">symbol</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type">GlobalModelNameTableMap</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">PolymorphicBelongsToOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">0</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TableNameForGlobalModelName</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-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="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">0</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#BelongsTo.BelongsTo-2.AssociationGlobalNameOrNames-1">AssociationGlobalNameOrNames</a><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><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type">GlobalModelNameTableMap</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"connectionTypeConfig"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"connectionTypeConfig"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"globalNames"</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">AssociationTableNames</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"DB"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"schema"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"DB"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L53">src/decorators/Decorators.ts:53</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="Encrypted" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Encrypted</span><a href="#Encrypted" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="Encrypted.Encrypted-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Encrypted</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">column</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#Encrypted.Encrypted-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The Encrypted decorator automatically encrypts (upon setting)
|
|
84
84
|
and decrypts (upon getting) so that the encrypted value is
|
|
85
85
|
stored in the database.</p>
|
|
86
86
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">User</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">Encrypted</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-7">// automatically sets `encryptedSsn` to the encrypted value that</span><br/><span class="hl-1"> </span><span class="hl-7">// `ssn` is set to in new/create/update, e.g., `await user.update({ ssn })`</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">ssn</span><span class="hl-1">: </span><span class="hl-9">string</span><br/><br/><span class="hl-1"> </span><span class="hl-7">// automatically sets `myEncryptedPhone` to the encrypted value that</span><br/><span class="hl-1"> </span><span class="hl-7">// `phone` is set to new/create/update, e.g., `await user.update({ phone })`</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">Encrypted</span><span class="hl-1">(</span><span class="hl-6">'myEncryptedPhone</span><span class="hl-10">)</span><br/><span class="hl-1"> </span><span class="hl-4">public</span><span class="hl-1"> </span><span class="hl-4">phone</span><span class="hl-1">: </span><span class="hl-4">string</span><br/><span class="hl-1">}</span>
|
|
@@ -88,7 +88,7 @@ stored in the database.</p>
|
|
|
88
88
|
|
|
89
89
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">column</span>: <span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"DB"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"table"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"DB"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>— if omitted, then 'encrypted' is prepended to the Pascal cased version of the decorated field</p>
|
|
90
90
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>An Encrypted decorator</p>
|
|
91
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/0f04f133ec4cfe9272c9b9bc3495f6be237bede5/src/decorators/Decorators.ts#L248">src/decorators/Decorators.ts:248</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="HasMany" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Has<wbr/>Many</span><a href="#HasMany" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="HasMany.HasMany-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Has<wbr/>Many</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-1.AssociationGlobalName">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-1.ThroughAssociationName">ThroughAssociationName</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#HasMany.HasMany-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="HasMany.HasMany-1.AssociationGlobalName" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span></li><li><span><a id="HasMany.HasMany-1.ThroughAssociationName" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ThroughAssociationName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-1.AssociationGlobalName">AssociationGlobalName</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">HasManyOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-1.AssociationGlobalName">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-1.ThroughAssociationName">ThroughAssociationName</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/0f04f133ec4cfe9272c9b9bc3495f6be237bede5/src/decorators/Decorators.ts#L98">src/decorators/Decorators.ts:98</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="HasMany.HasMany-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Has<wbr/>Many</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-2.AssociationGlobalName-1">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-2.ThroughAssociationName-1">ThroughAssociationName</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#HasMany.HasMany-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="HasMany.HasMany-2.AssociationGlobalName-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span></li><li><span><a id="HasMany.HasMany-2.ThroughAssociationName-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ThroughAssociationName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-2.AssociationGlobalName-1">AssociationGlobalName</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">HasManyThroughOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-2.AssociationGlobalName-1">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-2.ThroughAssociationName-1">ThroughAssociationName</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/0f04f133ec4cfe9272c9b9bc3495f6be237bede5/src/decorators/Decorators.ts#L107">src/decorators/Decorators.ts:107</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="HasMany.HasMany-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Has<wbr/>Many</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-3.AssociationGlobalName-2">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-3.ThroughAssociationName-2">ThroughAssociationName</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#HasMany.HasMany-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="HasMany.HasMany-3.AssociationGlobalName-2" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span></li><li><span><a id="HasMany.HasMany-3.ThroughAssociationName-2" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ThroughAssociationName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-3.AssociationGlobalName-2">AssociationGlobalName</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">PolymorphicHasManyOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-3.AssociationGlobalName-2">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-3.ThroughAssociationName-2">ThroughAssociationName</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/0f04f133ec4cfe9272c9b9bc3495f6be237bede5/src/decorators/Decorators.ts#L116">src/decorators/Decorators.ts:116</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="HasOne" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Has<wbr/>One</span><a href="#HasOne" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="HasOne.HasOne-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Has<wbr/>One</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-1.AssociationGlobalName-3">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-1.ThroughAssociationName-3">ThroughAssociationName</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#HasOne.HasOne-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="HasOne.HasOne-1.AssociationGlobalName-3" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span></li><li><span><a id="HasOne.HasOne-1.ThroughAssociationName-3" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ThroughAssociationName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-1.AssociationGlobalName-3">AssociationGlobalName</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">HasOneOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-1.AssociationGlobalName-3">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-1.ThroughAssociationName-3">ThroughAssociationName</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/0f04f133ec4cfe9272c9b9bc3495f6be237bede5/src/decorators/Decorators.ts#L164">src/decorators/Decorators.ts:164</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="HasOne.HasOne-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Has<wbr/>One</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-2.AssociationGlobalName-4">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-2.ThroughAssociationName-4">ThroughAssociationName</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#HasOne.HasOne-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="HasOne.HasOne-2.AssociationGlobalName-4" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span></li><li><span><a id="HasOne.HasOne-2.ThroughAssociationName-4" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ThroughAssociationName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-2.AssociationGlobalName-4">AssociationGlobalName</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">HasOneThroughOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-2.AssociationGlobalName-4">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-2.ThroughAssociationName-4">ThroughAssociationName</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/0f04f133ec4cfe9272c9b9bc3495f6be237bede5/src/decorators/Decorators.ts#L173">src/decorators/Decorators.ts:173</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="HasOne.HasOne-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Has<wbr/>One</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-3.AssociationGlobalName-5">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-3.ThroughAssociationName-5">ThroughAssociationName</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#HasOne.HasOne-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="HasOne.HasOne-3.AssociationGlobalName-5" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span></li><li><span><a id="HasOne.HasOne-3.ThroughAssociationName-5" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ThroughAssociationName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-3.AssociationGlobalName-5">AssociationGlobalName</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">PolymorphicHasOneOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-3.AssociationGlobalName-5">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-3.ThroughAssociationName-5">ThroughAssociationName</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/0f04f133ec4cfe9272c9b9bc3495f6be237bede5/src/decorators/Decorators.ts#L182">src/decorators/Decorators.ts:182</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="Scope" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Scope</span><a href="#Scope" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="Scope.Scope-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Scope</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#Scope.Scope-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The Scope decorator decorates a static method that accepts
|
|
91
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L248">src/decorators/Decorators.ts:248</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="HasMany" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Has<wbr/>Many</span><a href="#HasMany" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="HasMany.HasMany-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Has<wbr/>Many</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-1.AssociationGlobalName">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-1.ThroughAssociationName">ThroughAssociationName</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#HasMany.HasMany-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="HasMany.HasMany-1.AssociationGlobalName" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span></li><li><span><a id="HasMany.HasMany-1.ThroughAssociationName" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ThroughAssociationName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-1.AssociationGlobalName">AssociationGlobalName</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">HasManyOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-1.AssociationGlobalName">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-1.ThroughAssociationName">ThroughAssociationName</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L98">src/decorators/Decorators.ts:98</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="HasMany.HasMany-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Has<wbr/>Many</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-2.AssociationGlobalName-1">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-2.ThroughAssociationName-1">ThroughAssociationName</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#HasMany.HasMany-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="HasMany.HasMany-2.AssociationGlobalName-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span></li><li><span><a id="HasMany.HasMany-2.ThroughAssociationName-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ThroughAssociationName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-2.AssociationGlobalName-1">AssociationGlobalName</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">HasManyThroughOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-2.AssociationGlobalName-1">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-2.ThroughAssociationName-1">ThroughAssociationName</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L107">src/decorators/Decorators.ts:107</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="HasMany.HasMany-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Has<wbr/>Many</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-3.AssociationGlobalName-2">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-3.ThroughAssociationName-2">ThroughAssociationName</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#HasMany.HasMany-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="HasMany.HasMany-3.AssociationGlobalName-2" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span></li><li><span><a id="HasMany.HasMany-3.ThroughAssociationName-2" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ThroughAssociationName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-3.AssociationGlobalName-2">AssociationGlobalName</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">PolymorphicHasManyOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-3.AssociationGlobalName-2">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasMany.HasMany-3.ThroughAssociationName-2">ThroughAssociationName</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L116">src/decorators/Decorators.ts:116</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="HasOne" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Has<wbr/>One</span><a href="#HasOne" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="HasOne.HasOne-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Has<wbr/>One</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-1.AssociationGlobalName-3">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-1.ThroughAssociationName-3">ThroughAssociationName</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#HasOne.HasOne-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="HasOne.HasOne-1.AssociationGlobalName-3" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span></li><li><span><a id="HasOne.HasOne-1.ThroughAssociationName-3" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ThroughAssociationName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-1.AssociationGlobalName-3">AssociationGlobalName</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">HasOneOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-1.AssociationGlobalName-3">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-1.ThroughAssociationName-3">ThroughAssociationName</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L164">src/decorators/Decorators.ts:164</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="HasOne.HasOne-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Has<wbr/>One</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-2.AssociationGlobalName-4">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-2.ThroughAssociationName-4">ThroughAssociationName</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#HasOne.HasOne-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="HasOne.HasOne-2.AssociationGlobalName-4" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span></li><li><span><a id="HasOne.HasOne-2.ThroughAssociationName-4" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ThroughAssociationName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-2.AssociationGlobalName-4">AssociationGlobalName</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">HasOneThroughOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-2.AssociationGlobalName-4">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-2.ThroughAssociationName-4">ThroughAssociationName</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L173">src/decorators/Decorators.ts:173</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="HasOne.HasOne-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Has<wbr/>One</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-3.AssociationGlobalName-5">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-3.ThroughAssociationName-5">ThroughAssociationName</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">globalAssociationNameOrNames</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#HasOne.HasOne-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="HasOne.HasOne-3.AssociationGlobalName-5" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">AssociationGlobalName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span></li><li><span><a id="HasOne.HasOne-3.ThroughAssociationName-5" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ThroughAssociationName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">globalAssociationNameOrNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-3.AssociationGlobalName-5">AssociationGlobalName</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">PolymorphicHasOneOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-3.AssociationGlobalName-5">AssociationGlobalName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#HasOne.HasOne-3.ThroughAssociationName-5">ThroughAssociationName</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L182">src/decorators/Decorators.ts:182</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="Scope" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Scope</span><a href="#Scope" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="Scope.Scope-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Scope</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#Scope.Scope-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The Scope decorator decorates a static method that accepts
|
|
92
92
|
and returns a Dream Query.</p>
|
|
93
93
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">Collar</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">Scope</span><span class="hl-1">({ </span><span class="hl-4">default:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> })</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-0">static</span><span class="hl-1"> </span><span class="hl-5">hideHiddenCollars</span><span class="hl-1">(</span><span class="hl-4">query</span><span class="hl-1">: </span><span class="hl-9">Query</span><span class="hl-1"><</span><span class="hl-9">Collar</span><span class="hl-1">>) {</span><br/><span class="hl-1"> </span><span class="hl-3">return</span><span class="hl-1"> </span><span class="hl-4">query</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">hidden:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1"> })</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
94
94
|
</code><button type="button">Copy</button></pre>
|
|
@@ -96,7 +96,7 @@ and returns a Dream Query.</p>
|
|
|
96
96
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">default</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>— optional options</p>
|
|
97
97
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">default</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>boolean: if true, then this scope will be applied to all queries involving this model</p>
|
|
98
98
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>A Scope decorator</p>
|
|
99
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
99
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L269">src/decorators/Decorators.ts:269</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="Sortable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Sortable</span><a href="#Sortable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="Sortable.Sortable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Sortable</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#Sortable.Sortable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The Sortable decorator automatically adjusts the value of the columns
|
|
100
100
|
corresponding to the decorated field.</p>
|
|
101
101
|
<p>NOTE: the Sortable decorator may not be used in STI child models (it may be used in the STI base class)</p>
|
|
102
102
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">Balloon</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">Sortable</span><span class="hl-1">({ </span><span class="hl-4">scope:</span><span class="hl-1"> </span><span class="hl-6">'user'</span><span class="hl-1"> })</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">position</span><span class="hl-1">: </span><span class="hl-9">DreamColumn</span><span class="hl-1"><</span><span class="hl-9">Balloon</span><span class="hl-1">, </span><span class="hl-6">'position'</span><span class="hl-1">></span><br/><span class="hl-1">}</span>
|
|
@@ -104,13 +104,13 @@ corresponding to the decorated field.</p>
|
|
|
104
104
|
|
|
105
105
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">SortableOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.T-1">T</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Configuration options for the sortable decorator</p>
|
|
106
106
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>A Sortable decorator</p>
|
|
107
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
107
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L295">src/decorators/Decorators.ts:295</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="Validate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Validate</span><a href="#Validate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="Validate.Validate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Validate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#Validate.Validate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The Validate decorator decorates a method to run
|
|
108
108
|
before saving a model to the database.</p>
|
|
109
109
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">Sandbag</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">Validate</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-5">validateWeight</span><span class="hl-1">(</span><span class="hl-0">this</span><span class="hl-1">: </span><span class="hl-9">Sandbag</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (!</span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-4">weight</span><span class="hl-1">) </span><span class="hl-3">return</span><br/><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">undefinedOrNull</span><span class="hl-1">: </span><span class="hl-9">any</span><span class="hl-1">[] = [</span><span class="hl-0">undefined</span><span class="hl-1">, </span><span class="hl-0">null</span><span class="hl-1">]</span><br/><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (!</span><span class="hl-4">undefinedOrNull</span><span class="hl-1">.</span><span class="hl-5">includes</span><span class="hl-1">(</span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-4">weightKgs</span><span class="hl-1">))</span><br/><span class="hl-1"> </span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-5">addError</span><span class="hl-1">(</span><span class="hl-6">'weight'</span><span class="hl-1">, </span><span class="hl-6">'cannot include weightKgs AND weight'</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (!</span><span class="hl-4">undefinedOrNull</span><span class="hl-1">.</span><span class="hl-5">includes</span><span class="hl-1">(</span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-4">weightTons</span><span class="hl-1">))</span><br/><span class="hl-1"> </span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-5">addError</span><span class="hl-1">(</span><span class="hl-6">'weight'</span><span class="hl-1">, </span><span class="hl-6">'cannot include weightTons AND weight'</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
110
110
|
</code><button type="button">Copy</button></pre>
|
|
111
111
|
|
|
112
112
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>A Validate decorator</p>
|
|
113
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
113
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L321">src/decorators/Decorators.ts:321</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="Validates" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Validates</span><a href="#Validates" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="Validates.Validates-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Validates</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#Validates.Validates-1.VT">VT</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#Validates.Validates-1.VTArgs">VTArgs</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">type</span>, <span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#Validates.Validates-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The Validates decorator decorates a field to validate
|
|
114
114
|
according to the specified validator and options.</p>
|
|
115
115
|
<pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">Balloon</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">Validates</span><span class="hl-1">(</span><span class="hl-6">'numericality'</span><span class="hl-1">, { </span><span class="hl-4">min:</span><span class="hl-1"> </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-4">max:</span><span class="hl-1"> </span><span class="hl-8">100</span><span class="hl-1"> })</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">volume</span><span class="hl-1">: </span><span class="hl-9">DreamColumn</span><span class="hl-1"><</span><span class="hl-9">Balloon</span><span class="hl-1">, </span><span class="hl-6">'volume'</span><span class="hl-1">></span><br/><span class="hl-1">}</span>
|
|
116
116
|
</code><button type="button">Copy</button></pre>
|
|
@@ -118,7 +118,7 @@ according to the specified validator and options.</p>
|
|
|
118
118
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="Validates.Validates-1.VT" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">VT</span><span class="tsd-signature-keyword"> extends </span><a href="../types/types.ValidationType.html" class="tsd-signature-type tsd-kind-type-alias">ValidationType</a></span></li><li><span><a id="Validates.Validates-1.VTArgs" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">VTArgs</span><span class="tsd-signature-keyword"> extends </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">RegExp</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">max</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">min</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">max</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">min</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">type</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#Validates.Validates-1.VT">VT</a></span><div class="tsd-comment tsd-typography"><p>— the type of validation</p>
|
|
119
119
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">args</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#Validates.Validates-1.VTArgs">VTArgs</a></span><div class="tsd-comment tsd-typography"><p>— optional arguments specific to the type of validation</p>
|
|
120
120
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>A Validates decorator</p>
|
|
121
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
121
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L341">src/decorators/Decorators.ts:341</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="Virtual" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Virtual</span><a href="#Virtual" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="Virtual.Virtual-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Virtual</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">openapi</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#Virtual.Virtual-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The Virtual decorator enables setting of fields as if they
|
|
122
122
|
corresponded to columns in the model's table so they can
|
|
123
123
|
be passed to new, create, and update.</p>
|
|
124
124
|
<p>For example, in the first example, below, one could call
|
|
@@ -141,4 +141,4 @@ with the getter simply returning <code>undefined</code>.)</p>
|
|
|
141
141
|
|
|
142
142
|
</div><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 href="index.Decorators.html" class="tsd-signature-type tsd-kind-class">Decorators</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><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="index.Decorators.html#constructor.new_Decorators.TD-1">TD</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">openapi</span>: <a href="../types/openapi.OpenapiSchemaBodyShorthand.html" class="tsd-signature-type tsd-kind-type-alias">OpenapiSchemaBodyShorthand</a><span class="tsd-signature-symbol"> | </span><a href="../types/openapi.OpenapiShorthandPrimitiveTypes.html" class="tsd-signature-type tsd-kind-type-alias">OpenapiShorthandPrimitiveTypes</a></span><div class="tsd-comment tsd-typography"><p>Required. The OpenAPI shape that defines both the serializer OpenAPI shape and request body OpenAPI shape (in Psychic)</p>
|
|
143
143
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><p>A Virtual decorator</p>
|
|
144
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/
|
|
144
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/decorators/Decorators.ts#L416">src/decorators/Decorators.ts:416</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#AfterCreate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>After<wbr/>Create</span></a><a href="#AfterCreateCommit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>After<wbr/>Create<wbr/>Commit</span></a><a href="#AfterDestroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>After<wbr/>Destroy</span></a><a href="#AfterDestroyCommit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>After<wbr/>Destroy<wbr/>Commit</span></a><a href="#AfterSave" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>After<wbr/>Save</span></a><a href="#AfterSaveCommit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>After<wbr/>Save<wbr/>Commit</span></a><a href="#AfterUpdate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>After<wbr/>Update</span></a><a href="#AfterUpdateCommit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>After<wbr/>Update<wbr/>Commit</span></a><a href="#BeforeCreate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Before<wbr/>Create</span></a><a href="#BeforeDestroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Before<wbr/>Destroy</span></a><a href="#BeforeSave" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Before<wbr/>Save</span></a><a href="#BeforeUpdate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Before<wbr/>Update</span></a><a href="#BelongsTo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Belongs<wbr/>To</span></a><a href="#Encrypted" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Encrypted</span></a><a href="#HasMany" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Has<wbr/>Many</span></a><a href="#HasOne" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Has<wbr/>One</span></a><a href="#Scope" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Scope</span></a><a href="#Sortable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Sortable</span></a><a href="#Validate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Validate</span></a><a href="#Validates" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Validates</span></a><a href="#Virtual" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Virtual</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@rvoh/dream</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|