@loopback/docs 4.0.4 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (628) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/package.json +6 -6
  3. package/site/CHANGELOG.md +1 -0
  4. package/site/MONOREPO.md +1 -0
  5. package/site/Polymorphic-relations.md +123 -0
  6. package/site/ReferencesMany-relation.md +379 -0
  7. package/site/Relation-generator.md +1 -0
  8. package/site/Relations.md +1 -0
  9. package/site/apidocs/apiconnect.apiconnectspecenhancer._constructor_.md +1 -1
  10. package/site/apidocs/authentication-jwt.myuserservice.md +1 -1
  11. package/site/apidocs/authentication-jwt.refreshtoken._constructor_.md +1 -1
  12. package/site/apidocs/authentication-jwt.refreshtokenrepository.md +1 -1
  13. package/site/apidocs/authentication-jwt.user._constructor_.md +1 -1
  14. package/site/apidocs/authentication-jwt.usercredentials._constructor_.md +1 -1
  15. package/site/apidocs/authentication-jwt.usercredentialsrepository.md +1 -1
  16. package/site/apidocs/authentication-jwt.userrepository.md +1 -1
  17. package/site/apidocs/authentication-passport.strategyadapter._constructor_.md +1 -1
  18. package/site/apidocs/authentication-passport.strategyadapter.authenticate.md +1 -1
  19. package/site/apidocs/authentication.authenticateactionprovider._constructor_.md +1 -1
  20. package/site/apidocs/authentication.authenticateactionprovider.md +1 -1
  21. package/site/apidocs/authentication.authenticationmiddlewareprovider.md +1 -1
  22. package/site/apidocs/authentication.authenticationstrategyprovider._constructor_.md +1 -1
  23. package/site/apidocs/authentication.authenticationstrategyprovider.md +1 -1
  24. package/site/apidocs/authentication.authmetadataprovider._constructor_.md +1 -1
  25. package/site/apidocs/authentication.authmetadataprovider.md +1 -1
  26. package/site/apidocs/authorization.authorizationinterceptor._constructor_.md +1 -1
  27. package/site/apidocs/authorization.authorizationinterceptor.md +1 -1
  28. package/site/apidocs/authorization.authorizemethoddecoratorfactory.md +1 -1
  29. package/site/apidocs/authorization.authorizemethoddecoratorfactory.mergewithown.md +2 -2
  30. package/site/apidocs/boot.bootstrapper._constructor_.md +1 -1
  31. package/site/apidocs/boot.bootstrapper.boot.md +2 -2
  32. package/site/apidocs/boot.controllerbooter._constructor_.md +1 -1
  33. package/site/apidocs/boot.createbooterforcomponentapplication.md +1 -1
  34. package/site/apidocs/boot.createcomponentapplicationbooterbinding.md +1 -1
  35. package/site/apidocs/boot.datasourcebooter._constructor_.md +1 -1
  36. package/site/apidocs/boot.interceptorproviderbooter._constructor_.md +1 -1
  37. package/site/apidocs/boot.lifecycleobserverbooter._constructor_.md +1 -1
  38. package/site/apidocs/boot.modelapibooter._constructor_.md +1 -1
  39. package/site/apidocs/boot.modelbooter._constructor_.md +1 -1
  40. package/site/apidocs/boot.repositorybooter._constructor_.md +1 -1
  41. package/site/apidocs/boot.servicebooter._constructor_.md +1 -1
  42. package/site/apidocs/context-explorer.contextexplorercomponent._constructor_.md +1 -1
  43. package/site/apidocs/context-explorer.contextgraph._constructor_.md +1 -1
  44. package/site/apidocs/context-explorer.rendergraph.md +1 -1
  45. package/site/apidocs/context.asglobalinterceptor.md +1 -1
  46. package/site/apidocs/context.asresolutionoptions.md +1 -1
  47. package/site/apidocs/context.asserttargettype.md +1 -1
  48. package/site/apidocs/context.binding._constructor_.md +1 -1
  49. package/site/apidocs/context.binding.getvalue.md +1 -1
  50. package/site/apidocs/context.binding.getvalue_1.md +1 -1
  51. package/site/apidocs/context.binding.inspect.md +1 -1
  52. package/site/apidocs/context.bindingkey.buildkeyforconfig.md +1 -1
  53. package/site/apidocs/context.bindingkey.create.md +1 -1
  54. package/site/apidocs/context.bindingkey.generate.md +1 -1
  55. package/site/apidocs/context.bindingtemplatefor.md +1 -1
  56. package/site/apidocs/context.comparebindingsbytag.md +2 -2
  57. package/site/apidocs/context.comparebyorder.md +1 -1
  58. package/site/apidocs/context.configbindingkeyfor.md +1 -1
  59. package/site/apidocs/context.configurationresolver.getconfigasvalueorpromise.md +2 -2
  60. package/site/apidocs/context.context._constructor_.md +2 -2
  61. package/site/apidocs/context.context._mergewithparent.md +1 -1
  62. package/site/apidocs/context.context.configure.md +1 -1
  63. package/site/apidocs/context.context.createview.md +2 -2
  64. package/site/apidocs/context.context.find.md +1 -1
  65. package/site/apidocs/context.context.findorcreatebinding.md +1 -1
  66. package/site/apidocs/context.context.get.md +1 -1
  67. package/site/apidocs/context.context.getbinding_1.md +1 -1
  68. package/site/apidocs/context.context.getconfig.md +2 -2
  69. package/site/apidocs/context.context.getconfigasvalueorpromise.md +2 -2
  70. package/site/apidocs/context.context.getconfigsync.md +2 -2
  71. package/site/apidocs/context.context.getsync.md +1 -1
  72. package/site/apidocs/context.context.getsync_1.md +1 -1
  73. package/site/apidocs/context.context.inspect.md +1 -1
  74. package/site/apidocs/context.contextsubscriptionmanager.notifyobservers.md +1 -1
  75. package/site/apidocs/context.contextsubscriptionmanager.waituntilpendingnotificationsdone.md +1 -1
  76. package/site/apidocs/context.contextview._constructor_.md +2 -2
  77. package/site/apidocs/context.contextview.asgetter.md +1 -1
  78. package/site/apidocs/context.contextview.resolve.md +1 -1
  79. package/site/apidocs/context.contextview.singlevalue.md +1 -1
  80. package/site/apidocs/context.contextview.values.md +1 -1
  81. package/site/apidocs/context.createbindingfromclass.md +1 -1
  82. package/site/apidocs/context.createproxywithinterceptors.md +3 -3
  83. package/site/apidocs/context.createviewgetter.md +1 -1
  84. package/site/apidocs/context.createviewgetter_1.md +2 -2
  85. package/site/apidocs/context.defaultconfigurationresolver.getconfigasvalueorpromise.md +2 -2
  86. package/site/apidocs/context.describeinjectedarguments.md +1 -1
  87. package/site/apidocs/context.filterbykey.md +1 -1
  88. package/site/apidocs/context.genericinterceptorchain._constructor__1.md +1 -1
  89. package/site/apidocs/context.genericinterceptorchain.invokeinterceptors.md +1 -1
  90. package/site/apidocs/context.globalinterceptor.md +1 -1
  91. package/site/apidocs/context.injectionmetadata.md +1 -1
  92. package/site/apidocs/context.instantiateclass.md +2 -2
  93. package/site/apidocs/context.interceptionhandler._constructor_.md +3 -3
  94. package/site/apidocs/context.interceptionhandler.md +1 -1
  95. package/site/apidocs/context.interceptor.md +1 -1
  96. package/site/apidocs/context.invocationcontext._constructor_.md +1 -1
  97. package/site/apidocs/context.invocationcontext.invoketargetmethod.md +1 -1
  98. package/site/apidocs/context.invokemethod.md +2 -2
  99. package/site/apidocs/context.invokemethodwithinterceptors.md +1 -1
  100. package/site/apidocs/context.isbindingtagfilter.md +1 -1
  101. package/site/apidocs/context.jsonarray.md +1 -1
  102. package/site/apidocs/context.jsonobject.md +1 -1
  103. package/site/apidocs/context.proxysource.md +1 -1
  104. package/site/apidocs/context.registerinterceptor.md +1 -1
  105. package/site/apidocs/context.resolutionsession.fork.md +1 -1
  106. package/site/apidocs/context.resolutionsession.runwithbinding.md +1 -1
  107. package/site/apidocs/context.resolutionsession.runwithinjection.md +1 -1
  108. package/site/apidocs/context.resolveinjectedarguments.md +2 -2
  109. package/site/apidocs/context.resolveinjectedproperties.md +1 -1
  110. package/site/apidocs/context.sortbindingsbyphase.md +2 -2
  111. package/site/apidocs/context.trycatchfinally.md +2 -2
  112. package/site/apidocs/core.addextension.md +1 -1
  113. package/site/apidocs/core.application._constructor__1.md +2 -2
  114. package/site/apidocs/core.application.component.md +1 -1
  115. package/site/apidocs/core.application.controller.md +1 -1
  116. package/site/apidocs/core.application.interceptor.md +1 -1
  117. package/site/apidocs/core.application.lifecycleobserver.md +1 -1
  118. package/site/apidocs/core.application.server.md +1 -1
  119. package/site/apidocs/core.application.service.md +1 -1
  120. package/site/apidocs/core.createservicebinding.md +1 -1
  121. package/site/apidocs/core.extensions.list.md +2 -2
  122. package/site/apidocs/core.extensions.view.md +2 -2
  123. package/site/apidocs/core.lifecycleobserverregistry._constructor_.md +1 -1
  124. package/site/apidocs/core.lifecycleobserverregistry.notifygroups.md +1 -1
  125. package/site/apidocs/core.service.md +2 -2
  126. package/site/apidocs/express.asmiddleware.md +1 -1
  127. package/site/apidocs/express.buildname.md +2 -2
  128. package/site/apidocs/express.createinterceptor.md +1 -1
  129. package/site/apidocs/express.createmiddleware.md +1 -1
  130. package/site/apidocs/express.createmiddlewarebinding.md +1 -1
  131. package/site/apidocs/express.createmiddlewareinterceptorbinding.md +1 -1
  132. package/site/apidocs/express.defineinterceptorprovider.md +2 -2
  133. package/site/apidocs/express.expressapplication._constructor_.md +1 -1
  134. package/site/apidocs/express.expressmiddlewareinterceptorprovider._constructor_.md +1 -1
  135. package/site/apidocs/express.expressmiddlewareinterceptorprovider.md +1 -1
  136. package/site/apidocs/express.expressserver._constructor_.md +2 -2
  137. package/site/apidocs/express.getmiddlewarecontext.md +1 -1
  138. package/site/apidocs/express.invokemiddlewareprovider.action.md +1 -1
  139. package/site/apidocs/express.invokemiddlewareprovider.value.md +1 -1
  140. package/site/apidocs/express.middleware.md +1 -1
  141. package/site/apidocs/express.middlewarebindingoptions.md +1 -1
  142. package/site/apidocs/express.middlewarechain.md +1 -1
  143. package/site/apidocs/express.middlewarecontext._constructor_.md +2 -2
  144. package/site/apidocs/express.middlewareinterceptorbindingoptions.md +1 -1
  145. package/site/apidocs/express.middlewareregistry.expressmiddleware.md +1 -1
  146. package/site/apidocs/express.middlewareregistry.expressmiddleware_1.md +2 -2
  147. package/site/apidocs/express.middlewareregistry.middleware.md +1 -1
  148. package/site/apidocs/express.middlewareview._constructor_.md +1 -1
  149. package/site/apidocs/express.registerexpressmiddleware.md +2 -2
  150. package/site/apidocs/express.registerexpressmiddlewareinterceptor.md +2 -2
  151. package/site/apidocs/filter.filterbuilder._constructor_.md +1 -1
  152. package/site/apidocs/filter.inclusion.md +1 -0
  153. package/site/apidocs/filter.inclusion.targettype.md +21 -0
  154. package/site/apidocs/filter.wherebuilder._constructor_.md +1 -1
  155. package/site/apidocs/filter.wherebuilder.exists.md +1 -1
  156. package/site/apidocs/graphql.graphqlserver._constructor_.md +2 -2
  157. package/site/apidocs/graphql.graphqlserver.exportgraphqlschema.md +2 -2
  158. package/site/apidocs/graphql.graphqlserver.resolver.md +1 -1
  159. package/site/apidocs/graphql.registerresolver.md +1 -1
  160. package/site/apidocs/health.healthcomponent._constructor_.md +1 -1
  161. package/site/apidocs/http-server.basehttpoptions.md +1 -1
  162. package/site/apidocs/http-server.httpserver._constructor_.md +1 -1
  163. package/site/apidocs/logging.winstonloggerprovider._constructor_.md +1 -1
  164. package/site/apidocs/logging.winstonloggerprovider.md +1 -1
  165. package/site/apidocs/metadata.classdecoratorfactory.createdecorator.md +1 -1
  166. package/site/apidocs/metadata.classdecoratorfactory.md +1 -1
  167. package/site/apidocs/metadata.classdecoratorfactory.mergewithinherited.md +2 -2
  168. package/site/apidocs/metadata.classdecoratorfactory.mergewithown.md +2 -2
  169. package/site/apidocs/metadata.decoratorfactory._constructor_.md +1 -1
  170. package/site/apidocs/metadata.decoratorfactory._createdecorator.md +1 -1
  171. package/site/apidocs/metadata.decoratorfactory.decorate.md +2 -2
  172. package/site/apidocs/metadata.decoratorfactory.duplicatedecorationerror.md +2 -2
  173. package/site/apidocs/metadata.decoratorfactory.getnumberofparameters.md +1 -1
  174. package/site/apidocs/metadata.decoratorfactory.gettargetname.md +2 -2
  175. package/site/apidocs/metadata.decoratorfactory.mergewithinherited.md +2 -2
  176. package/site/apidocs/metadata.decoratorfactory.mergewithown.md +2 -2
  177. package/site/apidocs/metadata.metadatainspector.definemetadata.md +1 -1
  178. package/site/apidocs/metadata.metadatainspector.getallmethodmetadata.md +1 -1
  179. package/site/apidocs/metadata.metadatainspector.getallparametermetadata.md +2 -2
  180. package/site/apidocs/metadata.metadatainspector.getallpropertymetadata.md +1 -1
  181. package/site/apidocs/metadata.metadatainspector.getclassmetadata.md +1 -1
  182. package/site/apidocs/metadata.metadatainspector.getmethodmetadata.md +2 -2
  183. package/site/apidocs/metadata.metadatainspector.getparametermetadata.md +1 -1
  184. package/site/apidocs/metadata.metadatainspector.getpropertymetadata.md +1 -1
  185. package/site/apidocs/metadata.methoddecoratorfactory.createdecorator.md +1 -1
  186. package/site/apidocs/metadata.methoddecoratorfactory.md +1 -1
  187. package/site/apidocs/metadata.methoddecoratorfactory.mergewithinherited.md +2 -2
  188. package/site/apidocs/metadata.methoddecoratorfactory.mergewithown.md +2 -2
  189. package/site/apidocs/metadata.methodmultidecoratorfactory.md +1 -1
  190. package/site/apidocs/metadata.methodmultidecoratorfactory.mergewithinherited.md +1 -1
  191. package/site/apidocs/metadata.methodmultidecoratorfactory.mergewithown.md +2 -2
  192. package/site/apidocs/metadata.methodparameterdecoratorfactory.createdecorator.md +1 -1
  193. package/site/apidocs/metadata.methodparameterdecoratorfactory.md +1 -1
  194. package/site/apidocs/metadata.methodparameterdecoratorfactory.mergewithinherited.md +2 -2
  195. package/site/apidocs/metadata.methodparameterdecoratorfactory.mergewithown.md +2 -2
  196. package/site/apidocs/metadata.namespacedreflect._constructor_.md +1 -1
  197. package/site/apidocs/metadata.namespacedreflect.decorate.md +2 -2
  198. package/site/apidocs/metadata.namespacedreflect.definemetadata.md +1 -1
  199. package/site/apidocs/metadata.namespacedreflect.deletemetadata.md +1 -1
  200. package/site/apidocs/metadata.namespacedreflect.getmetadata.md +1 -1
  201. package/site/apidocs/metadata.namespacedreflect.getmetadatakeys.md +1 -1
  202. package/site/apidocs/metadata.namespacedreflect.getownmetadata.md +1 -1
  203. package/site/apidocs/metadata.namespacedreflect.getownmetadatakeys.md +1 -1
  204. package/site/apidocs/metadata.namespacedreflect.hasmetadata.md +1 -1
  205. package/site/apidocs/metadata.namespacedreflect.hasownmetadata.md +1 -1
  206. package/site/apidocs/metadata.parameterdecoratorfactory.createdecorator.md +1 -1
  207. package/site/apidocs/metadata.parameterdecoratorfactory.md +1 -1
  208. package/site/apidocs/metadata.parameterdecoratorfactory.mergewithinherited.md +2 -2
  209. package/site/apidocs/metadata.parameterdecoratorfactory.mergewithown.md +2 -2
  210. package/site/apidocs/metadata.propertydecoratorfactory.createdecorator.md +1 -1
  211. package/site/apidocs/metadata.propertydecoratorfactory.md +1 -1
  212. package/site/apidocs/metadata.propertydecoratorfactory.mergewithinherited.md +2 -2
  213. package/site/apidocs/metadata.propertydecoratorfactory.mergewithown.md +2 -2
  214. package/site/apidocs/metrics.metricscomponent._constructor_.md +1 -1
  215. package/site/apidocs/openapi-spec-builder.componentsspecbuilder.md +1 -1
  216. package/site/apidocs/openapi-spec-builder.openapispecbuilder.md +1 -1
  217. package/site/apidocs/openapi-spec-builder.openapispecbuilder.withoperationreturningstring.md +1 -1
  218. package/site/apidocs/openapi-spec-builder.operationspecbuilder.md +1 -1
  219. package/site/apidocs/openapi-spec-builder.operationspecbuilder.withstringresponse.md +1 -1
  220. package/site/apidocs/openapi-v3.del.md +1 -1
  221. package/site/apidocs/openapi-v3.deprecated.md +1 -1
  222. package/site/apidocs/openapi-v3.get.md +1 -1
  223. package/site/apidocs/openapi-v3.getfilterschemafor.md +1 -1
  224. package/site/apidocs/openapi-v3.getmodelschemaref.md +1 -1
  225. package/site/apidocs/openapi-v3.jsontoschemaobject.md +1 -1
  226. package/site/apidocs/openapi-v3.oasenhancerservice._constructor_.md +1 -1
  227. package/site/apidocs/openapi-v3.oasenhancerservice.applyallenhancers.md +1 -1
  228. package/site/apidocs/openapi-v3.operation.md +1 -1
  229. package/site/apidocs/openapi-v3.param.filter.md +1 -1
  230. package/site/apidocs/openapi-v3.param.where.md +1 -1
  231. package/site/apidocs/openapi-v3.patch.md +1 -1
  232. package/site/apidocs/openapi-v3.post.md +1 -1
  233. package/site/apidocs/openapi-v3.put.md +1 -1
  234. package/site/apidocs/pooling.getpooledvalue.md +1 -1
  235. package/site/apidocs/pooling.poolfactory.md +1 -1
  236. package/site/apidocs/pooling.poolingservice.acquire.md +1 -1
  237. package/site/apidocs/pooling.poolingservice.run.md +1 -1
  238. package/site/apidocs/repository-json-schema.getfieldsjsonschemafor.md +1 -1
  239. package/site/apidocs/repository-json-schema.getfilterjsonschemafor.md +1 -1
  240. package/site/apidocs/repository-json-schema.getjsonschema.md +1 -1
  241. package/site/apidocs/repository-json-schema.getjsonschemaref.md +1 -1
  242. package/site/apidocs/repository-json-schema.getscopefilterjsonschemafor.md +1 -1
  243. package/site/apidocs/repository-json-schema.getwherejsonschemafor.md +1 -1
  244. package/site/apidocs/repository-json-schema.modeltojsonschema.md +1 -1
  245. package/site/apidocs/repository.anytype.md +1 -1
  246. package/site/apidocs/repository.applicationwithrepositories.component.md +1 -1
  247. package/site/apidocs/repository.applicationwithrepositories.datasource.md +1 -1
  248. package/site/apidocs/repository.applicationwithrepositories.migrateschema.md +1 -1
  249. package/site/apidocs/repository.applicationwithrepositories.repository.md +1 -1
  250. package/site/apidocs/repository.arraytype.md +1 -1
  251. package/site/apidocs/repository.belongsto.md +2 -2
  252. package/site/apidocs/repository.belongstodefinition.md +1 -0
  253. package/site/apidocs/repository.belongstodefinition.polymorphic.md +25 -0
  254. package/site/apidocs/repository.belongstorepository.get.md +4 -2
  255. package/site/apidocs/repository.booleantype.md +1 -1
  256. package/site/apidocs/repository.buffertype.coerce.md +1 -1
  257. package/site/apidocs/repository.buffertype.md +1 -1
  258. package/site/apidocs/repository.buffertype.serialize.md +1 -1
  259. package/site/apidocs/repository.buildmodeldefinition.md +1 -1
  260. package/site/apidocs/repository.connector.execute.md +1 -1
  261. package/site/apidocs/repository.createbelongstoaccessor.md +5 -3
  262. package/site/apidocs/repository.createbelongstoinclusionresolver.md +4 -2
  263. package/site/apidocs/repository.createhasmanythroughrepositoryfactory.md +4 -2
  264. package/site/apidocs/repository.createhasonerepositoryfactory.md +6 -2
  265. package/site/apidocs/repository.createreferencesmanyaccessor.md +36 -0
  266. package/site/apidocs/repository.createreferencesmanyinclusionresolver.md +37 -0
  267. package/site/apidocs/repository.crudconnector.count.md +2 -2
  268. package/site/apidocs/repository.crudconnector.create.md +1 -1
  269. package/site/apidocs/repository.crudconnector.createall.md +1 -1
  270. package/site/apidocs/repository.crudconnector.delete.md +1 -1
  271. package/site/apidocs/repository.crudconnector.deleteall.md +2 -2
  272. package/site/apidocs/repository.crudconnector.deletebyid.md +1 -1
  273. package/site/apidocs/repository.crudconnector.exists.md +1 -1
  274. package/site/apidocs/repository.crudconnector.find.md +2 -2
  275. package/site/apidocs/repository.crudconnector.findbyid.md +1 -1
  276. package/site/apidocs/repository.crudconnector.replacebyid.md +1 -1
  277. package/site/apidocs/repository.crudconnector.save.md +1 -1
  278. package/site/apidocs/repository.crudconnector.update.md +1 -1
  279. package/site/apidocs/repository.crudconnector.updateall.md +2 -2
  280. package/site/apidocs/repository.crudconnector.updatebyid.md +1 -1
  281. package/site/apidocs/repository.crudrepository.count.md +2 -2
  282. package/site/apidocs/repository.crudrepository.create.md +1 -1
  283. package/site/apidocs/repository.crudrepository.createall.md +1 -1
  284. package/site/apidocs/repository.crudrepository.deleteall.md +2 -2
  285. package/site/apidocs/repository.crudrepository.find.md +2 -2
  286. package/site/apidocs/repository.crudrepository.md +1 -1
  287. package/site/apidocs/repository.crudrepository.updateall.md +2 -2
  288. package/site/apidocs/repository.crudrepositoryimpl.count.md +2 -2
  289. package/site/apidocs/repository.crudrepositoryimpl.create.md +1 -1
  290. package/site/apidocs/repository.crudrepositoryimpl.createall.md +1 -1
  291. package/site/apidocs/repository.crudrepositoryimpl.delete.md +1 -1
  292. package/site/apidocs/repository.crudrepositoryimpl.deleteall.md +2 -2
  293. package/site/apidocs/repository.crudrepositoryimpl.deletebyid.md +1 -1
  294. package/site/apidocs/repository.crudrepositoryimpl.execute.md +1 -1
  295. package/site/apidocs/repository.crudrepositoryimpl.exists.md +1 -1
  296. package/site/apidocs/repository.crudrepositoryimpl.find.md +2 -2
  297. package/site/apidocs/repository.crudrepositoryimpl.findbyid.md +2 -2
  298. package/site/apidocs/repository.crudrepositoryimpl.md +1 -1
  299. package/site/apidocs/repository.crudrepositoryimpl.replacebyid.md +1 -1
  300. package/site/apidocs/repository.crudrepositoryimpl.save.md +1 -1
  301. package/site/apidocs/repository.crudrepositoryimpl.update.md +1 -1
  302. package/site/apidocs/repository.crudrepositoryimpl.updateall.md +2 -2
  303. package/site/apidocs/repository.crudrepositoryimpl.updatebyid.md +1 -1
  304. package/site/apidocs/repository.datetype.md +1 -1
  305. package/site/apidocs/repository.defaultbelongstorepository._constructor_.md +5 -2
  306. package/site/apidocs/repository.defaultbelongstorepository.get.md +4 -2
  307. package/site/apidocs/repository.defaultbelongstorepository.gettargetrepository.md +3 -1
  308. package/site/apidocs/repository.defaultbelongstorepository.gettargetrepositorydict.md +23 -0
  309. package/site/apidocs/repository.defaultbelongstorepository.md +5 -3
  310. package/site/apidocs/repository.defaultbelongstorepository.targetresolver.md +21 -0
  311. package/site/apidocs/repository.defaultcrudrepository._createbelongstoaccessorfor.md +4 -2
  312. package/site/apidocs/repository.defaultcrudrepository._createhasmanyrepositoryfactoryfor.md +2 -2
  313. package/site/apidocs/repository.defaultcrudrepository._createhasonerepositoryfactoryfor.md +4 -2
  314. package/site/apidocs/repository.defaultcrudrepository._createreferencesmanyaccessorfor.md +40 -0
  315. package/site/apidocs/repository.defaultcrudrepository.count.md +2 -2
  316. package/site/apidocs/repository.defaultcrudrepository.create.md +1 -1
  317. package/site/apidocs/repository.defaultcrudrepository.createall.md +1 -1
  318. package/site/apidocs/repository.defaultcrudrepository.createbelongstoaccessorfor.md +4 -2
  319. package/site/apidocs/repository.defaultcrudrepository.createhasmanyrepositoryfactoryfor.md +2 -2
  320. package/site/apidocs/repository.defaultcrudrepository.createhasmanythroughrepositoryfactoryfor.md +5 -3
  321. package/site/apidocs/repository.defaultcrudrepository.createhasonerepositoryfactoryfor.md +4 -2
  322. package/site/apidocs/repository.defaultcrudrepository.createreferencesmanyaccessorfor.md +35 -0
  323. package/site/apidocs/repository.defaultcrudrepository.delete.md +1 -1
  324. package/site/apidocs/repository.defaultcrudrepository.deleteall.md +2 -2
  325. package/site/apidocs/repository.defaultcrudrepository.deletebyid.md +1 -1
  326. package/site/apidocs/repository.defaultcrudrepository.ensurepersistable.md +1 -1
  327. package/site/apidocs/repository.defaultcrudrepository.entitytodata.md +1 -1
  328. package/site/apidocs/repository.defaultcrudrepository.execute.md +1 -1
  329. package/site/apidocs/repository.defaultcrudrepository.exists.md +1 -1
  330. package/site/apidocs/repository.defaultcrudrepository.find.md +2 -2
  331. package/site/apidocs/repository.defaultcrudrepository.findbyid.md +2 -2
  332. package/site/apidocs/repository.defaultcrudrepository.findone.md +2 -2
  333. package/site/apidocs/repository.defaultcrudrepository.includerelatedmodels.md +2 -2
  334. package/site/apidocs/repository.defaultcrudrepository.md +10 -8
  335. package/site/apidocs/repository.defaultcrudrepository.normalizefilter.md +1 -1
  336. package/site/apidocs/repository.defaultcrudrepository.replacebyid.md +1 -1
  337. package/site/apidocs/repository.defaultcrudrepository.save.md +1 -1
  338. package/site/apidocs/repository.defaultcrudrepository.update.md +1 -1
  339. package/site/apidocs/repository.defaultcrudrepository.updateall.md +2 -2
  340. package/site/apidocs/repository.defaultcrudrepository.updatebyid.md +1 -1
  341. package/site/apidocs/repository.defaulthasmanyrepository.create.md +1 -1
  342. package/site/apidocs/repository.defaulthasmanyrepository.delete.md +2 -2
  343. package/site/apidocs/repository.defaulthasmanyrepository.find.md +2 -2
  344. package/site/apidocs/repository.defaulthasmanyrepository.md +1 -1
  345. package/site/apidocs/repository.defaulthasmanyrepository.patch.md +2 -2
  346. package/site/apidocs/repository.defaulthasmanythroughrepository._constructor_.md +6 -2
  347. package/site/apidocs/repository.defaulthasmanythroughrepository.create.md +3 -1
  348. package/site/apidocs/repository.defaulthasmanythroughrepository.delete.md +7 -3
  349. package/site/apidocs/repository.defaulthasmanythroughrepository.find.md +7 -3
  350. package/site/apidocs/repository.defaulthasmanythroughrepository.gettargetrepository.md +3 -1
  351. package/site/apidocs/repository.defaulthasmanythroughrepository.gettargetrepositorydict.md +23 -0
  352. package/site/apidocs/repository.defaulthasmanythroughrepository.link.md +1 -1
  353. package/site/apidocs/repository.defaulthasmanythroughrepository.md +6 -3
  354. package/site/apidocs/repository.defaulthasmanythroughrepository.patch.md +11 -5
  355. package/site/apidocs/repository.defaulthasmanythroughrepository.targetresolver.md +21 -0
  356. package/site/apidocs/repository.defaulthasmanythroughrepository.throughresolver.md +21 -0
  357. package/site/apidocs/repository.defaulthasmanythroughrepository.unlink.md +1 -1
  358. package/site/apidocs/repository.defaulthasmanythroughrepository.unlinkall.md +1 -1
  359. package/site/apidocs/repository.defaulthasonerepository._constructor_.md +5 -2
  360. package/site/apidocs/repository.defaulthasonerepository.create.md +4 -2
  361. package/site/apidocs/repository.defaulthasonerepository.delete.md +4 -2
  362. package/site/apidocs/repository.defaulthasonerepository.get.md +5 -3
  363. package/site/apidocs/repository.defaulthasonerepository.gettargetrepository.md +3 -1
  364. package/site/apidocs/repository.defaulthasonerepository.gettargetrepositorydict.md +23 -0
  365. package/site/apidocs/repository.defaulthasonerepository.md +5 -3
  366. package/site/apidocs/repository.defaulthasonerepository.patch.md +7 -3
  367. package/site/apidocs/repository.defaulthasonerepository.targetresolver.md +21 -0
  368. package/site/apidocs/repository.defaultkeyvaluerepository.delete.md +1 -1
  369. package/site/apidocs/repository.defaultkeyvaluerepository.deleteall.md +1 -1
  370. package/site/apidocs/repository.defaultkeyvaluerepository.expire.md +1 -1
  371. package/site/apidocs/repository.defaultkeyvaluerepository.get.md +1 -1
  372. package/site/apidocs/repository.defaultkeyvaluerepository.keys.md +2 -2
  373. package/site/apidocs/repository.defaultkeyvaluerepository.md +1 -1
  374. package/site/apidocs/repository.defaultkeyvaluerepository.set.md +1 -1
  375. package/site/apidocs/repository.defaultkeyvaluerepository.ttl.md +1 -1
  376. package/site/apidocs/repository.defaultreferencesmanyrepository._constructor_.md +31 -0
  377. package/site/apidocs/repository.defaultreferencesmanyrepository.constraint.md +21 -0
  378. package/site/apidocs/repository.defaultreferencesmanyrepository.get.md +32 -0
  379. package/site/apidocs/repository.defaultreferencesmanyrepository.gettargetrepository.md +21 -0
  380. package/site/apidocs/repository.defaultreferencesmanyrepository.md +42 -0
  381. package/site/apidocs/repository.defaulttransactionalrepository.begintransaction.md +1 -1
  382. package/site/apidocs/repository.defaulttransactionalrepository.md +2 -2
  383. package/site/apidocs/repository.embedsmany.md +1 -1
  384. package/site/apidocs/repository.embedsone.md +1 -1
  385. package/site/apidocs/repository.entitycrudrepository.delete.md +1 -1
  386. package/site/apidocs/repository.entitycrudrepository.deletebyid.md +1 -1
  387. package/site/apidocs/repository.entitycrudrepository.exists.md +1 -1
  388. package/site/apidocs/repository.entitycrudrepository.findbyid.md +2 -2
  389. package/site/apidocs/repository.entitycrudrepository.md +1 -1
  390. package/site/apidocs/repository.entitycrudrepository.replacebyid.md +1 -1
  391. package/site/apidocs/repository.entitycrudrepository.save.md +1 -1
  392. package/site/apidocs/repository.entitycrudrepository.update.md +1 -1
  393. package/site/apidocs/repository.entitycrudrepository.updatebyid.md +1 -1
  394. package/site/apidocs/repository.entitynotfounderror._constructor_.md +1 -1
  395. package/site/apidocs/repository.entityrepository.md +1 -1
  396. package/site/apidocs/repository.executablerepository.execute.md +1 -1
  397. package/site/apidocs/repository.executablerepository.md +1 -1
  398. package/site/apidocs/repository.findbyforeignkeys.md +2 -2
  399. package/site/apidocs/repository.hasmany.md +1 -1
  400. package/site/apidocs/repository.hasmanydefinition.md +1 -1
  401. package/site/apidocs/repository.hasmanydefinition.through.md +3 -0
  402. package/site/apidocs/repository.hasmanyrepository.create.md +1 -1
  403. package/site/apidocs/repository.hasmanyrepository.delete.md +2 -2
  404. package/site/apidocs/repository.hasmanyrepository.find.md +2 -2
  405. package/site/apidocs/repository.hasmanyrepository.patch.md +2 -2
  406. package/site/apidocs/repository.hasmanythroughrepository.create.md +3 -1
  407. package/site/apidocs/repository.hasmanythroughrepository.delete.md +7 -3
  408. package/site/apidocs/repository.hasmanythroughrepository.find.md +7 -3
  409. package/site/apidocs/repository.hasmanythroughrepository.link.md +1 -1
  410. package/site/apidocs/repository.hasmanythroughrepository.patch.md +11 -5
  411. package/site/apidocs/repository.hasmanythroughrepository.unlink.md +1 -1
  412. package/site/apidocs/repository.hasmanythroughrepository.unlinkall.md +1 -1
  413. package/site/apidocs/repository.hasone.md +1 -1
  414. package/site/apidocs/repository.hasonedefinition.md +1 -0
  415. package/site/apidocs/repository.hasonedefinition.polymorphic.md +25 -0
  416. package/site/apidocs/repository.hasonerepository.create.md +4 -2
  417. package/site/apidocs/repository.hasonerepository.delete.md +4 -2
  418. package/site/apidocs/repository.hasonerepository.get.md +5 -3
  419. package/site/apidocs/repository.hasonerepository.patch.md +7 -3
  420. package/site/apidocs/repository.includefieldifnot.md +33 -0
  421. package/site/apidocs/repository.includerelatedmodels.md +2 -2
  422. package/site/apidocs/repository.invalidpolymorphismerror._constructor_.md +32 -0
  423. package/site/apidocs/repository.invalidpolymorphismerror.code.md +21 -0
  424. package/site/apidocs/repository.invalidpolymorphismerror.md +35 -0
  425. package/site/apidocs/repository.invalidrelationerror._constructor_.md +1 -1
  426. package/site/apidocs/repository.isinvalidpolymorphismerror.md +32 -0
  427. package/site/apidocs/repository.keyvaluerepository.delete.md +1 -1
  428. package/site/apidocs/repository.keyvaluerepository.deleteall.md +1 -1
  429. package/site/apidocs/repository.keyvaluerepository.expire.md +1 -1
  430. package/site/apidocs/repository.keyvaluerepository.get.md +1 -1
  431. package/site/apidocs/repository.keyvaluerepository.keys.md +2 -2
  432. package/site/apidocs/repository.keyvaluerepository.md +1 -1
  433. package/site/apidocs/repository.keyvaluerepository.set.md +1 -1
  434. package/site/apidocs/repository.keyvaluerepository.ttl.md +1 -1
  435. package/site/apidocs/repository.kvconnector.delete.md +1 -1
  436. package/site/apidocs/repository.kvconnector.deleteall.md +1 -1
  437. package/site/apidocs/repository.kvconnector.expire.md +1 -1
  438. package/site/apidocs/repository.kvconnector.get.md +1 -1
  439. package/site/apidocs/repository.kvconnector.iteratekeys.md +2 -2
  440. package/site/apidocs/repository.kvconnector.keys.md +1 -1
  441. package/site/apidocs/repository.kvconnector.set.md +1 -1
  442. package/site/apidocs/repository.kvconnector.ttl.md +1 -1
  443. package/site/apidocs/repository.md +13 -4
  444. package/site/apidocs/repository.model._constructor_.md +1 -1
  445. package/site/apidocs/repository.model.md +1 -1
  446. package/site/apidocs/repository.model.toobject.md +1 -1
  447. package/site/apidocs/repository.modeldefinition.md +1 -0
  448. package/site/apidocs/repository.modeldefinition.referencesmany.md +35 -0
  449. package/site/apidocs/repository.modelmetadatahelper.getmodelmetadata.md +1 -1
  450. package/site/apidocs/repository.modeltype.md +1 -1
  451. package/site/apidocs/repository.nulltype.md +1 -1
  452. package/site/apidocs/repository.numbertype.md +1 -1
  453. package/site/apidocs/repository.objecttype.md +1 -1
  454. package/site/apidocs/repository.property.array.md +1 -1
  455. package/site/apidocs/repository.referencesmany.md +5 -3
  456. package/site/apidocs/repository.referencesmanyaccessor.inclusionresolver.md +23 -0
  457. package/site/apidocs/repository.referencesmanyaccessor.md +28 -0
  458. package/site/apidocs/repository.referencesmanydefinition.keyfrom.md +21 -0
  459. package/site/apidocs/repository.referencesmanydefinition.keyto.md +25 -0
  460. package/site/apidocs/repository.referencesmanydefinition.md +32 -0
  461. package/site/apidocs/repository.referencesmanydefinition.targetsmany.md +21 -0
  462. package/site/apidocs/repository.referencesmanydefinition.type.md +21 -0
  463. package/site/apidocs/repository.referencesmanyrepository.get.md +36 -0
  464. package/site/apidocs/repository.referencesmanyrepository.md +30 -0
  465. package/site/apidocs/repository.referencesone.md +1 -1
  466. package/site/apidocs/repository.relation.md +1 -1
  467. package/site/apidocs/repository.relationmetadata.md +2 -2
  468. package/site/apidocs/repository.repositorymetadata._constructor_.md +1 -1
  469. package/site/apidocs/repository.repositorymixindoc.datasource.md +1 -1
  470. package/site/apidocs/repository.repositorymixindoc.migrateschema.md +1 -1
  471. package/site/apidocs/repository.stringtype.md +1 -1
  472. package/site/apidocs/repository.transactionalrepository.begintransaction.md +1 -1
  473. package/site/apidocs/repository.transactionalrepository.md +1 -1
  474. package/site/apidocs/repository.type.coerce.md +1 -1
  475. package/site/apidocs/repository.type.iscoercible.md +1 -1
  476. package/site/apidocs/repository.type.serialize.md +1 -1
  477. package/site/apidocs/repository.uniontype.md +1 -1
  478. package/site/apidocs/rest-explorer.restexplorercomponent._constructor_.md +1 -1
  479. package/site/apidocs/rest-msgpack.msgpackbodyparser._constructor_.md +1 -1
  480. package/site/apidocs/rest-msgpack.msgpackbodyparsercomponent._constructor_.md +1 -1
  481. package/site/apidocs/rest.controllerroute._constructor_.md +2 -2
  482. package/site/apidocs/rest.createbodyparserbinding.md +1 -1
  483. package/site/apidocs/rest.createroutesforcontroller.md +1 -1
  484. package/site/apidocs/rest.findroutemiddlewareprovider.md +1 -1
  485. package/site/apidocs/rest.httphandler._constructor_.md +1 -1
  486. package/site/apidocs/rest.httphandler.registercontroller.md +1 -1
  487. package/site/apidocs/rest.infospecenhancer._constructor_.md +1 -1
  488. package/site/apidocs/rest.invokemethodmiddlewareprovider.md +1 -1
  489. package/site/apidocs/rest.jsonbodyparser._constructor_.md +1 -1
  490. package/site/apidocs/rest.middlewaresequence._constructor_.md +1 -1
  491. package/site/apidocs/rest.parsejson.md +2 -2
  492. package/site/apidocs/rest.parseoperationargs.md +2 -2
  493. package/site/apidocs/rest.parseparamsmiddlewareprovider.md +1 -1
  494. package/site/apidocs/rest.rawbodyparser._constructor_.md +1 -1
  495. package/site/apidocs/rest.redirectroute._constructor_.md +1 -1
  496. package/site/apidocs/rest.regexprouter._constructor_.md +1 -1
  497. package/site/apidocs/rest.rejectprovider.value.md +1 -1
  498. package/site/apidocs/rest.requestbodyparser._constructor_.md +2 -2
  499. package/site/apidocs/rest.requestcontext._constructor_.md +1 -1
  500. package/site/apidocs/rest.restapplication._constructor__1.md +2 -2
  501. package/site/apidocs/rest.restapplication.basepath.md +1 -1
  502. package/site/apidocs/rest.restapplication.bodyparser.md +1 -1
  503. package/site/apidocs/rest.restapplication.exportopenapispec.md +2 -2
  504. package/site/apidocs/rest.restapplication.expressmiddleware.md +1 -1
  505. package/site/apidocs/rest.restapplication.expressmiddleware_1.md +2 -2
  506. package/site/apidocs/rest.restapplication.middleware.md +1 -1
  507. package/site/apidocs/rest.restapplication.mountexpressrouter.md +1 -1
  508. package/site/apidocs/rest.restapplication.redirect.md +1 -1
  509. package/site/apidocs/rest.restapplication.server.md +1 -1
  510. package/site/apidocs/rest.restapplication.static.md +1 -1
  511. package/site/apidocs/rest.restcomponent._constructor_.md +1 -1
  512. package/site/apidocs/rest.resthttperrors.invaliddata.md +1 -1
  513. package/site/apidocs/rest.resthttperrors.unsupportedmediatype.md +1 -1
  514. package/site/apidocs/rest.restserver._constructor_.md +1 -1
  515. package/site/apidocs/rest.restserver.addopenapispecendpoint.md +1 -1
  516. package/site/apidocs/rest.restserver.basepath.md +1 -1
  517. package/site/apidocs/rest.restserver.bodyparser.md +1 -1
  518. package/site/apidocs/rest.restserver.exportopenapispec.md +2 -2
  519. package/site/apidocs/rest.restserver.getapispec.md +1 -1
  520. package/site/apidocs/rest.restserver.mountexpressrouter.md +1 -1
  521. package/site/apidocs/rest.restserver.redirect.md +1 -1
  522. package/site/apidocs/rest.restserver.static.md +1 -1
  523. package/site/apidocs/rest.routesource.md +1 -1
  524. package/site/apidocs/rest.routingtable._constructor_.md +2 -2
  525. package/site/apidocs/rest.routingtable.registercontroller.md +1 -1
  526. package/site/apidocs/rest.sanitizejsonparse.md +2 -2
  527. package/site/apidocs/rest.sendresponsemiddlewareprovider.md +1 -1
  528. package/site/apidocs/rest.textbodyparser._constructor_.md +1 -1
  529. package/site/apidocs/rest.trierouter._constructor_.md +1 -1
  530. package/site/apidocs/rest.urlencodedbodyparser._constructor_.md +1 -1
  531. package/site/apidocs/rest.validateapipath.md +1 -1
  532. package/site/apidocs/rest.validaterequestbody.md +3 -3
  533. package/site/apidocs/rest.validatevalueagainstschema.md +2 -2
  534. package/site/apidocs/service-proxy.applicationwithservices.component.md +1 -1
  535. package/site/apidocs/service-proxy.applicationwithservices.serviceprovider.md +1 -1
  536. package/site/apidocs/socketio.socketioapplication._constructor_.md +1 -1
  537. package/site/apidocs/socketio.socketioapplication.server.md +1 -1
  538. package/site/apidocs/socketio.socketioinvokemethodprovider.md +1 -1
  539. package/site/apidocs/socketio.socketiorejectprovider.md +1 -1
  540. package/site/apidocs/socketio.socketiosendprovider.md +1 -1
  541. package/site/apidocs/socketio.socketioserver._constructor_.md +1 -1
  542. package/site/apidocs/socketio.socketioserver.route.md +1 -1
  543. package/site/apidocs/testlab.createunexpectedhttperrorlogger.md +1 -1
  544. package/site/apidocs/testlab.givenhttpserverconfig.md +1 -1
  545. package/site/apidocs/testlab.httpgetasync.md +1 -1
  546. package/site/apidocs/testlab.httpsgetasync.md +1 -1
  547. package/site/apidocs/testlab.stubexpresscontext.md +1 -1
  548. package/site/apidocs/testlab.stubhandlercontext.md +1 -1
  549. package/site/apidocs/testlab.testsandbox._constructor_.md +1 -1
  550. package/site/apidocs/testlab.testsandbox.copyfile.md +2 -2
  551. package/site/apidocs/tsdocs.getpackages.md +1 -1
  552. package/site/apidocs/tsdocs.getpackageswithtsdocs.md +1 -1
  553. package/site/apidocs/tsdocs.runextractorformonorepo.md +1 -1
  554. package/site/apidocs/tsdocs.runextractorforpackage.md +2 -2
  555. package/site/apidocs/tsdocs.updateapidocs.md +1 -1
  556. package/site/apidocs/typeorm.getmodelschema.md +1 -1
  557. package/site/apidocs/typeorm.typeorm.repository.md +1 -1
  558. package/site/apidocs/typeorm.typeormcomponent._constructor_.md +1 -1
  559. package/site/apidocs/typeorm.typeormconnectionbooter._constructor_.md +1 -1
  560. package/site/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +8 -0
  561. package/site/changelogs/examples/access-control-migration/CHANGELOG.md +8 -0
  562. package/site/changelogs/examples/binding-resolution/CHANGELOG.md +8 -0
  563. package/site/changelogs/examples/context/CHANGELOG.md +8 -0
  564. package/site/changelogs/examples/express-composition/CHANGELOG.md +8 -0
  565. package/site/changelogs/examples/file-transfer/CHANGELOG.md +8 -0
  566. package/site/changelogs/examples/graphql/CHANGELOG.md +8 -0
  567. package/site/changelogs/examples/greeter-extension/CHANGELOG.md +8 -0
  568. package/site/changelogs/examples/greeting-app/CHANGELOG.md +8 -0
  569. package/site/changelogs/examples/hello-world/CHANGELOG.md +8 -0
  570. package/site/changelogs/examples/lb3-application/CHANGELOG.md +8 -0
  571. package/site/changelogs/examples/log-extension/CHANGELOG.md +8 -0
  572. package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +8 -0
  573. package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +8 -0
  574. package/site/changelogs/examples/passport-login/CHANGELOG.md +8 -0
  575. package/site/changelogs/examples/references-many/CHANGELOG.md +15 -0
  576. package/site/changelogs/examples/rest-crud/CHANGELOG.md +8 -0
  577. package/site/changelogs/examples/rpc-server/CHANGELOG.md +8 -0
  578. package/site/changelogs/examples/soap-calculator/CHANGELOG.md +8 -0
  579. package/site/changelogs/examples/socketio/CHANGELOG.md +8 -0
  580. package/site/changelogs/examples/todo/CHANGELOG.md +8 -0
  581. package/site/changelogs/examples/todo-jwt/CHANGELOG.md +8 -0
  582. package/site/changelogs/examples/todo-list/CHANGELOG.md +8 -0
  583. package/site/changelogs/examples/validation-app/CHANGELOG.md +8 -0
  584. package/site/changelogs/examples/webpack/CHANGELOG.md +8 -0
  585. package/site/changelogs/extensions/apiconnect/CHANGELOG.md +8 -0
  586. package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +8 -0
  587. package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +8 -0
  588. package/site/changelogs/extensions/context-explorer/CHANGELOG.md +8 -0
  589. package/site/changelogs/extensions/cron/CHANGELOG.md +8 -0
  590. package/site/changelogs/extensions/graphql/CHANGELOG.md +8 -0
  591. package/site/changelogs/extensions/health/CHANGELOG.md +8 -0
  592. package/site/changelogs/extensions/logging/CHANGELOG.md +8 -0
  593. package/site/changelogs/extensions/metrics/CHANGELOG.md +8 -0
  594. package/site/changelogs/extensions/pooling/CHANGELOG.md +8 -0
  595. package/site/changelogs/extensions/socketio/CHANGELOG.md +8 -0
  596. package/site/changelogs/extensions/typeorm/CHANGELOG.md +8 -0
  597. package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +0 -271
  598. package/site/changelogs/packages/authentication/CHANGELOG.md +8 -0
  599. package/site/changelogs/packages/authorization/CHANGELOG.md +8 -0
  600. package/site/changelogs/packages/boot/CHANGELOG.md +8 -0
  601. package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +8 -0
  602. package/site/changelogs/packages/build/CHANGELOG.md +14 -0
  603. package/site/changelogs/packages/cli/CHANGELOG.md +11 -0
  604. package/site/changelogs/packages/context/CHANGELOG.md +8 -0
  605. package/site/changelogs/packages/core/CHANGELOG.md +8 -0
  606. package/site/changelogs/packages/eslint-config/CHANGELOG.md +19 -0
  607. package/site/changelogs/packages/express/CHANGELOG.md +8 -0
  608. package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +8 -0
  609. package/site/changelogs/packages/http-server/CHANGELOG.md +8 -0
  610. package/site/changelogs/packages/metadata/CHANGELOG.md +8 -0
  611. package/site/changelogs/packages/model-api-builder/CHANGELOG.md +8 -0
  612. package/site/changelogs/packages/monorepo/CHANGELOG.md +14 -0
  613. package/site/changelogs/packages/openapi-spec-builder/CHANGELOG.md +8 -0
  614. package/site/changelogs/packages/openapi-v3/CHANGELOG.md +8 -0
  615. package/site/changelogs/packages/repository/CHANGELOG.md +8 -0
  616. package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +8 -0
  617. package/site/changelogs/packages/repository-tests/CHANGELOG.md +8 -0
  618. package/site/changelogs/packages/rest/CHANGELOG.md +8 -0
  619. package/site/changelogs/packages/rest-crud/CHANGELOG.md +8 -0
  620. package/site/changelogs/packages/rest-explorer/CHANGELOG.md +8 -0
  621. package/site/changelogs/packages/security/CHANGELOG.md +8 -0
  622. package/site/changelogs/packages/service-proxy/CHANGELOG.md +8 -0
  623. package/site/changelogs/packages/testlab/CHANGELOG.md +14 -0
  624. package/site/changelogs/packages/tsdocs/CHANGELOG.md +8 -0
  625. package/site/decorators/Decorators_repository.md +25 -0
  626. package/site/migration/models/relations.md +1 -2
  627. package/site/readmes/loopback-next/examples/references-many/README.md +49 -0
  628. package/site/sidebars/lb4_sidebar.yml +4 -0
@@ -27,6 +27,6 @@ constructor(strategy: Strategy, name: string, userProfileFactory?: UserProfileFa
27
27
  | --- | --- | --- |
28
28
  | strategy | Strategy | instance of a class which implements a [passport-strategy](http://passportjs.org/)<!-- -->. |
29
29
  | name | string | |
30
- | userProfileFactory | [UserProfileFactory](./authentication.userprofilefactory.md)<!-- -->&lt;U&gt; | |
30
+ | userProfileFactory | [UserProfileFactory](./authentication.userprofilefactory.md)<!-- -->&lt;U&gt; | <i>(Optional)</i> |
31
31
 
32
32
 
@@ -26,7 +26,7 @@ authenticate(request: Request, options?: AuthenticateOptions): Promise<UserProfi
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | request | Request | The incoming request. |
29
- | options | AuthenticateOptions | Options passed through to strategy.authenticate. |
29
+ | options | AuthenticateOptions | <i>(Optional)</i> Options passed through to strategy.authenticate. |
30
30
 
31
31
  <b>Returns:</b>
32
32
 
@@ -29,6 +29,6 @@ constructor(getStrategies: Getter<AuthenticationStrategy | AuthenticationStrateg
29
29
  | setCurrentUser | [Setter](./context.setter.md)<!-- -->&lt;[UserProfile](./security.userprofile.md)<!-- -->&gt; | |
30
30
  | setRedirectUrl | [Setter](./context.setter.md)<!-- -->&lt;string&gt; | |
31
31
  | setRedirectStatus | [Setter](./context.setter.md)<!-- -->&lt;number&gt; | |
32
- | options | [AuthenticationOptions](./authentication.authenticationoptions.md) | |
32
+ | options | [AuthenticationOptions](./authentication.authenticationoptions.md) | <i>(Optional)</i> |
33
33
 
34
34
 
@@ -20,7 +20,7 @@ Provides the authentication action for a sequence
20
20
  ```typescript
21
21
  export declare class AuthenticateActionProvider implements Provider<AuthenticateFn>
22
22
  ```
23
- <b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticateFn](./authentication.authenticatefn.md)<!-- -->&gt;
23
+ <b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticateFn](./authentication.authenticatefn.md)
24
24
 
25
25
  ## Example
26
26
 
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication.authenticationmiddlewareprovider.h
18
18
  ```typescript
19
19
  export declare class AuthenticationMiddlewareProvider implements Provider<Middleware>
20
20
  ```
21
- <b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)<!-- -->&gt;
21
+ <b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)
22
22
 
23
23
  ## Constructors
24
24
 
@@ -26,6 +26,6 @@ constructor(authenticationStrategies: Getter<AuthenticationStrategy[]>, metadata
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | authenticationStrategies | [Getter](./context.getter.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\]&gt; | |
29
- | metadata | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined | |
29
+ | metadata | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined | <i>(Optional)</i> |
30
30
 
31
31
 
@@ -22,7 +22,7 @@ It declares an extension point to which all authentication strategy implementati
22
22
  ```typescript
23
23
  export declare class AuthenticationStrategyProvider implements Provider<AuthenticationStrategy[] | undefined>
24
24
  ```
25
- <b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\] \| undefined&gt;
25
+ <b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md)
26
26
 
27
27
  ## Example
28
28
 
@@ -27,6 +27,6 @@ constructor(controllerClass: Constructor<{}>, methodName: string, options?: Auth
27
27
  | --- | --- | --- |
28
28
  | controllerClass | [Constructor](./context.constructor.md)<!-- -->&lt;{}&gt; | |
29
29
  | methodName | string | |
30
- | options | [AuthenticationOptions](./authentication.authenticationoptions.md) | |
30
+ | options | [AuthenticationOptions](./authentication.authenticationoptions.md) | <i>(Optional)</i> |
31
31
 
32
32
 
@@ -20,7 +20,7 @@ Provides authentication metadata of a controller method
20
20
  ```typescript
21
21
  export declare class AuthMetadataProvider implements Provider<AuthenticationMetadata[] | undefined>
22
22
  ```
23
- <b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined&gt;
23
+ <b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticationMetadata](./authentication.authenticationmetadata.md)
24
24
 
25
25
  ## Example
26
26
 
@@ -25,6 +25,6 @@ constructor(options?: AuthorizationOptions);
25
25
 
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
- | options | [AuthorizationOptions](./authorization.authorizationoptions.md) | |
28
+ | options | [AuthorizationOptions](./authorization.authorizationoptions.md) | <i>(Optional)</i> |
29
29
 
30
30
 
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authorization.authorizationinterceptor.html
18
18
  ```typescript
19
19
  export declare class AuthorizationInterceptor implements Provider<Interceptor>
20
20
  ```
21
- <b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Interceptor](./context.interceptor.md)<!-- -->&gt;
21
+ <b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Interceptor](./context.interceptor.md)
22
22
 
23
23
  ## Constructors
24
24
 
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authorization.authorizemethoddecoratorfactory.htm
18
18
  ```typescript
19
19
  export declare class AuthorizeMethodDecoratorFactory extends MethodDecoratorFactory<AuthorizationMetadata>
20
20
  ```
21
- <b>Extends:</b> [MethodDecoratorFactory](./metadata.methoddecoratorfactory.md)<!-- -->&lt;[AuthorizationMetadata](./authorization.authorizationmetadata.md)<!-- -->&gt;
21
+ <b>Extends:</b> [MethodDecoratorFactory](./metadata.methoddecoratorfactory.md)<!-- -->&lt;[AuthorizationMetadata](./authorization.authorizationmetadata.md)
22
22
 
23
23
  ## Methods
24
24
 
@@ -25,8 +25,8 @@ protected mergeWithOwn(ownMetadata: MetadataMap<AuthorizationMetadata>, target:
25
25
  | --- | --- | --- |
26
26
  | ownMetadata | [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;[AuthorizationMetadata](./authorization.authorizationmetadata.md)<!-- -->&gt; | |
27
27
  | target | Object | |
28
- | methodName | string | |
29
- | methodDescriptor | TypedPropertyDescriptor&lt;any&gt; \| number | |
28
+ | methodName | string | <i>(Optional)</i> |
29
+ | methodDescriptor | TypedPropertyDescriptor&lt;any&gt; \| number | <i>(Optional)</i> |
30
30
 
31
31
  <b>Returns:</b>
32
32
 
@@ -27,6 +27,6 @@ constructor(app: Application & Bootable, projectRoot: string, bootOptions?: Boot
27
27
  | --- | --- | --- |
28
28
  | app | [Application](./core.application.md) &amp; [Bootable](./boot.bootable.md) | |
29
29
  | projectRoot | string | |
30
- | bootOptions | [BootOptions](./boot.bootoptions.md) | |
30
+ | bootOptions | [BootOptions](./boot.bootoptions.md) | <i>(Optional)</i> |
31
31
 
32
32
 
@@ -25,8 +25,8 @@ boot(execOptions?: BootExecutionOptions, ctx?: Context): Promise<Context>;
25
25
 
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
- | execOptions | [BootExecutionOptions](./boot.bootexecutionoptions.md) | Execution options for boot. These determine the phases and booters that are run. |
29
- | ctx | [Context](./context.context.md) | Optional Context to use to resolve bindings. This is primarily useful when running app.boot() again but with different settings (in particular phases) such as 'start' / 'stop'. Using a returned Context from a previous boot call allows DI to retrieve the same instances of Booters previously used as they are bound using a CONTEXT scope. This is important as Booter instances may maintain state. |
28
+ | execOptions | [BootExecutionOptions](./boot.bootexecutionoptions.md) | <i>(Optional)</i> Execution options for boot. These determine the phases and booters that are run. |
29
+ | ctx | [Context](./context.context.md) | <i>(Optional)</i> Optional Context to use to resolve bindings. This is primarily useful when running app.boot() again but with different settings (in particular phases) such as 'start' / 'stop'. Using a returned Context from a previous boot call allows DI to retrieve the same instances of Booters previously used as they are bound using a CONTEXT scope. This is important as Booter instances may maintain state. |
30
30
 
31
31
  <b>Returns:</b>
32
32
 
@@ -27,6 +27,6 @@ constructor(app: Application, projectRoot: string, controllerConfig?: ArtifactOp
27
27
  | --- | --- | --- |
28
28
  | app | [Application](./core.application.md) | |
29
29
  | projectRoot | string | |
30
- | controllerConfig | [ArtifactOptions](./boot.artifactoptions.md) | |
30
+ | controllerConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
31
31
 
32
32
 
@@ -26,7 +26,7 @@ export declare function createBooterForComponentApplication(componentApp: Applic
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | componentApp | [Application](./core.application.md) &amp; [Bootable](./boot.bootable.md) | The application exposing a component |
29
- | filter | [BindingFilter](./context.bindingfilter.md) | Binding filter to selected bindings to be added |
29
+ | filter | [BindingFilter](./context.bindingfilter.md) | <i>(Optional)</i> Binding filter to selected bindings to be added |
30
30
 
31
31
  <b>Returns:</b>
32
32
 
@@ -26,7 +26,7 @@ export declare function createComponentApplicationBooterBinding(componentApp: Ap
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | componentApp | [Application](./core.application.md) &amp; [Bootable](./boot.bootable.md) | The application exposing a component |
29
- | filter | [BindingFilter](./context.bindingfilter.md) | Binding filter to selected bindings to be added |
29
+ | filter | [BindingFilter](./context.bindingfilter.md) | <i>(Optional)</i> Binding filter to selected bindings to be added |
30
30
 
31
31
  <b>Returns:</b>
32
32
 
@@ -27,6 +27,6 @@ constructor(app: ApplicationWithRepositories, projectRoot: string, datasourceCon
27
27
  | --- | --- | --- |
28
28
  | app | [ApplicationWithRepositories](./repository.applicationwithrepositories.md) | |
29
29
  | projectRoot | string | |
30
- | datasourceConfig | [ArtifactOptions](./boot.artifactoptions.md) | |
30
+ | datasourceConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
31
31
 
32
32
 
@@ -27,6 +27,6 @@ constructor(app: Application, projectRoot: string, interceptorConfig?: ArtifactO
27
27
  | --- | --- | --- |
28
28
  | app | [Application](./core.application.md) | |
29
29
  | projectRoot | string | |
30
- | interceptorConfig | [ArtifactOptions](./boot.artifactoptions.md) | |
30
+ | interceptorConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
31
31
 
32
32
 
@@ -27,6 +27,6 @@ constructor(app: Application, projectRoot: string, observerConfig?: ArtifactOpti
27
27
  | --- | --- | --- |
28
28
  | app | [Application](./core.application.md) | |
29
29
  | projectRoot | string | |
30
- | observerConfig | [ArtifactOptions](./boot.artifactoptions.md) | |
30
+ | observerConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
31
31
 
32
32
 
@@ -28,6 +28,6 @@ constructor(app: ApplicationWithRepositories, projectRoot: string, getModelApiBu
28
28
  | app | [ApplicationWithRepositories](./repository.applicationwithrepositories.md) | |
29
29
  | projectRoot | string | |
30
30
  | getModelApiBuilders | [Getter](./context.getter.md)<!-- -->&lt;[ModelApiBuilder](./model-api-builder.modelapibuilder.md)<!-- -->\[\]&gt; | |
31
- | booterConfig | [ArtifactOptions](./boot.artifactoptions.md) | |
31
+ | booterConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
32
32
 
33
33
 
@@ -27,6 +27,6 @@ constructor(app: ApplicationWithRepositories, projectRoot: string, modelConfig?:
27
27
  | --- | --- | --- |
28
28
  | app | [ApplicationWithRepositories](./repository.applicationwithrepositories.md) | |
29
29
  | projectRoot | string | |
30
- | modelConfig | [ArtifactOptions](./boot.artifactoptions.md) | |
30
+ | modelConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
31
31
 
32
32
 
@@ -27,6 +27,6 @@ constructor(app: ApplicationWithRepositories, projectRoot: string, repositoryOpt
27
27
  | --- | --- | --- |
28
28
  | app | [ApplicationWithRepositories](./repository.applicationwithrepositories.md) | |
29
29
  | projectRoot | string | |
30
- | repositoryOptions | [ArtifactOptions](./boot.artifactoptions.md) | |
30
+ | repositoryOptions | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
31
31
 
32
32
 
@@ -27,6 +27,6 @@ constructor(app: ApplicationWithServices, projectRoot: string, serviceConfig?: A
27
27
  | --- | --- | --- |
28
28
  | app | [ApplicationWithServices](./service-proxy.applicationwithservices.md) | |
29
29
  | projectRoot | string | |
30
- | serviceConfig | [ArtifactOptions](./boot.artifactoptions.md) | |
30
+ | serviceConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
31
31
 
32
32
 
@@ -26,6 +26,6 @@ constructor(application: RestApplication, explorerConfig?: ContextExplorerConfig
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | application | [RestApplication](./rest.restapplication.md) | |
29
- | explorerConfig | [ContextExplorerConfig](./context-explorer.contextexplorerconfig.md) | |
29
+ | explorerConfig | [ContextExplorerConfig](./context-explorer.contextexplorerconfig.md) | <i>(Optional)</i> |
30
30
 
31
31
 
@@ -26,6 +26,6 @@ constructor(ctx: JSONObject, options?: ContextGraphOptions);
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | ctx | [JSONObject](./context.jsonobject.md) | |
29
- | options | [ContextGraphOptions](./context-explorer.contextgraphoptions.md) | |
29
+ | options | [ContextGraphOptions](./context-explorer.contextgraphoptions.md) | <i>(Optional)</i> |
30
30
 
31
31
 
@@ -29,7 +29,7 @@ export declare function renderGraph(graph: string, options?: {
29
29
  | Parameter | Type | Description |
30
30
  | --- | --- | --- |
31
31
  | graph | string | A graph in dot format |
32
- | options | { engine?: string; format?: string; } | Options for the rendering |
32
+ | options | { engine?: string; format?: string; } | <i>(Optional)</i> Options for the rendering |
33
33
 
34
34
  <b>Returns:</b>
35
35
 
@@ -25,7 +25,7 @@ export declare function asGlobalInterceptor(group?: string): BindingTemplate;
25
25
 
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
- | group | string | Group for ordering the interceptor |
28
+ | group | string | <i>(Optional)</i> Group for ordering the interceptor |
29
29
 
30
30
  <b>Returns:</b>
31
31
 
@@ -25,7 +25,7 @@ export declare function asResolutionOptions(optionsOrSession?: ResolutionOptions
25
25
 
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
- | optionsOrSession | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) | resolution options or session |
28
+ | optionsOrSession | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) | <i>(Optional)</i> resolution options or session |
29
29
 
30
30
  <b>Returns:</b>
31
31
 
@@ -27,7 +27,7 @@ export declare function assertTargetType(injection: Readonly<Injection>, expecte
27
27
  | --- | --- | --- |
28
28
  | injection | Readonly&lt;[Injection](./context.injection.md)<!-- -->&gt; | Injection information |
29
29
  | expectedType | Function | Expected type |
30
- | expectedTypeName | string | Name of the expected type to be used in the error |
30
+ | expectedTypeName | string | <i>(Optional)</i> Name of the expected type to be used in the error |
31
31
 
32
32
  <b>Returns:</b>
33
33
 
@@ -26,6 +26,6 @@ constructor(key: BindingAddress<T>, isLocked?: boolean);
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | key | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;T&gt; | |
29
- | isLocked | boolean | |
29
+ | isLocked | boolean | <i>(Optional)</i> |
30
30
 
31
31
 
@@ -30,7 +30,7 @@ getValue(ctx: Context, session?: ResolutionSession): ValueOrPromise<T>;
30
30
  | Parameter | Type | Description |
31
31
  | --- | --- | --- |
32
32
  | ctx | [Context](./context.context.md) | Context for the resolution |
33
- | session | [ResolutionSession](./context.resolutionsession.md) | Optional session for binding and dependency resolution |
33
+ | session | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> Optional session for binding and dependency resolution |
34
34
 
35
35
  <b>Returns:</b>
36
36
 
@@ -26,7 +26,7 @@ getValue(ctx: Context, options?: ResolutionOptions): ValueOrPromise<T | undefine
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | ctx | [Context](./context.context.md) | Context for the resolution |
29
- | options | [ResolutionOptions](./context.resolutionoptions.md) | Optional options for binding and dependency resolution |
29
+ | options | [ResolutionOptions](./context.resolutionoptions.md) | <i>(Optional)</i> Optional options for binding and dependency resolution |
30
30
 
31
31
  <b>Returns:</b>
32
32
 
@@ -25,7 +25,7 @@ inspect(options?: BindingInspectOptions): JSONObject;
25
25
 
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
- | options | [BindingInspectOptions](./context.bindinginspectoptions.md) | Options to control what information should be included |
28
+ | options | [BindingInspectOptions](./context.bindinginspectoptions.md) | <i>(Optional)</i> Options to control what information should be included |
29
29
 
30
30
  <b>Returns:</b>
31
31
 
@@ -25,7 +25,7 @@ static buildKeyForConfig<T>(key?: BindingAddress): BindingAddress<T>;
25
25
 
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
- | key | [BindingAddress](./context.bindingaddress.md) | Key of the target binding to be configured |
28
+ | key | [BindingAddress](./context.bindingaddress.md) | <i>(Optional)</i> Key of the target binding to be configured |
29
29
 
30
30
  <b>Returns:</b>
31
31
 
@@ -26,7 +26,7 @@ static create<V>(key: string, propertyPath?: string): BindingKey<V>;
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | key | string | The binding key. When propertyPath is not provided, the key is allowed to contain propertyPath as encoded via <code>BindingKey#toString()</code> |
29
- | propertyPath | string | Optional path to a deep property of the bound value. |
29
+ | propertyPath | string | <i>(Optional)</i> Optional path to a deep property of the bound value. |
30
30
 
31
31
  <b>Returns:</b>
32
32
 
@@ -27,7 +27,7 @@ static generate<T>(namespace?: string): BindingKey<T>;
27
27
 
28
28
  | Parameter | Type | Description |
29
29
  | --- | --- | --- |
30
- | namespace | string | Namespace for the binding |
30
+ | namespace | string | <i>(Optional)</i> Namespace for the binding |
31
31
 
32
32
  <b>Returns:</b>
33
33
 
@@ -26,7 +26,7 @@ export declare function bindingTemplateFor<T>(cls: Constructor<T | Provider<T>>
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | cls | [Constructor](./context.constructor.md)<!-- -->&lt;T \| [Provider](./context.provider.md)<!-- -->&lt;T&gt;&gt; \| [DynamicValueProviderClass](./context.dynamicvalueproviderclass.md)<!-- -->&lt;T&gt; | A class with optional <code>@injectable</code> |
29
- | options | [BindingFromClassOptions](./context.bindingfromclassoptions.md) | |
29
+ | options | [BindingFromClassOptions](./context.bindingfromclassoptions.md) | <i>(Optional)</i> |
30
30
 
31
31
  <b>Returns:</b>
32
32
 
@@ -25,8 +25,8 @@ export declare function compareBindingsByTag(phaseTagName?: string, orderOfPhase
25
25
 
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
- | phaseTagName | string | Name of the binding tag for phase |
29
- | orderOfPhases | (string \| symbol)\[\] | An array of phase names as the predefined order |
28
+ | phaseTagName | string | <i>(Optional)</i> Name of the binding tag for phase |
29
+ | orderOfPhases | (string \| symbol)\[\] | <i>(Optional)</i> An array of phase names as the predefined order |
30
30
 
31
31
  <b>Returns:</b>
32
32
 
@@ -27,7 +27,7 @@ export declare function compareByOrder(a: string | symbol | undefined | null, b:
27
27
  | --- | --- | --- |
28
28
  | a | string \| symbol \| undefined \| null | First value |
29
29
  | b | string \| symbol \| undefined \| null | Second value |
30
- | order | (string \| symbol)\[\] | An array of values as the predefined order |
30
+ | order | (string \| symbol)\[\] | <i>(Optional)</i> An array of values as the predefined order |
31
31
 
32
32
  <b>Returns:</b>
33
33
 
@@ -26,7 +26,7 @@ export declare function configBindingKeyFor<ConfigValueType = unknown>(key: Bind
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | key | [BindingAddress](./context.bindingaddress.md) | Binding key for the target binding |
29
- | propertyPath | string | Property path for the configuration |
29
+ | propertyPath | string | <i>(Optional)</i> Property path for the configuration |
30
30
 
31
31
  <b>Returns:</b>
32
32
 
@@ -26,8 +26,8 @@ getConfigAsValueOrPromise<ConfigValueType>(key: BindingAddress<unknown>, propert
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | key | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt; | Binding key |
29
- | propertyPath | string | Property path for the option. For example, <code>x.y</code> requests for <code>&lt;config&gt;.x.y</code>. If not set, the <code>config</code> object will be returned. |
30
- | resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | Options for the resolution. - optional: if not set or set to <code>true</code>, <code>undefined</code> will be returned if no corresponding value is found. Otherwise, an error will be thrown. |
29
+ | propertyPath | string | <i>(Optional)</i> Property path for the option. For example, <code>x.y</code> requests for <code>&lt;config&gt;.x.y</code>. If not set, the <code>config</code> object will be returned. |
30
+ | resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | <i>(Optional)</i> Options for the resolution. - optional: if not set or set to <code>true</code>, <code>undefined</code> will be returned if no corresponding value is found. Otherwise, an error will be thrown. |
31
31
 
32
32
  <b>Returns:</b>
33
33
 
@@ -25,8 +25,8 @@ constructor(_parent?: Context | string, name?: string);
25
25
 
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
- | \_parent | [Context](./context.context.md) \| string | The optional parent context |
29
- | name | string | Name of the context. If not provided, a unique identifier will be generated as the name. |
28
+ | \_parent | [Context](./context.context.md) \| string | <i>(Optional)</i> The optional parent context |
29
+ | name | string | <i>(Optional)</i> Name of the context. If not provided, a unique identifier will be generated as the name. |
30
30
 
31
31
  ## Example
32
32
 
@@ -24,7 +24,7 @@ protected _mergeWithParent<ValueType>(childList: Readonly<Binding<ValueType>>[],
24
24
  | Parameter | Type | Description |
25
25
  | --- | --- | --- |
26
26
  | childList | Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;ValueType&gt;&gt;\[\] | |
27
- | parentList | Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;ValueType&gt;&gt;\[\] | |
27
+ | parentList | Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;ValueType&gt;&gt;\[\] | <i>(Optional)</i> |
28
28
 
29
29
  <b>Returns:</b>
30
30
 
@@ -27,7 +27,7 @@ configure<ConfigValueType = BoundValue>(key?: BindingAddress): Binding<ConfigVal
27
27
 
28
28
  | Parameter | Type | Description |
29
29
  | --- | --- | --- |
30
- | key | [BindingAddress](./context.bindingaddress.md) | The key for the binding to be configured |
30
+ | key | [BindingAddress](./context.bindingaddress.md) | <i>(Optional)</i> The key for the binding to be configured |
31
31
 
32
32
  <b>Returns:</b>
33
33
 
@@ -26,8 +26,8 @@ createView<T = unknown>(filter: BindingFilter, comparator?: BindingComparator, o
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | filter | [BindingFilter](./context.bindingfilter.md) | A function to match bindings |
29
- | comparator | [BindingComparator](./context.bindingcomparator.md) | A function to sort matched bindings |
30
- | options | Omit&lt;[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, 'session'&gt; | Resolution options |
29
+ | comparator | [BindingComparator](./context.bindingcomparator.md) | <i>(Optional)</i> A function to sort matched bindings |
30
+ | options | Omit&lt;[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, 'session'&gt; | <i>(Optional)</i> Resolution options |
31
31
 
32
32
  <b>Returns:</b>
33
33
 
@@ -25,7 +25,7 @@ find<ValueType = BoundValue>(pattern?: string | RegExp | BindingFilter): Readonl
25
25
 
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
- | pattern | string \| RegExp \| [BindingFilter](./context.bindingfilter.md) | A filter function, a regexp or a wildcard pattern with optional <code>*</code> and <code>?</code>. Find returns such bindings where the key matches the provided pattern.<!-- -->For a wildcard: - <code>*</code> matches zero or more characters except <code>.</code> and <code>:</code> - <code>?</code> matches exactly one character except <code>.</code> and <code>:</code>For a filter function: - return <code>true</code> to include the binding in the results - return <code>false</code> to exclude it. |
28
+ | pattern | string \| RegExp \| [BindingFilter](./context.bindingfilter.md) | <i>(Optional)</i> A filter function, a regexp or a wildcard pattern with optional <code>*</code> and <code>?</code>. Find returns such bindings where the key matches the provided pattern.<!-- -->For a wildcard: - <code>*</code> matches zero or more characters except <code>.</code> and <code>:</code> - <code>?</code> matches exactly one character except <code>.</code> and <code>:</code>For a filter function: - return <code>true</code> to include the binding in the results - return <code>false</code> to exclude it. |
29
29
 
30
30
  <b>Returns:</b>
31
31
 
@@ -26,7 +26,7 @@ findOrCreateBinding<T>(key: BindingAddress<T>, policy?: BindingCreationPolicy):
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | key | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;T&gt; | Binding address |
29
- | policy | [BindingCreationPolicy](./context.bindingcreationpolicy.md) | Binding creation policy |
29
+ | policy | [BindingCreationPolicy](./context.bindingcreationpolicy.md) | <i>(Optional)</i> Binding creation policy |
30
30
 
31
31
  <b>Returns:</b>
32
32
 
@@ -26,7 +26,7 @@ get<ValueType>(keyWithPath: BindingAddress<ValueType>, session?: ResolutionSessi
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | keyWithPath | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType&gt; | The binding key, optionally suffixed with a path to the (deeply) nested property to retrieve. |
29
- | session | [ResolutionSession](./context.resolutionsession.md) | Optional session for resolution (accepted for backward compatibility) |
29
+ | session | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> Optional session for resolution (accepted for backward compatibility) |
30
30
 
31
31
  <b>Returns:</b>
32
32
 
@@ -28,7 +28,7 @@ getBinding<ValueType>(key: BindingAddress<ValueType>, options?: {
28
28
  | Parameter | Type | Description |
29
29
  | --- | --- | --- |
30
30
  | key | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType&gt; | Binding key |
31
- | options | { optional?: boolean; } | Options to control if the binding is optional. If <code>options.optional</code> is set to true, the method will return <code>undefined</code> instead of throwing an error if the binding key is not found. |
31
+ | options | { optional?: boolean; } | <i>(Optional)</i> Options to control if the binding is optional. If <code>options.optional</code> is set to true, the method will return <code>undefined</code> instead of throwing an error if the binding key is not found. |
32
32
 
33
33
  <b>Returns:</b>
34
34
 
@@ -26,8 +26,8 @@ getConfig<ConfigValueType>(key: BindingAddress, propertyPath?: string, resolutio
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | key | [BindingAddress](./context.bindingaddress.md) | Binding key |
29
- | propertyPath | string | Property path for the option. For example, <code>x.y</code> requests for <code>&lt;config&gt;.x.y</code>. If not set, the <code>&lt;config&gt;</code> object will be returned. |
30
- | resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | Options for the resolution. |
29
+ | propertyPath | string | <i>(Optional)</i> Property path for the option. For example, <code>x.y</code> requests for <code>&lt;config&gt;.x.y</code>. If not set, the <code>&lt;config&gt;</code> object will be returned. |
30
+ | resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | <i>(Optional)</i> Options for the resolution. |
31
31
 
32
32
  <b>Returns:</b>
33
33
 
@@ -26,8 +26,8 @@ getConfigAsValueOrPromise<ConfigValueType>(key: BindingAddress, propertyPath?: s
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | key | [BindingAddress](./context.bindingaddress.md) | Binding key |
29
- | propertyPath | string | Property path for the option. For example, <code>x.y</code> requests for <code>&lt;config&gt;.x.y</code>. If not set, the <code>&lt;config&gt;</code> object will be returned. |
30
- | resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | Options for the resolution. - optional: if not set or set to <code>true</code>, <code>undefined</code> will be returned if no corresponding value is found. Otherwise, an error will be thrown. |
29
+ | propertyPath | string | <i>(Optional)</i> Property path for the option. For example, <code>x.y</code> requests for <code>&lt;config&gt;.x.y</code>. If not set, the <code>&lt;config&gt;</code> object will be returned. |
30
+ | resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | <i>(Optional)</i> Options for the resolution. - optional: if not set or set to <code>true</code>, <code>undefined</code> will be returned if no corresponding value is found. Otherwise, an error will be thrown. |
31
31
 
32
32
  <b>Returns:</b>
33
33
 
@@ -26,8 +26,8 @@ getConfigSync<ConfigValueType>(key: BindingAddress, propertyPath?: string, resol
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
28
  | key | [BindingAddress](./context.bindingaddress.md) | Binding key |
29
- | propertyPath | string | Property path for the option. For example, <code>x.y</code> requests for <code>config.x.y</code>. If not set, the <code>config</code> object will be returned. |
30
- | resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | Options for the resolution. |
29
+ | propertyPath | string | <i>(Optional)</i> Property path for the option. For example, <code>x.y</code> requests for <code>config.x.y</code>. If not set, the <code>config</code> object will be returned. |
30
+ | resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | <i>(Optional)</i> Options for the resolution. |
31
31
 
32
32
  <b>Returns:</b>
33
33
 
@@ -28,7 +28,7 @@ getSync<ValueType>(keyWithPath: BindingAddress<ValueType>, session?: ResolutionS
28
28
  | Parameter | Type | Description |
29
29
  | --- | --- | --- |
30
30
  | keyWithPath | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType&gt; | The binding key, optionally suffixed with a path to the (deeply) nested property to retrieve. |
31
- | session | [ResolutionSession](./context.resolutionsession.md) | Session for resolution (accepted for backward compatibility) |
31
+ | session | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> Session for resolution (accepted for backward compatibility) |
32
32
 
33
33
  <b>Returns:</b>
34
34
 
@@ -28,7 +28,7 @@ getSync<ValueType>(keyWithPath: BindingAddress<ValueType>, options?: ResolutionO
28
28
  | Parameter | Type | Description |
29
29
  | --- | --- | --- |
30
30
  | keyWithPath | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType&gt; | The binding key, optionally suffixed with a path to the (deeply) nested property to retrieve. |
31
- | options | [ResolutionOptions](./context.resolutionoptions.md) | Options for resolution. |
31
+ | options | [ResolutionOptions](./context.resolutionoptions.md) | <i>(Optional)</i> Options for resolution. |
32
32
 
33
33
  <b>Returns:</b>
34
34
 
@@ -25,7 +25,7 @@ inspect(options?: ContextInspectOptions): JSONObject;
25
25
 
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
- | options | [ContextInspectOptions](./context.contextinspectoptions.md) | Options for inspect |
28
+ | options | [ContextInspectOptions](./context.contextinspectoptions.md) | <i>(Optional)</i> Options for inspect |
29
29
 
30
30
  <b>Returns:</b>
31
31