@rvoh/dream 2.1.2 → 2.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (232) hide show
  1. package/README.md +4 -4
  2. package/dist/cjs/src/Dream.js +35 -0
  3. package/dist/cjs/src/bin/index.js +1 -1
  4. package/dist/cjs/src/cli/index.js +1 -1
  5. package/dist/cjs/src/cli/logger/loggable/DreamCliLoggableText.js +1 -0
  6. package/dist/cjs/src/dream/DreamClassTransactionBuilder.js +30 -0
  7. package/dist/cjs/src/dream/Query.js +30 -0
  8. package/dist/cjs/src/dream/QueryDriver/Base.js +32 -0
  9. package/dist/cjs/src/dream/QueryDriver/Kysely.js +48 -0
  10. package/dist/cjs/src/dream/internal/printSerializerHierarchyLevel.js +2 -0
  11. package/dist/cjs/src/dream-app/helpers/DreamImporter.js +3 -1
  12. package/dist/cjs/src/dream-app/index.js +2 -1
  13. package/dist/cjs/src/helpers/Env.js +2 -0
  14. package/dist/cjs/src/helpers/cli/ASTConnectionBuilder.js +1 -1
  15. package/dist/cjs/src/helpers/cli/DBClassDeprecation.js +2 -0
  16. package/dist/cjs/src/helpers/cli/generateDream.js +2 -1
  17. package/dist/cjs/src/helpers/cli/generateFactory.js +2 -1
  18. package/dist/cjs/src/helpers/cli/generateMigration.js +2 -1
  19. package/dist/cjs/src/helpers/cli/generateMigrationContent.js +1 -1
  20. package/dist/cjs/src/helpers/cli/generateSerializer.js +2 -1
  21. package/dist/cjs/src/helpers/cli/generateUnitSpec.js +2 -1
  22. package/dist/cjs/src/helpers/getFiles.js +3 -1
  23. package/dist/cjs/src/helpers/sspawn.js +2 -0
  24. package/dist/esm/src/Dream.js +35 -0
  25. package/dist/esm/src/bin/index.js +1 -1
  26. package/dist/esm/src/cli/index.js +1 -1
  27. package/dist/esm/src/cli/logger/loggable/DreamCliLoggableText.js +1 -0
  28. package/dist/esm/src/dream/DreamClassTransactionBuilder.js +30 -0
  29. package/dist/esm/src/dream/Query.js +30 -0
  30. package/dist/esm/src/dream/QueryDriver/Base.js +32 -0
  31. package/dist/esm/src/dream/QueryDriver/Kysely.js +48 -0
  32. package/dist/esm/src/dream/internal/printSerializerHierarchyLevel.js +2 -0
  33. package/dist/esm/src/dream-app/helpers/DreamImporter.js +3 -1
  34. package/dist/esm/src/dream-app/index.js +2 -1
  35. package/dist/esm/src/helpers/Env.js +2 -0
  36. package/dist/esm/src/helpers/cli/ASTConnectionBuilder.js +1 -1
  37. package/dist/esm/src/helpers/cli/DBClassDeprecation.js +2 -0
  38. package/dist/esm/src/helpers/cli/generateDream.js +2 -1
  39. package/dist/esm/src/helpers/cli/generateFactory.js +2 -1
  40. package/dist/esm/src/helpers/cli/generateMigration.js +2 -1
  41. package/dist/esm/src/helpers/cli/generateMigrationContent.js +1 -1
  42. package/dist/esm/src/helpers/cli/generateSerializer.js +2 -1
  43. package/dist/esm/src/helpers/cli/generateUnitSpec.js +2 -1
  44. package/dist/esm/src/helpers/getFiles.js +3 -1
  45. package/dist/esm/src/helpers/sspawn.js +2 -0
  46. package/dist/types/src/Dream.d.ts +28 -0
  47. package/dist/types/src/dream/DreamClassTransactionBuilder.d.ts +26 -0
  48. package/dist/types/src/dream/Query.d.ts +26 -0
  49. package/dist/types/src/dream/QueryDriver/Base.d.ts +26 -0
  50. package/dist/types/src/dream/QueryDriver/Kysely.d.ts +26 -0
  51. package/dist/types/src/dream-app/helpers/PackageManager.d.ts +1 -1
  52. package/dist/types/src/dream-app/index.d.ts +2 -2
  53. package/dist/types/src/types/associations/belongsTo.d.ts +1 -1
  54. package/dist/types/src/types/associations/belongsTo.ts +1 -1
  55. package/dist/types/src/types/serializer.ts +2 -2
  56. package/docs/assets/search.js +1 -1
  57. package/docs/classes/db.DreamMigrationHelpers.html +9 -9
  58. package/docs/classes/db.KyselyQueryDriver.html +47 -31
  59. package/docs/classes/db.PostgresQueryDriver.html +48 -32
  60. package/docs/classes/db.QueryDriverBase.html +46 -30
  61. package/docs/classes/errors.CheckConstraintViolation.html +4 -4
  62. package/docs/classes/errors.ColumnOverflow.html +4 -4
  63. package/docs/classes/errors.CreateOrFindByFailedToCreateAndFind.html +4 -4
  64. package/docs/classes/errors.DataIncompatibleWithDatabaseField.html +4 -4
  65. package/docs/classes/errors.DataTypeColumnTypeMismatch.html +4 -4
  66. package/docs/classes/errors.GlobalNameNotSet.html +4 -4
  67. package/docs/classes/errors.InvalidCalendarDate.html +4 -4
  68. package/docs/classes/errors.MissingSerializersDefinition.html +4 -4
  69. package/docs/classes/errors.NonLoadedAssociation.html +4 -4
  70. package/docs/classes/errors.NotNullViolation.html +4 -4
  71. package/docs/classes/errors.RecordNotFound.html +4 -4
  72. package/docs/classes/errors.ValidationError.html +4 -4
  73. package/docs/classes/index.CalendarDate.html +2 -2
  74. package/docs/classes/index.Decorators.html +19 -19
  75. package/docs/classes/index.Dream.html +210 -194
  76. package/docs/classes/index.DreamApp.html +5 -5
  77. package/docs/classes/index.DreamTransaction.html +2 -2
  78. package/docs/classes/index.Env.html +2 -2
  79. package/docs/classes/index.Query.html +91 -75
  80. package/docs/classes/system.CliFileWriter.html +2 -2
  81. package/docs/classes/system.DreamBin.html +2 -2
  82. package/docs/classes/system.DreamCLI.html +5 -5
  83. package/docs/classes/system.DreamImporter.html +2 -2
  84. package/docs/classes/system.DreamLogos.html +2 -2
  85. package/docs/classes/system.DreamSerializerBuilder.html +8 -8
  86. package/docs/classes/system.ObjectSerializerBuilder.html +8 -8
  87. package/docs/classes/utils.Encrypt.html +2 -2
  88. package/docs/classes/utils.Range.html +2 -2
  89. package/docs/functions/db.closeAllDbConnections.html +1 -1
  90. package/docs/functions/db.dreamDbConnections.html +1 -1
  91. package/docs/functions/db.untypedDb.html +1 -1
  92. package/docs/functions/db.validateColumn.html +1 -1
  93. package/docs/functions/db.validateTable.html +1 -1
  94. package/docs/functions/errors.pgErrorType.html +1 -1
  95. package/docs/functions/index.DreamSerializer.html +1 -1
  96. package/docs/functions/index.ObjectSerializer.html +1 -1
  97. package/docs/functions/index.ReplicaSafe.html +1 -1
  98. package/docs/functions/index.STI.html +1 -1
  99. package/docs/functions/index.SoftDelete.html +1 -1
  100. package/docs/functions/utils.camelize.html +1 -1
  101. package/docs/functions/utils.capitalize.html +1 -1
  102. package/docs/functions/utils.cloneDeepSafe.html +1 -1
  103. package/docs/functions/utils.compact.html +1 -1
  104. package/docs/functions/utils.groupBy.html +1 -1
  105. package/docs/functions/utils.hyphenize.html +1 -1
  106. package/docs/functions/utils.intersection.html +1 -1
  107. package/docs/functions/utils.isEmpty.html +1 -1
  108. package/docs/functions/utils.normalizeUnicode.html +1 -1
  109. package/docs/functions/utils.pascalize.html +1 -1
  110. package/docs/functions/utils.percent.html +1 -1
  111. package/docs/functions/utils.range-1.html +1 -1
  112. package/docs/functions/utils.round.html +1 -1
  113. package/docs/functions/utils.sanitizeString.html +1 -1
  114. package/docs/functions/utils.snakeify.html +1 -1
  115. package/docs/functions/utils.sort.html +1 -1
  116. package/docs/functions/utils.sortBy.html +1 -1
  117. package/docs/functions/utils.sortObjectByKey.html +1 -1
  118. package/docs/functions/utils.sortObjectByValue.html +1 -1
  119. package/docs/functions/utils.uncapitalize.html +1 -1
  120. package/docs/functions/utils.uniq.html +1 -1
  121. package/docs/index.html +4 -4
  122. package/docs/interfaces/openapi.OpenapiDescription.html +2 -2
  123. package/docs/interfaces/openapi.OpenapiSchemaProperties.html +1 -1
  124. package/docs/interfaces/openapi.OpenapiSchemaPropertiesShorthand.html +1 -1
  125. package/docs/interfaces/openapi.OpenapiTypeFieldObject.html +1 -1
  126. package/docs/interfaces/types.BelongsToStatement.html +2 -2
  127. package/docs/interfaces/types.DecoratorContext.html +2 -2
  128. package/docs/interfaces/types.DreamAppInitOptions.html +2 -2
  129. package/docs/interfaces/types.DreamAppOpts.html +2 -2
  130. package/docs/interfaces/types.EncryptOptions.html +2 -2
  131. package/docs/interfaces/types.InternalAnyTypedSerializerRendersMany.html +2 -2
  132. package/docs/interfaces/types.InternalAnyTypedSerializerRendersOne.html +2 -2
  133. package/docs/interfaces/types.SerializerRendererOpts.html +2 -2
  134. package/docs/modules/db.html +1 -1
  135. package/docs/modules/errors.html +1 -1
  136. package/docs/modules/index.html +1 -1
  137. package/docs/modules/openapi.html +1 -1
  138. package/docs/modules/system.html +1 -1
  139. package/docs/modules/types.html +1 -1
  140. package/docs/modules/utils.html +1 -1
  141. package/docs/types/index.DateTime.html +1 -1
  142. package/docs/types/openapi.CommonOpenapiSchemaObjectFields.html +1 -1
  143. package/docs/types/openapi.OpenapiAllTypes.html +1 -1
  144. package/docs/types/openapi.OpenapiFormats.html +1 -1
  145. package/docs/types/openapi.OpenapiNumberFormats.html +1 -1
  146. package/docs/types/openapi.OpenapiPrimitiveBaseTypes.html +1 -1
  147. package/docs/types/openapi.OpenapiPrimitiveTypes.html +1 -1
  148. package/docs/types/openapi.OpenapiSchemaArray.html +1 -1
  149. package/docs/types/openapi.OpenapiSchemaArrayShorthand.html +1 -1
  150. package/docs/types/openapi.OpenapiSchemaBase.html +1 -1
  151. package/docs/types/openapi.OpenapiSchemaBody.html +1 -1
  152. package/docs/types/openapi.OpenapiSchemaBodyShorthand.html +1 -1
  153. package/docs/types/openapi.OpenapiSchemaCommonFields.html +1 -1
  154. package/docs/types/openapi.OpenapiSchemaExpressionAllOf.html +1 -1
  155. package/docs/types/openapi.OpenapiSchemaExpressionAnyOf.html +1 -1
  156. package/docs/types/openapi.OpenapiSchemaExpressionOneOf.html +1 -1
  157. package/docs/types/openapi.OpenapiSchemaExpressionRef.html +1 -1
  158. package/docs/types/openapi.OpenapiSchemaExpressionRefSchemaShorthand.html +1 -1
  159. package/docs/types/openapi.OpenapiSchemaInteger.html +1 -1
  160. package/docs/types/openapi.OpenapiSchemaNull.html +1 -1
  161. package/docs/types/openapi.OpenapiSchemaNumber.html +1 -1
  162. package/docs/types/openapi.OpenapiSchemaObject.html +1 -1
  163. package/docs/types/openapi.OpenapiSchemaObjectAllOf.html +1 -1
  164. package/docs/types/openapi.OpenapiSchemaObjectAllOfShorthand.html +1 -1
  165. package/docs/types/openapi.OpenapiSchemaObjectAnyOf.html +1 -1
  166. package/docs/types/openapi.OpenapiSchemaObjectAnyOfShorthand.html +1 -1
  167. package/docs/types/openapi.OpenapiSchemaObjectBase.html +1 -1
  168. package/docs/types/openapi.OpenapiSchemaObjectBaseShorthand.html +1 -1
  169. package/docs/types/openapi.OpenapiSchemaObjectOneOf.html +1 -1
  170. package/docs/types/openapi.OpenapiSchemaObjectOneOfShorthand.html +1 -1
  171. package/docs/types/openapi.OpenapiSchemaObjectShorthand.html +1 -1
  172. package/docs/types/openapi.OpenapiSchemaPrimitiveGeneric.html +1 -1
  173. package/docs/types/openapi.OpenapiSchemaShorthandExpressionAllOf.html +1 -1
  174. package/docs/types/openapi.OpenapiSchemaShorthandExpressionAnyOf.html +1 -1
  175. package/docs/types/openapi.OpenapiSchemaShorthandExpressionOneOf.html +1 -1
  176. package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializableRef.html +1 -1
  177. package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializerRef.html +1 -1
  178. package/docs/types/openapi.OpenapiSchemaShorthandPrimitiveGeneric.html +1 -1
  179. package/docs/types/openapi.OpenapiSchemaString.html +1 -1
  180. package/docs/types/openapi.OpenapiShorthandAllTypes.html +1 -1
  181. package/docs/types/openapi.OpenapiShorthandPrimitiveBaseTypes.html +1 -1
  182. package/docs/types/openapi.OpenapiShorthandPrimitiveTypes.html +1 -1
  183. package/docs/types/openapi.OpenapiTypeField.html +1 -1
  184. package/docs/types/system.DreamAppAllowedPackageManagersEnum.html +1 -1
  185. package/docs/types/types.Camelized.html +1 -1
  186. package/docs/types/types.DbConnectionType.html +1 -1
  187. package/docs/types/types.DbTypes.html +1 -1
  188. package/docs/types/types.DreamAssociationMetadata.html +1 -1
  189. package/docs/types/types.DreamAttributes.html +1 -1
  190. package/docs/types/types.DreamClassAssociationAndStatement.html +1 -1
  191. package/docs/types/types.DreamClassColumn.html +1 -1
  192. package/docs/types/types.DreamColumn.html +1 -1
  193. package/docs/types/types.DreamColumnNames.html +1 -1
  194. package/docs/types/types.DreamLogLevel.html +1 -1
  195. package/docs/types/types.DreamLogger.html +1 -1
  196. package/docs/types/types.DreamModelSerializerType.html +1 -1
  197. package/docs/types/types.DreamOrViewModelClassSerializerKey.html +1 -1
  198. package/docs/types/types.DreamOrViewModelSerializerKey.html +1 -1
  199. package/docs/types/types.DreamParamSafeAttributes.html +1 -1
  200. package/docs/types/types.DreamParamSafeColumnNames.html +1 -1
  201. package/docs/types/types.DreamSerializable.html +1 -1
  202. package/docs/types/types.DreamSerializableArray.html +1 -1
  203. package/docs/types/types.DreamSerializerKey.html +1 -1
  204. package/docs/types/types.DreamSerializers.html +1 -1
  205. package/docs/types/types.DreamVirtualColumns.html +1 -1
  206. package/docs/types/types.EncryptAlgorithm.html +1 -1
  207. package/docs/types/types.HasManyStatement.html +1 -1
  208. package/docs/types/types.HasOneStatement.html +1 -1
  209. package/docs/types/types.Hyphenized.html +1 -1
  210. package/docs/types/types.Pascalized.html +1 -1
  211. package/docs/types/types.RoundingPrecision.html +1 -1
  212. package/docs/types/types.SerializerCasing.html +1 -1
  213. package/docs/types/types.SimpleObjectSerializerType.html +1 -1
  214. package/docs/types/types.Snakeified.html +1 -1
  215. package/docs/types/types.StrictInterface.html +1 -1
  216. package/docs/types/types.UpdateableAssociationProperties.html +1 -1
  217. package/docs/types/types.UpdateableProperties.html +1 -1
  218. package/docs/types/types.ValidationType.html +1 -1
  219. package/docs/types/types.ViewModel.html +1 -1
  220. package/docs/types/types.ViewModelClass.html +1 -1
  221. package/docs/types/types.WhereStatementForDream.html +1 -1
  222. package/docs/types/types.WhereStatementForDreamClass.html +1 -1
  223. package/docs/variables/index.DateTime-1.html +1 -1
  224. package/docs/variables/index.DreamConst.html +1 -1
  225. package/docs/variables/index.ops.html +1 -1
  226. package/docs/variables/openapi.openapiPrimitiveTypes-1.html +1 -1
  227. package/docs/variables/openapi.openapiShorthandPrimitiveTypes-1.html +1 -1
  228. package/docs/variables/system.DreamAppAllowedPackageManagersEnumValues.html +1 -1
  229. package/docs/variables/types.TRIGRAM_OPERATORS.html +1 -1
  230. package/docs/variables/types.primaryKeyTypes.html +1 -1
  231. package/package.json +17 -17
  232. package/CHANGELOG.md +0 -332
package/docs/classes/system.ObjectSerializerBuilder.html CHANGED
@@ -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>ObjectSerializerBuilder | @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/system.html">system</a></li><li><a href="system.ObjectSerializerBuilder.html">ObjectSerializerBuilder</a></li></ul><h1>Class ObjectSerializerBuilder&lt;MaybeNullDataType, PassthroughDataType, DataType&gt;</h1></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="MaybeNullDataType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">MaybeNullDataType</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></span></li><li><span><a id="PassthroughDataType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">PassthroughDataType</span></span></li><li><span><a id="DataType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DataType</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">Exclude</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span> = <span class="tsd-signature-type">Exclude</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/serializer/builders/ObjectSerializerBuilder.ts#L15">src/serializer/builders/ObjectSerializerBuilder.ts:15</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="system.ObjectSerializerBuilder.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>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ObjectSerializerBuilder | @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/system.html">system</a></li><li><a href="system.ObjectSerializerBuilder.html">ObjectSerializerBuilder</a></li></ul><h1>Class ObjectSerializerBuilder&lt;MaybeNullDataType, PassthroughDataType, DataType&gt;</h1></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="MaybeNullDataType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">MaybeNullDataType</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></span></li><li><span><a id="PassthroughDataType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">PassthroughDataType</span></span></li><li><span><a id="DataType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DataType</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">Exclude</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span> = <span class="tsd-signature-type">Exclude</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/serializer/builders/ObjectSerializerBuilder.ts#L15">src/serializer/builders/ObjectSerializerBuilder.ts:15</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="system.ObjectSerializerBuilder.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">Properties</h3><div class="tsd-index-list"><a href="system.ObjectSerializerBuilder.html#attributes" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attributes</span></a>
3
3
  <a href="system.ObjectSerializerBuilder.html#data" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a>
4
4
  <a href="system.ObjectSerializerBuilder.html#passthroughData" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>passthrough<wbr/>Data</span></a>
@@ -8,7 +8,7 @@
8
8
  <a href="system.ObjectSerializerBuilder.html#render" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render</span></a>
9
9
  <a href="system.ObjectSerializerBuilder.html#rendersMany" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>renders<wbr/>Many</span></a>
10
10
  <a href="system.ObjectSerializerBuilder.html#rendersOne" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>renders<wbr/>One</span></a>
11
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ObjectSerializerBuilder" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Object<wbr/>Serializer<wbr/>Builder</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">passthroughData</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_ObjectSerializerBuilder" 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="constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">MaybeNullDataType</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></span></li><li><span><a id="constructor.new_ObjectSerializerBuilder.PassthroughDataType-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">PassthroughDataType</span></span></li><li><span><a id="constructor.new_ObjectSerializerBuilder.DataType-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DataType</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">object</span> = <span class="tsd-signature-type">Exclude</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</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">data</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a></span></li><li><span><span class="tsd-kind-parameter">passthroughData</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol"> = ...</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/serializer/builders/ObjectSerializerBuilder.ts#L28">src/serializer/builders/ObjectSerializerBuilder.ts:28</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected"><a id="attributes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>attributes</span><a href="#attributes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">attributes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">InternalAnyTypedSerializerAttribute</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">InternalAnyTypedSerializerDelegatedAttribute</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">InternalAnyTypedSerializerCustomAttribute</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../interfaces/types.InternalAnyTypedSerializerRendersOne.html" class="tsd-signature-type tsd-kind-interface">InternalAnyTypedSerializerRendersOne</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../interfaces/types.InternalAnyTypedSerializerRendersMany.html" class="tsd-signature-type tsd-kind-interface">InternalAnyTypedSerializerRendersMany</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/serializer/builders/ObjectSerializerBuilder.ts#L20">src/serializer/builders/ObjectSerializerBuilder.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/serializer/builders/ObjectSerializerBuilder.ts#L29">src/serializer/builders/ObjectSerializerBuilder.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="passthroughData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>passthrough<wbr/>Data</span><a href="#passthroughData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">passthrough<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/serializer/builders/ObjectSerializerBuilder.ts#L30">src/serializer/builders/ObjectSerializerBuilder.ts:30</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="attribute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>attribute</span><a href="#attribute" 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="attribute.attribute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">attribute</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#attribute.attribute-1.AttributeName">AttributeName</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><a href="#attribute.attribute-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>Includes an attribute from the data object in the serialized output.</p>
11
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ObjectSerializerBuilder" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Object<wbr/>Serializer<wbr/>Builder</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">passthroughData</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_ObjectSerializerBuilder" 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="constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">MaybeNullDataType</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></span></li><li><span><a id="constructor.new_ObjectSerializerBuilder.PassthroughDataType-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">PassthroughDataType</span></span></li><li><span><a id="constructor.new_ObjectSerializerBuilder.DataType-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DataType</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">object</span> = <span class="tsd-signature-type">Exclude</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</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">data</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a></span></li><li><span><span class="tsd-kind-parameter">passthroughData</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol"> = ...</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/serializer/builders/ObjectSerializerBuilder.ts#L28">src/serializer/builders/ObjectSerializerBuilder.ts:28</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected"><a id="attributes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>attributes</span><a href="#attributes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">attributes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">InternalAnyTypedSerializerAttribute</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">InternalAnyTypedSerializerDelegatedAttribute</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">InternalAnyTypedSerializerCustomAttribute</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../interfaces/types.InternalAnyTypedSerializerRendersOne.html" class="tsd-signature-type tsd-kind-interface">InternalAnyTypedSerializerRendersOne</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../interfaces/types.InternalAnyTypedSerializerRendersMany.html" class="tsd-signature-type tsd-kind-interface">InternalAnyTypedSerializerRendersMany</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/serializer/builders/ObjectSerializerBuilder.ts#L20">src/serializer/builders/ObjectSerializerBuilder.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/serializer/builders/ObjectSerializerBuilder.ts#L29">src/serializer/builders/ObjectSerializerBuilder.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="passthroughData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>passthrough<wbr/>Data</span><a href="#passthroughData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">passthrough<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/serializer/builders/ObjectSerializerBuilder.ts#L30">src/serializer/builders/ObjectSerializerBuilder.ts:30</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="attribute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>attribute</span><a href="#attribute" 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="attribute.attribute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">attribute</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#attribute.attribute-1.AttributeName">AttributeName</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><a href="#attribute.attribute-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>Includes an attribute from the data object in the serialized output.</p>
12
12
  <p>For ObjectSerializer, the <code>openapi</code> option is always required since type
13
13
  inference is not available for plain objects or ViewModels.</p>
14
14
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="attribute.attribute-1.AttributeName" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">AttributeName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</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">name</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#attribute.attribute-1.AttributeName">AttributeName</a></span><div class="tsd-comment tsd-typography"><p>The attribute name from the data object</p>
@@ -18,7 +18,7 @@ inference is not available for plain objects or ViewModels.</p>
18
18
  </code><button type="button">Copy</button></pre>
19
19
 
20
20
  <p>See: <a href="https://your-docs-url.com/docs/serializers/attributes">Serializer Attributes Documentation</a></p>
21
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/serializer/builders/ObjectSerializerBuilder.ts#L65">src/serializer/builders/ObjectSerializerBuilder.ts:65</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="customAttribute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>custom<wbr/>Attribute</span><a href="#customAttribute" 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="customAttribute.customAttribute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">custom<wbr/>Attribute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><a href="#customAttribute.customAttribute-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>Includes a computed value in the serialized output.</p>
21
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/serializer/builders/ObjectSerializerBuilder.ts#L65">src/serializer/builders/ObjectSerializerBuilder.ts:65</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="customAttribute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>custom<wbr/>Attribute</span><a href="#customAttribute" 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="customAttribute.customAttribute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">custom<wbr/>Attribute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><a href="#customAttribute.customAttribute-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>Includes a computed value in the serialized output.</p>
22
22
  <p>Executes a callback function to generate a custom attribute value.
23
23
  The <code>openapi</code> option is always required since the return type cannot be inferred.</p>
24
24
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The attribute name for the computed value</p>
@@ -29,7 +29,7 @@ The <code>openapi</code> option is always required since the return type cannot
29
29
  </code><button type="button">Copy</button></pre>
30
30
 
31
31
  <p>See: <a href="https://your-docs-url.com/docs/serializers/attributes">Serializer Attributes Documentation</a></p>
32
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/serializer/builders/ObjectSerializerBuilder.ts#L174">src/serializer/builders/ObjectSerializerBuilder.ts:174</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="delegatedAttribute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delegated<wbr/>Attribute</span><a href="#delegatedAttribute" 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="delegatedAttribute.delegatedAttribute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delegated<wbr/>Attribute</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#delegatedAttribute.delegatedAttribute-1.ProvidedModelType">ProvidedModelType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#delegatedAttribute.delegatedAttribute-1.ProvidedAttributeName">ProvidedAttributeName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#delegatedAttribute.delegatedAttribute-1.ActualDataType">ActualDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#delegatedAttribute.delegatedAttribute-1.TargetName">TargetName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#delegatedAttribute.delegatedAttribute-1.TargetObject">TargetObject</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#delegatedAttribute.delegatedAttribute-1.AttributeName-1">AttributeName</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetName</span>, <span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><a href="#delegatedAttribute.delegatedAttribute-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>Includes an attribute from a nested object in the serialized output.</p>
32
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/serializer/builders/ObjectSerializerBuilder.ts#L174">src/serializer/builders/ObjectSerializerBuilder.ts:174</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="delegatedAttribute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delegated<wbr/>Attribute</span><a href="#delegatedAttribute" 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="delegatedAttribute.delegatedAttribute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delegated<wbr/>Attribute</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#delegatedAttribute.delegatedAttribute-1.ProvidedModelType">ProvidedModelType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#delegatedAttribute.delegatedAttribute-1.ProvidedAttributeName">ProvidedAttributeName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#delegatedAttribute.delegatedAttribute-1.ActualDataType">ActualDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#delegatedAttribute.delegatedAttribute-1.TargetName">TargetName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#delegatedAttribute.delegatedAttribute-1.TargetObject">TargetObject</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#delegatedAttribute.delegatedAttribute-1.AttributeName-1">AttributeName</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetName</span>, <span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><a href="#delegatedAttribute.delegatedAttribute-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>Includes an attribute from a nested object in the serialized output.</p>
33
33
  <p>Pulls up an attribute from a target object property. The <code>openapi</code> option
34
34
  is always required. If the target object or the delegated attribute
35
35
  is null/undefined, the <code>default</code> option value will be used if provided.</p>
@@ -41,7 +41,7 @@ is null/undefined, the <code>default</code> option value will be used if provide
41
41
  </code><button type="button">Copy</button></pre>
42
42
 
43
43
  <p>See: <a href="https://your-docs-url.com/docs/serializers/attributes">Serializer Attributes Documentation</a></p>
44
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/serializer/builders/ObjectSerializerBuilder.ts#L107">src/serializer/builders/ObjectSerializerBuilder.ts:107</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="render" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>render</span><a href="#render" 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="render.render-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">render</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">passthrough</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#render.render-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>Executes the serializer and returns the serialized output.</p>
44
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/serializer/builders/ObjectSerializerBuilder.ts#L107">src/serializer/builders/ObjectSerializerBuilder.ts:107</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="render" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>render</span><a href="#render" 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="render.render-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">render</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">passthrough</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#render.render-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>Executes the serializer and returns the serialized output.</p>
45
45
  <p>This method processes all defined attributes, custom attributes, delegated attributes,
46
46
  and associations to produce the final serialized object. The result is suitable for
47
47
  JSON.stringify() and API responses.</p>
@@ -52,7 +52,7 @@ JSON.stringify() and API responses.</p>
52
52
  </code><button type="button">Copy</button></pre>
53
53
 
54
54
  <p>See: <a href="https://your-docs-url.com/docs/serializers/render">Serializer Rendering Documentation</a></p>
55
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/serializer/builders/ObjectSerializerBuilder.ts#L387">src/serializer/builders/ObjectSerializerBuilder.ts:387</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rendersMany" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>renders<wbr/>Many</span><a href="#rendersMany" 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="rendersMany.rendersMany-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">renders<wbr/>Many</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ProvidedModelType-1">ProvidedModelType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ProvidedAttributeName-1">ProvidedAttributeName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ActualDataType-1">ActualDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AttributeName-2">AttributeName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.SerializerOptions">SerializerOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><a href="#rendersMany.rendersMany-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>Includes an array of associated objects in the serialized output.</p>
55
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/serializer/builders/ObjectSerializerBuilder.ts#L387">src/serializer/builders/ObjectSerializerBuilder.ts:387</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rendersMany" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>renders<wbr/>Many</span><a href="#rendersMany" 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="rendersMany.rendersMany-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">renders<wbr/>Many</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ProvidedModelType-1">ProvidedModelType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ProvidedAttributeName-1">ProvidedAttributeName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ActualDataType-1">ActualDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AttributeName-2">AttributeName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.SerializerOptions">SerializerOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><a href="#rendersMany.rendersMany-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>Includes an array of associated objects in the serialized output.</p>
56
56
  <p>For ObjectSerializer, explicit serializer configuration is always required
57
57
  since association schemas cannot be inferred from plain objects.</p>
58
58
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="rendersMany.rendersMany-1.ProvidedModelType-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ProvidedModelType</span> = <span class="tsd-signature-type">undefined</span></span></li><li><span><a id="rendersMany.rendersMany-1.ProvidedAttributeName-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ProvidedAttributeName</span><span class="tsd-signature-keyword"> extends </span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">undefined</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> = <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ProvidedModelType-1">ProvidedModelType</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">undefined</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Exclude</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ProvidedModelType-1">ProvidedModelType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">keyof </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="rendersMany.rendersMany-1.ActualDataType-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ActualDataType</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ProvidedModelType-1">ProvidedModelType</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><br/><span>    </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ProvidedModelType-1">ProvidedModelType</a></span></li><li><span><a id="rendersMany.rendersMany-1.AttributeName-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">AttributeName</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> = <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ProvidedAttributeName-1">ProvidedAttributeName</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">Exclude</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ActualDataType-1">ActualDataType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">keyof </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><span class="tsd-signature-symbol">&gt;</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ProvidedAttributeName-1">ProvidedAttributeName</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ActualDataType-1">ActualDataType</a></span></li><li><span><a id="rendersMany.rendersMany-1.AssociatedModelType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">AssociatedModelType</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.ActualDataType-1">ActualDataType</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AttributeName-2">AttributeName</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><span class="tsd-signature-symbol"> | </span><a href="../types/types.ViewModel.html" class="tsd-signature-type tsd-kind-type-alias">ViewModel</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></span></li><li><span><a id="rendersMany.rendersMany-1.SerializerOptions" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">SerializerOptions</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-keyword"> extends </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">dreamClass</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">serializerKey</span><span class="tsd-signature-symbol">?: </span><a href="../types/types.DreamOrViewModelSerializerKey.html" class="tsd-signature-type tsd-kind-type-alias">DreamOrViewModelSerializerKey</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">serializer</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SerializerType</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-keyword"> extends </span><a href="../types/types.ViewModel.html" class="tsd-signature-type tsd-kind-type-alias">ViewModel</a><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">{ </span><br/><span>            </span><span class="tsd-kind-property">serializerKey</span><span class="tsd-signature-symbol">?: </span><a href="../types/types.DreamOrViewModelSerializerKey.html" class="tsd-signature-type tsd-kind-type-alias">DreamOrViewModelSerializerKey</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>            </span><span class="tsd-kind-property">viewModelClass</span><span class="tsd-signature-symbol">: </span><a href="../types/types.ViewModelClass.html" class="tsd-signature-type tsd-kind-type-alias">ViewModelClass</a><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>            </span><span class="tsd-kind-property">serializer</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SerializerType</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">object</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">{ </span><br/><span>                </span><span class="tsd-kind-property">serializer</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SerializerType</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AssociatedModelType">AssociatedModelType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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-type">never</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">name</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersMany.rendersMany-1.AttributeName-2">AttributeName</a></span><div class="tsd-comment tsd-typography"><p>The association property name (should be an array)</p>
@@ -62,7 +62,7 @@ since association schemas cannot be inferred from plain objects.</p>
62
62
  </code><button type="button">Copy</button></pre>
63
63
 
64
64
  <p>See: <a href="https://your-docs-url.com/docs/serializers/associations">Serializer Associations Documentation</a></p>
65
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/serializer/builders/ObjectSerializerBuilder.ts#L305">src/serializer/builders/ObjectSerializerBuilder.ts:305</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rendersOne" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>renders<wbr/>One</span><a href="#rendersOne" 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="rendersOne.rendersOne-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">renders<wbr/>One</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ProvidedModelType-2">ProvidedModelType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ProvidedAttributeName-2">ProvidedAttributeName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ActualDataType-2">ActualDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AttributeName-3">AttributeName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.SerializerOptions-1">SerializerOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><a href="#rendersOne.rendersOne-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>Includes a single associated object in the serialized output.</p>
65
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/serializer/builders/ObjectSerializerBuilder.ts#L305">src/serializer/builders/ObjectSerializerBuilder.ts:305</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rendersOne" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>renders<wbr/>One</span><a href="#rendersOne" 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="rendersOne.rendersOne-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">renders<wbr/>One</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ProvidedModelType-2">ProvidedModelType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ProvidedAttributeName-2">ProvidedAttributeName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ActualDataType-2">ActualDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AttributeName-3">AttributeName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.SerializerOptions-1">SerializerOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system.ObjectSerializerBuilder.html" class="tsd-signature-type tsd-kind-class">ObjectSerializerBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.MaybeNullDataType-1">MaybeNullDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.PassthroughDataType-1">PassthroughDataType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><span class="tsd-signature-symbol">&gt;</span><a href="#rendersOne.rendersOne-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>Includes a single associated object in the serialized output.</p>
66
66
  <p>For ObjectSerializer, explicit serializer configuration is always required
67
67
  since association schemas cannot be inferred from plain objects.</p>
68
68
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="rendersOne.rendersOne-1.ProvidedModelType-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ProvidedModelType</span> = <span class="tsd-signature-type">undefined</span></span></li><li><span><a id="rendersOne.rendersOne-1.ProvidedAttributeName-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ProvidedAttributeName</span><span class="tsd-signature-keyword"> extends </span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">undefined</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> = <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ProvidedModelType-2">ProvidedModelType</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">undefined</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ProvidedModelType-2">ProvidedModelType</a></span></li><li><span><a id="rendersOne.rendersOne-1.ActualDataType-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ActualDataType</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ProvidedModelType-2">ProvidedModelType</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#constructor.new_ObjectSerializerBuilder.DataType-1">DataType</a><br/><span>    </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ProvidedModelType-2">ProvidedModelType</a></span></li><li><span><a id="rendersOne.rendersOne-1.AttributeName-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">AttributeName</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> = <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ProvidedAttributeName-2">ProvidedAttributeName</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ActualDataType-2">ActualDataType</a><br/><span>    </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ProvidedAttributeName-2">ProvidedAttributeName</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ActualDataType-2">ActualDataType</a></span></li><li><span><a id="rendersOne.rendersOne-1.AssociatedModelType-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">AssociatedModelType</span> = <span class="tsd-signature-type">Exclude</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.ActualDataType-2">ActualDataType</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AttributeName-3">AttributeName</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="rendersOne.rendersOne-1.SerializerOptions-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">SerializerOptions</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-keyword"> extends </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">dreamClass</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">serializerKey</span><span class="tsd-signature-symbol">?: </span><a href="../types/types.DreamOrViewModelSerializerKey.html" class="tsd-signature-type tsd-kind-type-alias">DreamOrViewModelSerializerKey</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">serializer</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SerializerType</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-keyword"> extends </span><a href="../types/types.ViewModel.html" class="tsd-signature-type tsd-kind-type-alias">ViewModel</a><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">{ </span><br/><span>            </span><span class="tsd-kind-property">serializerKey</span><span class="tsd-signature-symbol">?: </span><a href="../types/types.DreamOrViewModelSerializerKey.html" class="tsd-signature-type tsd-kind-type-alias">DreamOrViewModelSerializerKey</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>            </span><span class="tsd-kind-property">viewModelClass</span><span class="tsd-signature-symbol">: </span><a href="../types/types.ViewModelClass.html" class="tsd-signature-type tsd-kind-type-alias">ViewModelClass</a><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>            </span><span class="tsd-kind-property">serializer</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SerializerType</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">object</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">{ </span><br/><span>                </span><span class="tsd-kind-property">serializer</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SerializerType</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AssociatedModelType-1">AssociatedModelType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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-type">never</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">name</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="system.ObjectSerializerBuilder.html#rendersOne.rendersOne-1.AttributeName-3">AttributeName</a></span><div class="tsd-comment tsd-typography"><p>The association property name</p>
@@ -72,4 +72,4 @@ since association schemas cannot be inferred from plain objects.</p>
72
72
  </code><button type="button">Copy</button></pre>
73
73
 
74
74
  <p>See: <a href="https://your-docs-url.com/docs/serializers/associations">Serializer Associations Documentation</a></p>
75
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/serializer/builders/ObjectSerializerBuilder.ts#L216">src/serializer/builders/ObjectSerializerBuilder.ts:216</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#attributes" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attributes</span></a><a href="#data" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#passthroughData" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>passthrough<wbr/>Data</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="#attribute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>attribute</span></a><a href="#customAttribute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>custom<wbr/>Attribute</span></a><a href="#delegatedAttribute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delegated<wbr/>Attribute</span></a><a href="#render" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render</span></a><a href="#rendersMany" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>renders<wbr/>Many</span></a><a href="#rendersOne" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>renders<wbr/>One</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>
75
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/serializer/builders/ObjectSerializerBuilder.ts#L216">src/serializer/builders/ObjectSerializerBuilder.ts:216</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#attributes" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attributes</span></a><a href="#data" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#passthroughData" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>passthrough<wbr/>Data</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="#attribute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>attribute</span></a><a href="#customAttribute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>custom<wbr/>Attribute</span></a><a href="#delegatedAttribute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delegated<wbr/>Attribute</span></a><a href="#render" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render</span></a><a href="#rendersMany" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>renders<wbr/>Many</span></a><a href="#rendersOne" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>renders<wbr/>One</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>
package/docs/classes/utils.Encrypt.html CHANGED
@@ -1,6 +1,6 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Encrypt | @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/utils.html">utils</a></li><li><a href="utils.Encrypt.html">Encrypt</a></li></ul><h1>Class Encrypt</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/encrypt/index.ts#L7">src/encrypt/index.ts:7</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="utils.Encrypt.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>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Encrypt | @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/utils.html">utils</a></li><li><a href="utils.Encrypt.html">Encrypt</a></li></ul><h1>Class Encrypt</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/encrypt/index.ts#L7">src/encrypt/index.ts:7</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="utils.Encrypt.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="utils.Encrypt.html#decrypt" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>decrypt</span></a>
3
3
  <a href="utils.Encrypt.html#encrypt" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>encrypt</span></a>
4
4
  <a href="utils.Encrypt.html#generateKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Key</span></a>
5
5
  <a href="utils.Encrypt.html#validateKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Key</span></a>
6
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Encrypt" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Encrypt</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="utils.Encrypt.html" class="tsd-signature-type tsd-kind-class">Encrypt</a><a href="#constructor.new_Encrypt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="utils.Encrypt.html" class="tsd-signature-type tsd-kind-class">Encrypt</a></h4></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="decrypt" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>decrypt</span><a href="#decrypt" 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="decrypt.decrypt-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">decrypt</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="utils.Encrypt.html#decrypt.decrypt-1.RetType">RetType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">encrypted</span>, <span class="tsd-kind-parameter">__namedParameters</span>, <span class="tsd-kind-parameter">legacyOpts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="utils.Encrypt.html#decrypt.decrypt-1.RetType">RetType</a><a href="#decrypt.decrypt-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="decrypt.decrypt-1.RetType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetType</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">encrypted</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-type">DecryptOptions</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">legacyOpts</span>: <span class="tsd-signature-type">DecryptOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="utils.Encrypt.html#decrypt.decrypt-1.RetType">RetType</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/encrypt/index.ts#L25">src/encrypt/index.ts:25</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="encrypt" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>encrypt</span><a href="#encrypt" 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="encrypt.encrypt-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">encrypt</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#encrypt.encrypt-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <a href="../interfaces/types.EncryptOptions.html" class="tsd-signature-type tsd-kind-interface">EncryptOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/encrypt/index.ts#L8">src/encrypt/index.ts:8</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="generateKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>generate<wbr/>Key</span><a href="#generateKey" 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="generateKey.generateKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">generate<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">algorithm</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#generateKey.generateKey-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">algorithm</span>: <span class="tsd-signature-type">EncryptAESAlgorithm</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/encrypt/index.ts#L64">src/encrypt/index.ts:64</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="validateKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>validate<wbr/>Key</span><a href="#validateKey" 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="validateKey.validateKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">base64EncodedKey</span>, <span class="tsd-kind-parameter">algorithm</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#validateKey.validateKey-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">base64EncodedKey</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">algorithm</span>: <span class="tsd-signature-type">EncryptAESAlgorithm</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/8bb6bdf975b1f0e18432dd24a782d5e48193e865/src/encrypt/index.ts#L83">src/encrypt/index.ts:83</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="#decrypt" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>decrypt</span></a><a href="#encrypt" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>encrypt</span></a><a href="#generateKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Key</span></a><a href="#validateKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Key</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>
6
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Encrypt" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Encrypt</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="utils.Encrypt.html" class="tsd-signature-type tsd-kind-class">Encrypt</a><a href="#constructor.new_Encrypt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="utils.Encrypt.html" class="tsd-signature-type tsd-kind-class">Encrypt</a></h4></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="decrypt" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>decrypt</span><a href="#decrypt" 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="decrypt.decrypt-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">decrypt</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="utils.Encrypt.html#decrypt.decrypt-1.RetType">RetType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">encrypted</span>, <span class="tsd-kind-parameter">__namedParameters</span>, <span class="tsd-kind-parameter">legacyOpts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="utils.Encrypt.html#decrypt.decrypt-1.RetType">RetType</a><a href="#decrypt.decrypt-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="decrypt.decrypt-1.RetType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetType</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">encrypted</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-type">DecryptOptions</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">legacyOpts</span>: <span class="tsd-signature-type">DecryptOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="utils.Encrypt.html#decrypt.decrypt-1.RetType">RetType</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/encrypt/index.ts#L25">src/encrypt/index.ts:25</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="encrypt" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>encrypt</span><a href="#encrypt" 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="encrypt.encrypt-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">encrypt</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#encrypt.encrypt-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <a href="../interfaces/types.EncryptOptions.html" class="tsd-signature-type tsd-kind-interface">EncryptOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/encrypt/index.ts#L8">src/encrypt/index.ts:8</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="generateKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>generate<wbr/>Key</span><a href="#generateKey" 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="generateKey.generateKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">generate<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">algorithm</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#generateKey.generateKey-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">algorithm</span>: <span class="tsd-signature-type">EncryptAESAlgorithm</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/encrypt/index.ts#L64">src/encrypt/index.ts:64</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="validateKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>validate<wbr/>Key</span><a href="#validateKey" 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="validateKey.validateKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">base64EncodedKey</span>, <span class="tsd-kind-parameter">algorithm</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#validateKey.validateKey-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">base64EncodedKey</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">algorithm</span>: <span class="tsd-signature-type">EncryptAESAlgorithm</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf3c0627e6864b9219e8c9619b1b83fcdc529d11/src/encrypt/index.ts#L83">src/encrypt/index.ts:83</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="#decrypt" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>decrypt</span></a><a href="#encrypt" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>encrypt</span></a><a href="#generateKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Key</span></a><a href="#validateKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Key</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>