@loopback/docs 5.0.0 → 5.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (401) hide show
  1. package/CHANGELOG.md +63 -0
  2. package/LICENSE +2 -2
  3. package/package.json +5 -5
  4. package/site/BelongsTo-relation.md +1 -1
  5. package/site/Context.md +1 -1
  6. package/site/Copyright-generator.md +8 -7
  7. package/site/Crafting-LoopBack-4.md +3 -3
  8. package/site/DEVELOPING.md +2 -2
  9. package/site/Discovering-models.md +5 -0
  10. package/site/Dynamic-models-repositories-controllers.md +2 -2
  11. package/site/Implementing-features.shelved.md +1 -1
  12. package/site/Include-filter.md +1 -1
  13. package/site/Interceptor-generator.md +1 -1
  14. package/site/LB3-vs-LB4-request-response-cycle.md +4 -4
  15. package/site/Model-generator.md +1 -1
  16. package/site/Model.md +2 -2
  17. package/site/{Polymorphic-relations.md → Polymorphic-relation.md} +2 -2
  18. package/site/REST-middleware-sequence.md +1 -1
  19. package/site/Repository-generator.md +2 -2
  20. package/site/Repository.md +1 -1
  21. package/site/Request-response-cycle.md +6 -6
  22. package/site/Rest-Crud-generator.md +7 -1
  23. package/site/Serving-static-files.md +1 -1
  24. package/site/Testing-your-application.md +1 -1
  25. package/site/apidocs/authentication-jwt.myuserservice.md +1 -1
  26. package/site/apidocs/authentication-jwt.refreshtokenrepository.md +1 -1
  27. package/site/apidocs/authentication-jwt.usercredentialsrepository.md +1 -1
  28. package/site/apidocs/authentication-jwt.userrepository.md +3 -3
  29. package/site/apidocs/authentication-passport.strategyadapter.md +1 -1
  30. package/site/apidocs/authentication.authenticateactionprovider.md +5 -5
  31. package/site/apidocs/authentication.authenticationmetadata.md +5 -5
  32. package/site/apidocs/authentication.authenticationmiddlewareprovider.md +1 -1
  33. package/site/apidocs/authentication.authenticationoptions.md +4 -4
  34. package/site/apidocs/authentication.authenticationstrategy.md +3 -3
  35. package/site/apidocs/authentication.authenticationstrategyprovider.md +3 -3
  36. package/site/apidocs/authentication.authmetadataprovider.md +1 -1
  37. package/site/apidocs/authentication.md +3 -3
  38. package/site/apidocs/authorization.authorizationcontext.md +7 -7
  39. package/site/apidocs/authorization.authorizationinterceptor.md +1 -1
  40. package/site/apidocs/authorization.authorizationmetadata.md +8 -8
  41. package/site/apidocs/authorization.authorizationoptions.md +6 -6
  42. package/site/apidocs/authorization.authorizationrequest.md +6 -6
  43. package/site/apidocs/authorization.authorizemethoddecoratorfactory.md +2 -2
  44. package/site/apidocs/boot.baseartifactbooter.md +5 -5
  45. package/site/apidocs/boot.bootable.md +4 -4
  46. package/site/apidocs/boot.bootmixin.md +44 -44
  47. package/site/apidocs/boot.instancewithbooters.md +3 -3
  48. package/site/apidocs/boot.md +10 -10
  49. package/site/apidocs/context-explorer.contextbinding.md +4 -4
  50. package/site/apidocs/context-explorer.contextgraph.md +2 -2
  51. package/site/apidocs/context.binding.md +11 -11
  52. package/site/apidocs/context.bindingelement.md +4 -4
  53. package/site/apidocs/context.bindinginspectoptions.md +3 -3
  54. package/site/apidocs/context.bindingkey.md +4 -4
  55. package/site/apidocs/context.bindingscope.md +2 -2
  56. package/site/apidocs/context.bindingtagfilter.md +3 -3
  57. package/site/apidocs/context.config.getter.md +1 -1
  58. package/site/apidocs/context.config.view.md +1 -1
  59. package/site/apidocs/context.configinjectionmetadata.md +4 -4
  60. package/site/apidocs/context.context.find.md +1 -1
  61. package/site/apidocs/context.context.md +15 -15
  62. package/site/apidocs/context.contextinspectoptions.md +3 -3
  63. package/site/apidocs/context.contextobserver.md +4 -4
  64. package/site/apidocs/context.contextsubscriptionmanager.md +5 -5
  65. package/site/apidocs/context.contextview.md +7 -7
  66. package/site/apidocs/context.contextviewevent.md +3 -3
  67. package/site/apidocs/context.defaultconfigurationresolver.md +1 -1
  68. package/site/apidocs/context.dynamicvalueproviderclass.md +3 -3
  69. package/site/apidocs/context.genericinterceptorchain.md +1 -1
  70. package/site/apidocs/context.inject.binding.md +1 -1
  71. package/site/apidocs/context.inject.getter.md +1 -1
  72. package/site/apidocs/context.inject.md +2 -2
  73. package/site/apidocs/context.inject.setter.md +1 -1
  74. package/site/apidocs/context.inject.tag.md +1 -1
  75. package/site/apidocs/context.inject.view.md +1 -1
  76. package/site/apidocs/context.injectable.md +1 -1
  77. package/site/apidocs/context.injectbindingmetadata.md +3 -3
  78. package/site/apidocs/context.injection.md +8 -8
  79. package/site/apidocs/context.injectiondescriptor.md +5 -5
  80. package/site/apidocs/context.injectionelement.md +4 -4
  81. package/site/apidocs/context.injectionmetadata.md +5 -5
  82. package/site/apidocs/context.intercept.md +2 -2
  83. package/site/apidocs/context.interceptionhandler.md +1 -1
  84. package/site/apidocs/context.interceptor.md +1 -1
  85. package/site/apidocs/context.interceptorbindingoptions.md +5 -5
  86. package/site/apidocs/context.invocationcontext.md +7 -7
  87. package/site/apidocs/context.invocationsource.md +4 -4
  88. package/site/apidocs/context.jsonarray.md +1 -1
  89. package/site/apidocs/context.jsonobject.md +1 -1
  90. package/site/apidocs/context.md +9 -9
  91. package/site/apidocs/context.notification.md +3 -3
  92. package/site/apidocs/context.proxysource.md +2 -2
  93. package/site/apidocs/context.resolutioncontext.md +5 -5
  94. package/site/apidocs/context.resolutionerror.md +1 -1
  95. package/site/apidocs/context.resolutionoptions.md +5 -5
  96. package/site/apidocs/context.resolutionsession.md +5 -5
  97. package/site/apidocs/context.subscription.md +3 -3
  98. package/site/apidocs/core.application.md +13 -13
  99. package/site/apidocs/core.applicationconfig.md +4 -4
  100. package/site/apidocs/core.applicationmetadata.md +5 -5
  101. package/site/apidocs/core.component.md +9 -9
  102. package/site/apidocs/core.lifecycleobserverregistry.md +8 -8
  103. package/site/apidocs/core.server.md +3 -3
  104. package/site/apidocs/core.service.md +1 -1
  105. package/site/apidocs/core.serviceoptions.md +3 -3
  106. package/site/apidocs/cron.croncomponent.md +1 -1
  107. package/site/apidocs/cron.md +1 -1
  108. package/site/apidocs/express.basemiddlewarebindingoptions.md +4 -4
  109. package/site/apidocs/express.expressapplication.md +2 -2
  110. package/site/apidocs/express.expressmiddlewareinterceptorprovider.md +4 -4
  111. package/site/apidocs/express.expressserver.md +7 -7
  112. package/site/apidocs/express.handlercontext.md +4 -4
  113. package/site/apidocs/express.invokemiddlewareoptions.md +7 -7
  114. package/site/apidocs/express.middleware.md +1 -1
  115. package/site/apidocs/express.middlewarebindingoptions.md +6 -6
  116. package/site/apidocs/express.middlewarechain.md +1 -1
  117. package/site/apidocs/express.middlewarecontext.md +3 -3
  118. package/site/apidocs/express.middlewarecreationoptions.md +4 -4
  119. package/site/apidocs/express.middlewareinterceptorbindingoptions.md +4 -4
  120. package/site/apidocs/express.middlewaremixin.md +28 -28
  121. package/site/apidocs/express.middlewareview.md +1 -1
  122. package/site/apidocs/filter.andclause.md +3 -3
  123. package/site/apidocs/filter.filter.md +9 -9
  124. package/site/apidocs/filter.inclusion.md +5 -5
  125. package/site/apidocs/filter.md +3 -3
  126. package/site/apidocs/filter.orclause.md +3 -3
  127. package/site/apidocs/graphql.graphqlresolutioncontext.md +2 -2
  128. package/site/apidocs/graphql.graphqlserver.md +3 -3
  129. package/site/apidocs/graphql.graphqlserveroptions.md +6 -6
  130. package/site/apidocs/graphql.loopbackcontainer.md +1 -1
  131. package/site/apidocs/http-caching-proxy.proxyoptions.md +7 -7
  132. package/site/apidocs/http-server.basehttpoptions.md +4 -4
  133. package/site/apidocs/http-server.httpoptions.md +3 -3
  134. package/site/apidocs/http-server.httpserver.md +8 -8
  135. package/site/apidocs/http-server.httpsoptions.md +3 -3
  136. package/site/apidocs/index.md +1 -1
  137. package/site/apidocs/logging.winstonloggerprovider.md +1 -1
  138. package/site/apidocs/metadata.classdecoratorfactory.md +3 -3
  139. package/site/apidocs/metadata.decoratorfactory.md +11 -11
  140. package/site/apidocs/metadata.decoratoroptions.md +5 -5
  141. package/site/apidocs/metadata.designtimemethodmetadata.md +5 -5
  142. package/site/apidocs/metadata.inspectionoptions.md +3 -3
  143. package/site/apidocs/metadata.metadataaccessor.md +1 -1
  144. package/site/apidocs/metadata.metadatainspector.md +2 -2
  145. package/site/apidocs/metadata.methoddecoratorfactory.md +3 -3
  146. package/site/apidocs/metadata.methodmultidecoratorfactory.md +3 -3
  147. package/site/apidocs/metadata.methodparameterdecoratorfactory.md +3 -3
  148. package/site/apidocs/metadata.parameterdecoratorfactory.md +3 -3
  149. package/site/apidocs/metadata.propertydecoratorfactory.md +3 -3
  150. package/site/apidocs/metrics.metricsoptions.md +7 -7
  151. package/site/apidocs/mock-oauth2-provider.myuser.md +10 -10
  152. package/site/apidocs/model-api-builder.modelapibuilder.md +3 -3
  153. package/site/apidocs/openapi-spec-builder.builderbase.md +1 -1
  154. package/site/apidocs/openapi-spec-builder.componentsspecbuilder.md +1 -1
  155. package/site/apidocs/openapi-spec-builder.openapispecbuilder.md +1 -1
  156. package/site/apidocs/openapi-spec-builder.operationspecbuilder.md +1 -1
  157. package/site/apidocs/openapi-v3.controllerspec.md +5 -5
  158. package/site/apidocs/openapi-v3.deprecated.md +2 -2
  159. package/site/apidocs/openapi-v3.md +9 -9
  160. package/site/apidocs/openapi-v3.oasenhancer.md +3 -3
  161. package/site/apidocs/openapi-v3.oasenhancerservice.md +1 -1
  162. package/site/apidocs/openapi-v3.param.query.md +1 -1
  163. package/site/apidocs/openapi-v3.requestbody.array.md +3 -3
  164. package/site/apidocs/openapi-v3.requestbody.file.md +3 -3
  165. package/site/apidocs/openapi-v3.requestbody.md +1 -1
  166. package/site/apidocs/openapi-v3.responsedecoratormetadataitem.md +6 -6
  167. package/site/apidocs/openapi-v3.restendpoint.md +5 -5
  168. package/site/apidocs/openapi-v3.tags.md +2 -2
  169. package/site/apidocs/openapi-v3.tagsdecoratormetadata.md +3 -3
  170. package/site/apidocs/openapi-v3.visibility.md +2 -2
  171. package/site/apidocs/pooling.pooledvalue.md +4 -4
  172. package/site/apidocs/pooling.poolfactory.md +1 -1
  173. package/site/apidocs/pooling.poolingservice.md +2 -2
  174. package/site/apidocs/pooling.poolingserviceoptions.md +4 -4
  175. package/site/apidocs/repository-json-schema.filterschemaoptions.md +4 -4
  176. package/site/apidocs/repository-json-schema.jsonschemaoptions.md +7 -7
  177. package/site/apidocs/repository-json-schema.md +3 -3
  178. package/site/apidocs/repository-tests.crudfeatures.md +8 -8
  179. package/site/apidocs/repository.anytype.md +2 -2
  180. package/site/apidocs/repository.arraytype.md +2 -2
  181. package/site/apidocs/repository.baserepositoryclass.md +3 -3
  182. package/site/apidocs/repository.belongstoaccessor.md +3 -3
  183. package/site/apidocs/repository.belongstodefinition.md +7 -7
  184. package/site/apidocs/repository.booleantype.md +2 -2
  185. package/site/apidocs/repository.buffertype.md +2 -2
  186. package/site/apidocs/repository.connector.md +5 -5
  187. package/site/apidocs/repository.count.md +3 -3
  188. package/site/apidocs/repository.crudrepository.md +1 -1
  189. package/site/apidocs/repository.crudrepositoryimpl.md +2 -2
  190. package/site/apidocs/repository.datasource.md +5 -5
  191. package/site/apidocs/repository.datetype.md +2 -2
  192. package/site/apidocs/repository.defaultbelongstorepository.md +1 -1
  193. package/site/apidocs/repository.defaultcrudrepository.definepersistedmodel.md +1 -1
  194. package/site/apidocs/repository.defaultcrudrepository.md +21 -21
  195. package/site/apidocs/repository.defaulthasmanyrepository.md +1 -1
  196. package/site/apidocs/repository.defaulthasmanythroughrepository.md +1 -1
  197. package/site/apidocs/repository.defaulthasonerepository.md +1 -1
  198. package/site/apidocs/repository.defaultkeyvaluerepository.md +2 -2
  199. package/site/apidocs/repository.defaultreferencesmanyrepository.md +1 -1
  200. package/site/apidocs/repository.defaulttransactionalrepository.md +2 -2
  201. package/site/apidocs/repository.entitycrudrepository.md +5 -5
  202. package/site/apidocs/repository.entityrepository.md +1 -1
  203. package/site/apidocs/repository.executablerepository.md +1 -1
  204. package/site/apidocs/repository.hasmanydefinition.md +7 -7
  205. package/site/apidocs/repository.hasmanyrepositoryfactory.md +3 -3
  206. package/site/apidocs/repository.hasonedefinition.md +7 -7
  207. package/site/apidocs/repository.hasonerepositoryfactory.md +3 -3
  208. package/site/apidocs/repository.keyvaluerepository.md +1 -1
  209. package/site/apidocs/repository.md +14 -14
  210. package/site/apidocs/repository.modeldefinition.md +1 -1
  211. package/site/apidocs/repository.modeldefinitionsyntax.md +7 -7
  212. package/site/apidocs/repository.modelrepositoryclass.md +3 -3
  213. package/site/apidocs/repository.modelsettings.md +7 -7
  214. package/site/apidocs/repository.modeltype.md +2 -2
  215. package/site/apidocs/repository.nulltype.md +2 -2
  216. package/site/apidocs/repository.numbertype.md +2 -2
  217. package/site/apidocs/repository.objecttype.md +1 -1
  218. package/site/apidocs/repository.propertydefinition.md +9 -9
  219. package/site/apidocs/repository.propertyform.md +5 -5
  220. package/site/apidocs/repository.referencesmanyaccessor.md +3 -3
  221. package/site/apidocs/repository.referencesmanydefinition.md +6 -6
  222. package/site/apidocs/repository.relationdefinitionbase.md +7 -7
  223. package/site/apidocs/repository.repositorycomponent.md +4 -4
  224. package/site/apidocs/repository.repositorymetadata._constructor_.md +1 -1
  225. package/site/apidocs/repository.repositorymixin.md +50 -50
  226. package/site/apidocs/repository.repositorymixindoc.md +1 -1
  227. package/site/apidocs/repository.schemamigrationoptions.md +4 -4
  228. package/site/apidocs/repository.stringtype.md +2 -2
  229. package/site/apidocs/repository.transaction.md +3 -3
  230. package/site/apidocs/repository.transactionalrepository.md +1 -1
  231. package/site/apidocs/repository.type.md +3 -3
  232. package/site/apidocs/repository.uniontype.md +2 -2
  233. package/site/apidocs/rest-crud.crudrestapibuilder.md +1 -1
  234. package/site/apidocs/{rest-crud.crudrestcontroller.create.md → rest-crud.crudrestcontroller.find.md} +8 -8
  235. package/site/apidocs/rest-crud.crudrestcontroller.md +4 -4
  236. package/site/apidocs/rest-crud.crudrestcontrolleroptions.md +4 -3
  237. package/site/apidocs/rest-crud.crudrestcontrolleroptions.readonly.md +23 -0
  238. package/site/apidocs/rest-crud.modelcrudrestapiconfig.md +4 -3
  239. package/site/apidocs/rest-crud.modelcrudrestapiconfig.readonly.md +23 -0
  240. package/site/apidocs/rest-explorer.restexplorerbindings.md +1 -1
  241. package/site/apidocs/rest.apiexploreroptions.md +5 -5
  242. package/site/apidocs/rest.baseroute.md +3 -3
  243. package/site/apidocs/rest.bodyparser.md +3 -3
  244. package/site/apidocs/rest.controllerroute.md +4 -4
  245. package/site/apidocs/rest.defaultsequence.md +5 -5
  246. package/site/apidocs/rest.findroutemiddlewareprovider.md +1 -1
  247. package/site/apidocs/rest.httphandler.md +5 -5
  248. package/site/apidocs/rest.httpserverlike.md +3 -3
  249. package/site/apidocs/rest.infospecenhancer.md +1 -1
  250. package/site/apidocs/rest.invokemethodmiddlewareprovider.md +1 -1
  251. package/site/apidocs/rest.md +1 -1
  252. package/site/apidocs/rest.middlewaresequence.md +3 -3
  253. package/site/apidocs/rest.node.md +7 -7
  254. package/site/apidocs/rest.openapispecform.md +4 -4
  255. package/site/apidocs/rest.openapispecoptions.md +7 -7
  256. package/site/apidocs/rest.parseparamsmiddlewareprovider.md +1 -1
  257. package/site/apidocs/rest.redirectroute.md +8 -8
  258. package/site/apidocs/rest.regexprouter.md +3 -3
  259. package/site/apidocs/rest.requestbodyparser.md +1 -1
  260. package/site/apidocs/rest.requestbodyparseroptions.md +7 -7
  261. package/site/apidocs/rest.requestcontext.md +7 -7
  262. package/site/apidocs/rest.requestwithsession.md +3 -3
  263. package/site/apidocs/rest.resolvednode.md +4 -4
  264. package/site/apidocs/rest.resolvedroute.md +4 -4
  265. package/site/apidocs/rest.restapplication.md +3 -3
  266. package/site/apidocs/rest.restbindings.md +1 -1
  267. package/site/apidocs/rest.resthttperrors.validationerrordetails.md +6 -6
  268. package/site/apidocs/rest.restserver.md +22 -22
  269. package/site/apidocs/rest.restserverresolvedoptions.md +13 -13
  270. package/site/apidocs/rest.route.md +2 -2
  271. package/site/apidocs/rest.routeentry.md +5 -5
  272. package/site/apidocs/rest.routesource.md +2 -2
  273. package/site/apidocs/rest.sendresponsemiddlewareprovider.md +1 -1
  274. package/site/apidocs/rest.session.md +3 -3
  275. package/site/apidocs/rest.sessionuserprofile.md +5 -5
  276. package/site/apidocs/rest.trie.md +1 -1
  277. package/site/apidocs/rest.trierouter.md +3 -3
  278. package/site/apidocs/rest.validationoptions.md +8 -8
  279. package/site/apidocs/rest.valuevalidationoptions.md +4 -4
  280. package/site/apidocs/security.defaultsubject.md +4 -4
  281. package/site/apidocs/security.md +2 -2
  282. package/site/apidocs/security.permission.md +1 -1
  283. package/site/apidocs/security.principal.md +3 -3
  284. package/site/apidocs/security.role.md +3 -3
  285. package/site/apidocs/security.scope.md +3 -3
  286. package/site/apidocs/security.subject.md +5 -5
  287. package/site/apidocs/security.typedprincipal.md +3 -3
  288. package/site/apidocs/security.userprofile.md +4 -4
  289. package/site/apidocs/service-proxy.md +1 -1
  290. package/site/apidocs/service-proxy.servicemixin.md +43 -43
  291. package/site/apidocs/service-proxy.serviceproxy.md +2 -2
  292. package/site/apidocs/socketio.defaultsocketiosequence.md +5 -5
  293. package/site/apidocs/socketio.httpserverresolvedoptions.md +7 -7
  294. package/site/apidocs/socketio.socketio.md +1 -1
  295. package/site/apidocs/socketio.socketioapplication.md +1 -1
  296. package/site/apidocs/socketio.socketiobooter.md +1 -1
  297. package/site/apidocs/socketio.socketioconnectioncontext.md +1 -1
  298. package/site/apidocs/socketio.socketiocontrollerfactory.md +4 -4
  299. package/site/apidocs/socketio.socketioinvokemethodprovider.md +1 -1
  300. package/site/apidocs/socketio.socketiometadata.md +4 -4
  301. package/site/apidocs/socketio.socketiorejectprovider.md +1 -1
  302. package/site/apidocs/socketio.socketiosendprovider.md +1 -1
  303. package/site/apidocs/socketio.socketioserver.md +4 -4
  304. package/site/apidocs/socketio.socketioserveroptions.md +4 -4
  305. package/site/apidocs/testlab.expresscontextstub.md +6 -6
  306. package/site/apidocs/testlab.handlercontextstub.md +5 -5
  307. package/site/apidocs/testlab.hostport.md +4 -4
  308. package/site/apidocs/testlab.httpoptions.md +3 -3
  309. package/site/apidocs/testlab.httpsoptions.md +3 -3
  310. package/site/apidocs/testlab.md +1 -1
  311. package/site/apidocs/testlab.restapplicationlike.md +3 -3
  312. package/site/apidocs/testlab.restserverlike.md +4 -4
  313. package/site/apidocs/testlab.testsandbox.md +1 -1
  314. package/site/apidocs/testlab.testsandboxoptions.md +3 -3
  315. package/site/apidocs/tsdocs.apidocsoptions.md +9 -9
  316. package/site/apidocs/tsdocs.extractoroptions.md +8 -8
  317. package/site/apidocs/tsdocs.lernapackage.md +7 -7
  318. package/site/apidocs/typeorm.md +1 -1
  319. package/site/apidocs/typeorm.typeormmixin.md +61 -61
  320. package/site/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +30 -0
  321. package/site/changelogs/examples/access-control-migration/CHANGELOG.md +30 -0
  322. package/site/changelogs/examples/binding-resolution/CHANGELOG.md +30 -0
  323. package/site/changelogs/examples/context/CHANGELOG.md +30 -0
  324. package/site/changelogs/examples/express-composition/CHANGELOG.md +30 -0
  325. package/site/changelogs/examples/file-transfer/CHANGELOG.md +30 -0
  326. package/site/changelogs/examples/graphql/CHANGELOG.md +30 -0
  327. package/site/changelogs/examples/greeter-extension/CHANGELOG.md +30 -0
  328. package/site/changelogs/examples/greeting-app/CHANGELOG.md +30 -0
  329. package/site/changelogs/examples/hello-world/CHANGELOG.md +30 -0
  330. package/site/changelogs/examples/lb3-application/CHANGELOG.md +33 -0
  331. package/site/changelogs/examples/log-extension/CHANGELOG.md +33 -0
  332. package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +30 -0
  333. package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +34 -1
  334. package/site/changelogs/examples/passport-login/CHANGELOG.md +30 -0
  335. package/site/changelogs/examples/references-many/CHANGELOG.md +29 -0
  336. package/site/changelogs/examples/rest-crud/CHANGELOG.md +33 -0
  337. package/site/changelogs/examples/rpc-server/CHANGELOG.md +30 -0
  338. package/site/changelogs/examples/soap-calculator/CHANGELOG.md +30 -0
  339. package/site/changelogs/examples/socketio/CHANGELOG.md +30 -0
  340. package/site/changelogs/examples/todo/CHANGELOG.md +30 -0
  341. package/site/changelogs/examples/todo-jwt/CHANGELOG.md +33 -0
  342. package/site/changelogs/examples/todo-list/CHANGELOG.md +30 -0
  343. package/site/changelogs/examples/validation-app/CHANGELOG.md +30 -0
  344. package/site/changelogs/examples/webpack/CHANGELOG.md +30 -0
  345. package/site/changelogs/extensions/apiconnect/CHANGELOG.md +30 -0
  346. package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +30 -0
  347. package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +30 -0
  348. package/site/changelogs/extensions/context-explorer/CHANGELOG.md +30 -0
  349. package/site/changelogs/extensions/cron/CHANGELOG.md +30 -0
  350. package/site/changelogs/extensions/graphql/CHANGELOG.md +30 -0
  351. package/site/changelogs/extensions/health/CHANGELOG.md +30 -0
  352. package/site/changelogs/extensions/logging/CHANGELOG.md +30 -0
  353. package/site/changelogs/extensions/metrics/CHANGELOG.md +30 -0
  354. package/site/changelogs/extensions/pooling/CHANGELOG.md +30 -0
  355. package/site/changelogs/extensions/socketio/CHANGELOG.md +30 -0
  356. package/site/changelogs/extensions/typeorm/CHANGELOG.md +32 -0
  357. package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +309 -0
  358. package/site/changelogs/packages/authentication/CHANGELOG.md +30 -0
  359. package/site/changelogs/packages/authorization/CHANGELOG.md +30 -0
  360. package/site/changelogs/packages/boot/CHANGELOG.md +33 -0
  361. package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +30 -0
  362. package/site/changelogs/packages/build/CHANGELOG.md +28 -0
  363. package/site/changelogs/packages/cli/CHANGELOG.md +62 -0
  364. package/site/changelogs/packages/context/CHANGELOG.md +30 -0
  365. package/site/changelogs/packages/core/CHANGELOG.md +33 -0
  366. package/site/changelogs/packages/eslint-config/CHANGELOG.md +27 -0
  367. package/site/changelogs/packages/express/CHANGELOG.md +30 -0
  368. package/site/changelogs/packages/filter/CHANGELOG.md +34 -0
  369. package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +30 -0
  370. package/site/changelogs/packages/http-server/CHANGELOG.md +35 -0
  371. package/site/changelogs/packages/metadata/CHANGELOG.md +30 -0
  372. package/site/changelogs/packages/model-api-builder/CHANGELOG.md +30 -0
  373. package/site/changelogs/packages/monorepo/CHANGELOG.md +24 -0
  374. package/site/changelogs/packages/openapi-spec-builder/CHANGELOG.md +30 -0
  375. package/site/changelogs/packages/openapi-v3/CHANGELOG.md +36 -0
  376. package/site/changelogs/packages/repository/CHANGELOG.md +39 -0
  377. package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +33 -0
  378. package/site/changelogs/packages/repository-tests/CHANGELOG.md +31 -0
  379. package/site/changelogs/packages/rest/CHANGELOG.md +30 -0
  380. package/site/changelogs/packages/rest-crud/CHANGELOG.md +36 -0
  381. package/site/changelogs/packages/rest-explorer/CHANGELOG.md +30 -0
  382. package/site/changelogs/packages/security/CHANGELOG.md +30 -0
  383. package/site/changelogs/packages/service-proxy/CHANGELOG.md +30 -0
  384. package/site/changelogs/packages/testlab/CHANGELOG.md +24 -0
  385. package/site/changelogs/packages/tsdocs/CHANGELOG.md +30 -0
  386. package/site/decorators/Decorators_openapi.md +3 -3
  387. package/site/deployment/Deploy-for-GDPR-readiness.md +1 -1
  388. package/site/migration/LB3-vs-LB4-booting.md +1 -1
  389. package/site/migration/auth/passport.md +2 -2
  390. package/site/readmes/loopback-next/examples/lb3-application/README.md +1 -1
  391. package/site/readmes/loopback-next/examples/log-extension/README.md +1 -1
  392. package/site/readmes/loopback-next/examples/rest-crud/README.md +1 -1
  393. package/site/readmes/loopback-next/examples/todo-jwt/README.md +1 -1
  394. package/site/readmes/loopback-next/packages/boot/README.md +1 -1
  395. package/site/readmes/loopback-next/packages/build/README.md +2 -2
  396. package/site/readmes/loopback-next/packages/rest-crud/README.md +3 -2
  397. package/site/sidebars/lb4_sidebar.yml +4 -0
  398. package/site/tutorials/core/11-summary.md +1 -1
  399. package/site/tutorials/core/3-context-in-action.md +3 -3
  400. package/site/tutorials/soap-calculator/soap-calculator-tutorial-add-controller.md +1 -1
  401. package/site/tutorials/soap-calculator/soap-calculator-tutorial-scaffolding.md +1 -1
@@ -33,14 +33,14 @@ export declare class Binding<T = BoundValue> extends EventEmitter
33
33
  | Property | Modifiers | Type | Description |
34
34
  | --- | --- | --- | --- |
35
35
  | [isLocked](./context.binding.islocked.md) | | boolean | |
36
- | [key](./context.binding.key.md) | | string | Key of the binding |
37
- | [providerConstructor](./context.binding.providerconstructor.md) | | [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;T&gt;&gt; \| undefined | For bindings bound via <code>toProvider()</code>, this property contains the constructor function of the provider class |
38
- | [scope](./context.binding.scope.md) | | [BindingScope](./context.bindingscope.md) | Scope of the binding to control how the value is cached/shared |
39
- | [source](./context.binding.source.md) | | [BindingSource](./context.bindingsource.md)<!-- -->&lt;T&gt; \| undefined | |
40
- | [tagMap](./context.binding.tagmap.md) | | [TagMap](./context.tagmap.md) | Map for tag name/value pairs |
41
- | [tagNames](./context.binding.tagnames.md) | | string\[\] | Get an array of tag names |
42
- | [type](./context.binding.type.md) | | [BindingType](./context.bindingtype.md) \| undefined | Type of the binding value getter |
43
- | [valueConstructor](./context.binding.valueconstructor.md) | | [Constructor](./context.constructor.md)<!-- -->&lt;T&gt; \| undefined | For bindings bound via <code>toClass()</code>, this property contains the constructor function of the class |
36
+ | [key](./context.binding.key.md) | <code>readonly</code> | string | Key of the binding |
37
+ | [providerConstructor](./context.binding.providerconstructor.md) | <code>readonly</code> | [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;T&gt;&gt; \| undefined | For bindings bound via <code>toProvider()</code>, this property contains the constructor function of the provider class |
38
+ | [scope](./context.binding.scope.md) | <code>readonly</code> | [BindingScope](./context.bindingscope.md) | Scope of the binding to control how the value is cached/shared |
39
+ | [source](./context.binding.source.md) | <code>readonly</code> | [BindingSource](./context.bindingsource.md)<!-- -->&lt;T&gt; \| undefined | |
40
+ | [tagMap](./context.binding.tagmap.md) | <code>readonly</code> | [TagMap](./context.tagmap.md) | Map for tag name/value pairs |
41
+ | [tagNames](./context.binding.tagnames.md) | <code>readonly</code> | string\[\] | Get an array of tag names |
42
+ | [type](./context.binding.type.md) | <code>readonly</code> | [BindingType](./context.bindingtype.md) \| undefined | Type of the binding value getter |
43
+ | [valueConstructor](./context.binding.valueconstructor.md) | <code>readonly</code> | [Constructor](./context.constructor.md)<!-- -->&lt;T&gt; \| undefined | For bindings bound via <code>toClass()</code>, this property contains the constructor function of the class |
44
44
 
45
45
  ## Methods
46
46
 
@@ -50,7 +50,7 @@ export declare class Binding<T = BoundValue> extends EventEmitter
50
50
  | [applyDefaultScope(scope)](./context.binding.applydefaultscope.md) | | Apply default scope to the binding. It only changes the scope if it's not set yet |
51
51
  | [bind(key)](./context.binding.bind.md) | <code>static</code> | A static method to create a binding so that we can do <code>Binding.bind('foo').to('bar');</code> as <code>new Binding('foo').to('bar')</code> is not easy to read. |
52
52
  | [configure(key)](./context.binding.configure.md) | <code>static</code> | Create a configuration binding for the given key |
53
- | [getValue(ctx, session)](./context.binding.getvalue.md) | | This is an internal function optimized for performance. Users should use <code>@inject(key)</code> or <code>ctx.get(key)</code> instead.<!-- -->Get the value bound to this key. Depending on <code>isSync</code>, this function returns either: - the bound value - a promise of the bound value<!-- -->Consumers wishing to consume sync values directly should use <code>isPromiseLike</code> to check the type of the returned value to decide how to handle it. |
53
+ | [getValue(ctx, session)](./context.binding.getvalue.md) | | <p>This is an internal function optimized for performance. Users should use <code>@inject(key)</code> or <code>ctx.get(key)</code> instead.</p><p>Get the value bound to this key. Depending on <code>isSync</code>, this function returns either: - the bound value - a promise of the bound value</p><p>Consumers wishing to consume sync values directly should use <code>isPromiseLike</code> to check the type of the returned value to decide how to handle it.</p> |
54
54
  | [getValue(ctx, options)](./context.binding.getvalue_1.md) | | Returns a value or promise for this binding in the given context. The resolved value can be <code>undefined</code> if <code>optional</code> is set to <code>true</code> in <code>options</code>. |
55
55
  | [inScope(scope)](./context.binding.inscope.md) | | Set the binding scope |
56
56
  | [inspect(options)](./context.binding.inspect.md) | | Inspect the binding to return a json representation of the binding information |
@@ -65,9 +65,9 @@ export declare class Binding<T = BoundValue> extends EventEmitter
65
65
  | [toAlias(keyWithPath)](./context.binding.toalias.md) | | Bind the key to an alias of another binding |
66
66
  | [toClass(ctor)](./context.binding.toclass.md) | | Bind the key to an instance of the given class. |
67
67
  | [toDynamicValue(factory)](./context.binding.todynamicvalue.md) | | Bind the key to a computed (dynamic) value. |
68
- | [toInjectable(ctor)](./context.binding.toinjectable.md) | | Bind to a class optionally decorated with <code>@injectable</code>. Based on the introspection of the class, it calls <code>toClass/toProvider/toDynamicValue</code> internally. The current binding key will be preserved (not being overridden by the key inferred from the class or options).<!-- -->This is similar to [createBindingFromClass()](./context.createbindingfromclass.md) but applies to an existing binding. |
68
+ | [toInjectable(ctor)](./context.binding.toinjectable.md) | | <p>Bind to a class optionally decorated with <code>@injectable</code>. Based on the introspection of the class, it calls <code>toClass/toProvider/toDynamicValue</code> internally. The current binding key will be preserved (not being overridden by the key inferred from the class or options).</p><p>This is similar to [createBindingFromClass()](./context.createbindingfromclass.md) but applies to an existing binding.</p> |
69
69
  | [toJSON()](./context.binding.tojson.md) | | Convert to a plain JSON object |
70
- | [toProvider(providerClass)](./context.binding.toprovider.md) | | Bind the key to a value computed by a Provider.<!-- -->\* |
70
+ | [toProvider(providerClass)](./context.binding.toprovider.md) | | <p>Bind the key to a value computed by a Provider.</p><p>\*</p> |
71
71
  | [unlock()](./context.binding.unlock.md) | | Unlock the binding |
72
72
 
73
73
 
@@ -23,9 +23,9 @@ export interface BindingElement
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | --- | --- | --- |
28
- | [type](./context.bindingelement.type.md) | 'binding' | |
29
- | [value](./context.bindingelement.value.md) | Readonly&lt;[Binding](./context.binding.md)<!-- -->&gt; | |
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [type](./context.bindingelement.type.md) | | 'binding' | |
29
+ | [value](./context.bindingelement.value.md) | | Readonly&lt;[Binding](./context.binding.md)<!-- -->&gt; | |
30
30
 
31
31
 
@@ -23,8 +23,8 @@ export interface BindingInspectOptions
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | --- | --- | --- |
28
- | [includeInjections?](./context.bindinginspectoptions.includeinjections.md) | boolean | <i>(Optional)</i> The flag to control if injections should be inspected |
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [includeInjections?](./context.bindinginspectoptions.includeinjections.md) | | boolean | <i>(Optional)</i> The flag to control if injections should be inspected |
29
29
 
30
30
 
@@ -24,9 +24,9 @@ export declare class BindingKey<ValueType>
24
24
  | Property | Modifiers | Type | Description |
25
25
  | --- | --- | --- | --- |
26
26
  | [CONFIG\_NAMESPACE](./context.bindingkey.config_namespace.md) | <code>static</code> | string | Name space for configuration binding keys |
27
- | [key](./context.bindingkey.key.md) | | string | |
28
- | [PROPERTY\_SEPARATOR](./context.bindingkey.property_separator.md) | <code>static</code> | (not declared) | |
29
- | [propertyPath?](./context.bindingkey.propertypath.md) | | string \| undefined | <i>(Optional)</i> |
27
+ | [key](./context.bindingkey.key.md) | <code>readonly</code> | string | |
28
+ | [PROPERTY\_SEPARATOR](./context.bindingkey.property_separator.md) | <p><code>readonly</code></p><p><code>static</code></p> | (not declared) | |
29
+ | [propertyPath?](./context.bindingkey.propertypath.md) | <code>readonly</code> | string \| undefined | <i>(Optional)</i> |
30
30
 
31
31
  ## Methods
32
32
 
@@ -35,7 +35,7 @@ export declare class BindingKey<ValueType>
35
35
  | [buildKeyForConfig(key)](./context.bindingkey.buildkeyforconfig.md) | <code>static</code> | Build a binding key for the configuration of the given binding. The format is <code>&lt;key&gt;:$config</code> |
36
36
  | [create(key, propertyPath)](./context.bindingkey.create.md) | <code>static</code> | Create a new key for a binding bound to a value of type <code>ValueType</code>. |
37
37
  | [deepProperty(propertyPath)](./context.bindingkey.deepproperty.md) | | Get a binding address for retrieving a deep property of the object bound to the current binding key. |
38
- | [generate(namespace)](./context.bindingkey.generate.md) | <code>static</code> | Generate a universally unique binding key.<!-- -->Please note the format of they generated key is not specified, you must not rely on any specific formatting (e.g. UUID style). |
38
+ | [generate(namespace)](./context.bindingkey.generate.md) | <code>static</code> | <p>Generate a universally unique binding key.</p><p>Please note the format of they generated key is not specified, you must not rely on any specific formatting (e.g. UUID style).</p> |
39
39
  | [parseKeyWithPath(keyWithPath)](./context.bindingkey.parsekeywithpath.md) | <code>static</code> | Parse a string containing both the binding key and the path to the deeply nested property to retrieve. |
40
40
  | [toString()](./context.bindingkey.tostring.md) | | |
41
41
  | [validate(key)](./context.bindingkey.validate.md) | <code>static</code> | Validate the binding key format. Please note that <code>#</code> is reserved. Returns a string representation of the binding key. |
@@ -29,7 +29,7 @@ export declare enum BindingScope
29
29
  | CONTEXT | <code>&quot;Context&quot;</code> | |
30
30
  | REQUEST | <code>&quot;Request&quot;</code> | Request scope |
31
31
  | SERVER | <code>&quot;Server&quot;</code> | Server scope |
32
- | SINGLETON | <code>&quot;Singleton&quot;</code> | The binding provides a value as a singleton within the context hierarchy (the owning context and its descendants). The value is calculated only once for the owning context and cached for subsequential uses. Child contexts share the same value as their ancestors.<!-- -->For example, with the following context hierarchy:<!-- -->- <code>app</code> (with a binding <code>'b1'</code> that produces sequential values 0, 1, ...) - req1 - req2<!-- -->1. <code>0</code> is the singleton for <code>app</code> afterward - app.get('b1') ==<!-- -->&gt; 0 (always)<!-- -->2. <code>'b1'</code> is resolved in <code>app</code>, reuse it for <code>req1</code> - req1.get('b1') ==<!-- -->&gt; 0 (always)<!-- -->3. <code>'b1'</code> is resolved in <code>app</code>, reuse it for <code>req2</code> - req2.get('b1') ==<!-- -->&gt; 0 (always) |
33
- | TRANSIENT | <code>&quot;Transient&quot;</code> | The binding provides a value that is calculated each time. This will be the default scope if not set.<!-- -->For example, with the following context hierarchy:<!-- -->- <code>app</code> (with a binding <code>'b1'</code> that produces sequential values 0, 1, ...) - req1 - req2<!-- -->Now <code>'b1'</code> is resolved to a new value each time for <code>app</code> and its descendants <code>req1</code> and <code>req2</code>: - app.get('b1') ==<!-- -->&gt; 0 - req1.get('b1') ==<!-- -->&gt; 1 - req2.get('b1') ==<!-- -->&gt; 2 - req2.get('b1') ==<!-- -->&gt; 3 - app.get('b1') ==<!-- -->&gt; 4 |
32
+ | SINGLETON | <code>&quot;Singleton&quot;</code> | <p>The binding provides a value as a singleton within the context hierarchy (the owning context and its descendants). The value is calculated only once for the owning context and cached for subsequential uses. Child contexts share the same value as their ancestors.</p><p>For example, with the following context hierarchy:</p><p>- <code>app</code> (with a binding <code>'b1'</code> that produces sequential values 0, 1, ...) - req1 - req2</p><p>1. <code>0</code> is the singleton for <code>app</code> afterward - app.get('b1') ==<!-- -->&gt; 0 (always)</p><p>2. <code>'b1'</code> is resolved in <code>app</code>, reuse it for <code>req1</code> - req1.get('b1') ==<!-- -->&gt; 0 (always)</p><p>3. <code>'b1'</code> is resolved in <code>app</code>, reuse it for <code>req2</code> - req2.get('b1') ==<!-- -->&gt; 0 (always)</p> |
33
+ | TRANSIENT | <code>&quot;Transient&quot;</code> | <p>The binding provides a value that is calculated each time. This will be the default scope if not set.</p><p>For example, with the following context hierarchy:</p><p>- <code>app</code> (with a binding <code>'b1'</code> that produces sequential values 0, 1, ...) - req1 - req2</p><p>Now <code>'b1'</code> is resolved to a new value each time for <code>app</code> and its descendants <code>req1</code> and <code>req2</code>: - app.get('b1') ==<!-- -->&gt; 0 - req1.get('b1') ==<!-- -->&gt; 1 - req2.get('b1') ==<!-- -->&gt; 2 - req2.get('b1') ==<!-- -->&gt; 3 - app.get('b1') ==<!-- -->&gt; 4</p> |
34
34
 
35
35
 
@@ -24,8 +24,8 @@ export interface BindingTagFilter extends BindingFilter
24
24
 
25
25
  ## Properties
26
26
 
27
- | Property | Type | Description |
28
- | --- | --- | --- |
29
- | [bindingTagPattern](./context.bindingtagfilter.bindingtagpattern.md) | [BindingTag](./context.bindingtag.md) \| RegExp | A special property on the filter function to provide access to the binding tag pattern which can be utilized to optimize the matching of bindings by tag in a context. |
27
+ | Property | Modifiers | Type | Description |
28
+ | --- | --- | --- | --- |
29
+ | [bindingTagPattern](./context.bindingtagfilter.bindingtagpattern.md) | | [BindingTag](./context.bindingtag.md) \| RegExp | A special property on the filter function to provide access to the binding tag pattern which can be utilized to optimize the matching of bindings by tag in a context. |
30
30
 
31
31
 
@@ -18,6 +18,6 @@ permalink: /doc/en/lb4/apidocs.context.config.getter.html
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- getter: (propertyPath?: string | ConfigInjectionMetadata | undefined, metadata?: ConfigInjectionMetadata | undefined) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
21
+ getter: (propertyPath?: string | ConfigInjectionMetadata, metadata?: ConfigInjectionMetadata) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
22
22
  ```
23
23
 
@@ -18,6 +18,6 @@ permalink: /doc/en/lb4/apidocs.context.config.view.html
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- view: (propertyPath?: string | ConfigInjectionMetadata | undefined, metadata?: ConfigInjectionMetadata | undefined) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
21
+ view: (propertyPath?: string | ConfigInjectionMetadata, metadata?: ConfigInjectionMetadata) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
22
22
  ```
23
23
 
@@ -24,9 +24,9 @@ export interface ConfigInjectionMetadata extends InjectionMetadata
24
24
 
25
25
  ## Properties
26
26
 
27
- | Property | Type | Description |
28
- | --- | --- | --- |
29
- | [fromBinding?](./context.configinjectionmetadata.frombinding.md) | [BindingAddress](./context.bindingaddress.md) | <i>(Optional)</i> Customize the target binding key from which the configuration is fetched. If not specified, the configuration of the current binding that contains the injection is used. |
30
- | [propertyPath?](./context.configinjectionmetadata.propertypath.md) | string | <i>(Optional)</i> Property path to retrieve the configuration of the target binding, for example, <code>rest.host</code>. |
27
+ | Property | Modifiers | Type | Description |
28
+ | --- | --- | --- | --- |
29
+ | [fromBinding?](./context.configinjectionmetadata.frombinding.md) | | [BindingAddress](./context.bindingaddress.md) | <i>(Optional)</i> Customize the target binding key from which the configuration is fetched. If not specified, the configuration of the current binding that contains the injection is used. |
30
+ | [propertyPath?](./context.configinjectionmetadata.propertypath.md) | | string | <i>(Optional)</i> Property path to retrieve the configuration of the target binding, for example, <code>rest.host</code>. |
31
31
 
32
32
 
@@ -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) | <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. |
28
+ | pattern | string \| RegExp \| [BindingFilter](./context.bindingfilter.md) | <p><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.</p><p>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></p><p>For a filter function: - return <code>true</code> to include the binding in the results - return <code>false</code> to exclude it.</p> |
29
29
 
30
30
  <b>Returns:</b>
31
31
 
@@ -32,28 +32,28 @@ export declare class Context extends EventEmitter
32
32
 
33
33
  | Property | Modifiers | Type | Description |
34
34
  | --- | --- | --- | --- |
35
- | [\_debug](./context.context._debug.md) | | Debugger | A debug function which can be overridden by subclasses. |
36
- | [\_parent?](./context.context._parent.md) | | [Context](./context.context.md) | <i>(Optional)</i> Parent context |
37
- | [configResolver](./context.context.configresolver.md) | | [ConfigurationResolver](./context.configurationresolver.md) | Configuration resolver |
38
- | [name](./context.context.name.md) | | string | Name of the context |
39
- | [registry](./context.context.registry.md) | | Map&lt;string, [Binding](./context.binding.md)<!-- -->&gt; | Key to binding map as the internal registry |
35
+ | [\_debug](./context.context._debug.md) | <code>protected</code> | Debugger | A debug function which can be overridden by subclasses. |
36
+ | [\_parent?](./context.context._parent.md) | <code>protected</code> | [Context](./context.context.md) | <i>(Optional)</i> Parent context |
37
+ | [configResolver](./context.context.configresolver.md) | <code>protected</code> | [ConfigurationResolver](./context.configurationresolver.md) | Configuration resolver |
38
+ | [name](./context.context.name.md) | <code>readonly</code> | string | Name of the context |
39
+ | [registry](./context.context.registry.md) | <p><code>protected</code></p><p><code>readonly</code></p> | Map&lt;string, [Binding](./context.binding.md)<!-- -->&gt; | Key to binding map as the internal registry |
40
40
  | [scope](./context.context.scope.md) | | [BindingScope](./context.bindingscope.md) | Scope for binding resolution |
41
- | [subscriptionManager](./context.context.subscriptionmanager.md) | | [ContextSubscriptionManager](./context.contextsubscriptionmanager.md) | Manager for observer subscriptions |
42
- | [tagIndexer](./context.context.tagindexer.md) | | ContextTagIndexer | Indexer for bindings by tag |
41
+ | [subscriptionManager](./context.context.subscriptionmanager.md) | <code>readonly</code> | [ContextSubscriptionManager](./context.contextsubscriptionmanager.md) | Manager for observer subscriptions |
42
+ | [tagIndexer](./context.context.tagindexer.md) | <p><code>protected</code></p><p><code>readonly</code></p> | ContextTagIndexer | Indexer for bindings by tag |
43
43
 
44
44
  ## Methods
45
45
 
46
46
  | Method | Modifiers | Description |
47
47
  | --- | --- | --- |
48
- | [\_findByTagIndex(tag)](./context.context._findbytagindex.md) | | Find bindings by tag leveraging indexes |
49
- | [\_mergeWithParent(childList, parentList)](./context.context._mergewithparent.md) | | |
48
+ | [\_findByTagIndex(tag)](./context.context._findbytagindex.md) | <code>protected</code> | Find bindings by tag leveraging indexes |
49
+ | [\_mergeWithParent(childList, parentList)](./context.context._mergewithparent.md) | <code>protected</code> | |
50
50
  | [add(binding)](./context.context.add.md) | | Add a binding to the context. If a locked binding already exists with the same key, an error will be thrown. |
51
51
  | [bind(key)](./context.context.bind.md) | | Create a binding with the given key in the context. If a locked binding already exists with the same key, an error will be thrown. |
52
52
  | [close()](./context.context.close.md) | | Close the context: clear observers, stop notifications, and remove event listeners from its parent context. |
53
- | [configure(key)](./context.context.configure.md) | | Create a corresponding binding for configuration of the target bound by the given key in the context.<!-- -->For example, <code>ctx.configure('controllers.MyController').to({x: 1})</code> will create binding <code>controllers.MyController:$config</code> with value <code>{x: 1}</code>. |
53
+ | [configure(key)](./context.context.configure.md) | | <p>Create a corresponding binding for configuration of the target bound by the given key in the context.</p><p>For example, <code>ctx.configure('controllers.MyController').to({x: 1})</code> will create binding <code>controllers.MyController:$config</code> with value <code>{x: 1}</code>.</p> |
54
54
  | [contains(key)](./context.context.contains.md) | | Check if a binding exists with the given key in the local context without delegating to the parent context |
55
55
  | [createView(filter, comparator, options)](./context.context.createview.md) | | Create a view of the context chain with the given binding filter |
56
- | [debug(args)](./context.context.debug.md) | | Wrap the debug statement so that it always print out the context name as the prefix |
56
+ | [debug(args)](./context.context.debug.md) | <code>protected</code> | Wrap the debug statement so that it always print out the context name as the prefix |
57
57
  | [emitError(err)](./context.context.emiterror.md) | | Emit an <code>error</code> event |
58
58
  | [emitEvent(type, event)](./context.context.emitevent.md) | | A strongly-typed method to emit context events |
59
59
  | [find(pattern)](./context.context.find.md) | | Find bindings using a key pattern or filter function |
@@ -66,12 +66,12 @@ export declare class Context extends EventEmitter
66
66
  | [getConfig(key, propertyPath, resolutionOptions)](./context.context.getconfig.md) | | Resolve configuration for the binding by key |
67
67
  | [getConfigAsValueOrPromise(key, propertyPath, resolutionOptions)](./context.context.getconfigasvalueorpromise.md) | | Get the value or promise of configuration for a given binding by key |
68
68
  | [getConfigSync(key, propertyPath, resolutionOptions)](./context.context.getconfigsync.md) | | Resolve configuration synchronously for the binding by key |
69
- | [getDebugNamespace()](./context.context.getdebugnamespace.md) | | Get the debug namespace for the context class. Subclasses can override this method to supply its own namespace. |
69
+ | [getDebugNamespace()](./context.context.getdebugnamespace.md) | <code>protected</code> | Get the debug namespace for the context class. Subclasses can override this method to supply its own namespace. |
70
70
  | [getOwnerContext(keyOrBinding)](./context.context.getownercontext.md) | | Get the owning context for a binding or its key |
71
71
  | [getResolutionContext(binding)](./context.context.getresolutioncontext.md) | | Locate the resolution context for the given binding. Only bindings in the resolution context and its ancestors are visible as dependencies to resolve the given binding |
72
72
  | [getScopedContext(scope)](./context.context.getscopedcontext.md) | | Get the context matching the scope |
73
- | [getSync(keyWithPath, session)](./context.context.getsync.md) | | Get the synchronous value bound to the given key, optionally return a (deep) property of the bound value.<!-- -->This method throws an error if the bound value requires async computation (returns a promise). You should never rely on sync bindings in production code. |
74
- | [getSync(keyWithPath, options)](./context.context.getsync_1.md) | | Get the synchronous value bound to the given key, optionally return a (deep) property of the bound value.<!-- -->This method throws an error if the bound value requires async computation (returns a promise). You should never rely on sync bindings in production code. |
73
+ | [getSync(keyWithPath, session)](./context.context.getsync.md) | | <p>Get the synchronous value bound to the given key, optionally return a (deep) property of the bound value.</p><p>This method throws an error if the bound value requires async computation (returns a promise). You should never rely on sync bindings in production code.</p> |
74
+ | [getSync(keyWithPath, options)](./context.context.getsync_1.md) | | <p>Get the synchronous value bound to the given key, optionally return a (deep) property of the bound value.</p><p>This method throws an error if the bound value requires async computation (returns a promise). You should never rely on sync bindings in production code.</p> |
75
75
  | [inspect(options)](./context.context.inspect.md) | | Inspect the context and dump out a JSON object representing the context hierarchy |
76
76
  | [isBound(key)](./context.context.isbound.md) | | Check if a key is bound in the context or its ancestors |
77
77
  | [isSubscribed(observer)](./context.context.issubscribed.md) | | Check if an observer is subscribed to this context |
@@ -80,7 +80,7 @@ export declare class Context extends EventEmitter
80
80
  | [on(event, listener)](./context.context.on_1.md) | | |
81
81
  | [once(eventName, listener)](./context.context.once.md) | | The "bind" event is emitted when a new binding is added to the context. The "unbind" event is emitted when an existing binding is removed. |
82
82
  | [once(event, listener)](./context.context.once_1.md) | | |
83
- | [setupConfigurationResolverIfNeeded()](./context.context.setupconfigurationresolverifneeded.md) | | Set up the configuration resolver if needed |
83
+ | [setupConfigurationResolverIfNeeded()](./context.context.setupconfigurationresolverifneeded.md) | <code>protected</code> | Set up the configuration resolver if needed |
84
84
  | [subscribe(observer)](./context.context.subscribe.md) | | Add a context event observer to the context |
85
85
  | [toJSON()](./context.context.tojson.md) | | Create a plain JSON object for the context |
86
86
  | [unbind(key)](./context.context.unbind.md) | | Unbind a binding from the context. No parent contexts will be checked. |
@@ -24,8 +24,8 @@ export interface ContextInspectOptions extends BindingInspectOptions
24
24
 
25
25
  ## Properties
26
26
 
27
- | Property | Type | Description |
28
- | --- | --- | --- |
29
- | [includeParent?](./context.contextinspectoptions.includeparent.md) | boolean | <i>(Optional)</i> The flag to control if parent context should be inspected |
27
+ | Property | Modifiers | Type | Description |
28
+ | --- | --- | --- | --- |
29
+ | [includeParent?](./context.contextinspectoptions.includeparent.md) | | boolean | <i>(Optional)</i> The flag to control if parent context should be inspected |
30
30
 
31
31
 
@@ -23,9 +23,9 @@ export interface ContextObserver
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | --- | --- | --- |
28
- | [filter?](./context.contextobserver.filter.md) | [BindingFilter](./context.bindingfilter.md) | <i>(Optional)</i> An optional filter function to match bindings. If not present, the listener will be notified of all binding events. |
29
- | [observe](./context.contextobserver.observe.md) | [ContextObserverFn](./context.contextobserverfn.md) | Listen on <code>bind</code>, <code>unbind</code>, or other events |
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [filter?](./context.contextobserver.filter.md) | | [BindingFilter](./context.bindingfilter.md) | <i>(Optional)</i> An optional filter function to match bindings. If not present, the listener will be notified of all binding events. |
29
+ | [observe](./context.contextobserver.observe.md) | | [ContextObserverFn](./context.contextobserverfn.md) | Listen on <code>bind</code>, <code>unbind</code>, or other events |
30
30
 
31
31
 
@@ -32,9 +32,9 @@ export declare class ContextSubscriptionManager extends EventEmitter
32
32
 
33
33
  | Property | Modifiers | Type | Description |
34
34
  | --- | --- | --- | --- |
35
- | [\_observers](./context.contextsubscriptionmanager._observers.md) | | Set&lt;[ContextEventObserver](./context.contexteventobserver.md)<!-- -->&gt; \| undefined | A list of registered context observers. The Set will be created when the first observer is added. |
36
- | [\_parentContextEventListener?](./context.contextsubscriptionmanager._parentcontexteventlistener.md) | | [ContextEventListener](./context.contexteventlistener.md) | <i>(Optional)</i> A listener to watch parent context events |
37
- | [context](./context.contextsubscriptionmanager.context.md) | | [Context](./context.context.md) | |
35
+ | [\_observers](./context.contextsubscriptionmanager._observers.md) | <code>protected</code> | Set&lt;[ContextEventObserver](./context.contexteventobserver.md)<!-- -->&gt; \| undefined | A list of registered context observers. The Set will be created when the first observer is added. |
36
+ | [\_parentContextEventListener?](./context.contextsubscriptionmanager._parentcontexteventlistener.md) | <code>protected</code> | [ContextEventListener](./context.contexteventlistener.md) | <i>(Optional)</i> A listener to watch parent context events |
37
+ | [context](./context.contextsubscriptionmanager.context.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [Context](./context.context.md) | |
38
38
 
39
39
  ## Methods
40
40
 
@@ -42,9 +42,9 @@ export declare class ContextSubscriptionManager extends EventEmitter
42
42
  | --- | --- | --- |
43
43
  | [close()](./context.contextsubscriptionmanager.close.md) | | Close the context: clear observers, stop notifications, and remove event listeners from its parent context. |
44
44
  | [isSubscribed(observer)](./context.contextsubscriptionmanager.issubscribed.md) | | Check if an observer is subscribed to this context |
45
- | [notifyObservers(event, observers)](./context.contextsubscriptionmanager.notifyobservers.md) | | Publish an event to the registered observers. Please note the notification is queued and performed asynchronously so that we allow fluent APIs such as <code>ctx.bind('key').to(...).tag(...);</code> and give observers the fully populated binding. |
45
+ | [notifyObservers(event, observers)](./context.contextsubscriptionmanager.notifyobservers.md) | <code>protected</code> | Publish an event to the registered observers. Please note the notification is queued and performed asynchronously so that we allow fluent APIs such as <code>ctx.bind('key').to(...).tag(...);</code> and give observers the fully populated binding. |
46
46
  | [subscribe(observer)](./context.contextsubscriptionmanager.subscribe.md) | | Add a context event observer to the context |
47
47
  | [unsubscribe(observer)](./context.contextsubscriptionmanager.unsubscribe.md) | | Remove the context event observer from the context |
48
- | [waitUntilPendingNotificationsDone(timeout)](./context.contextsubscriptionmanager.waituntilpendingnotificationsdone.md) | | Wait until observers are notified for all of currently pending notification events.<!-- -->This method is for test only to perform assertions after observers are notified for relevant events. |
48
+ | [waitUntilPendingNotificationsDone(timeout)](./context.contextsubscriptionmanager.waituntilpendingnotificationsdone.md) | | <p>Wait until observers are notified for all of currently pending notification events.</p><p>This method is for test only to perform assertions after observers are notified for relevant events.</p> |
49
49
 
50
50
 
@@ -38,12 +38,12 @@ export declare class ContextView<T = unknown> extends EventEmitter implements Co
38
38
 
39
39
  | Property | Modifiers | Type | Description |
40
40
  | --- | --- | --- | --- |
41
- | [\_cachedBindings](./context.contextview._cachedbindings.md) | | Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;T&gt;&gt;\[\] \| undefined | An array of cached bindings that matches the binding filter |
42
- | [\_cachedValues](./context.contextview._cachedvalues.md) | | Map&lt;Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;T&gt;&gt;, T&gt; \| undefined | A map of cached values by binding |
43
- | [bindings](./context.contextview.bindings.md) | | Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;T&gt;&gt;\[\] | Get the list of matched bindings. If they are not cached, it tries to find them from the context. |
44
- | [comparator?](./context.contextview.comparator.md) | | [BindingComparator](./context.bindingcomparator.md) \| undefined | <i>(Optional)</i> |
45
- | [context](./context.contextview.context.md) | | [Context](./context.context.md) | |
46
- | [filter](./context.contextview.filter.md) | | [BindingFilter](./context.bindingfilter.md) | |
41
+ | [\_cachedBindings](./context.contextview._cachedbindings.md) | <code>protected</code> | Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;T&gt;&gt;\[\] \| undefined | An array of cached bindings that matches the binding filter |
42
+ | [\_cachedValues](./context.contextview._cachedvalues.md) | <code>protected</code> | Map&lt;Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;T&gt;&gt;, T&gt; \| undefined | A map of cached values by binding |
43
+ | [bindings](./context.contextview.bindings.md) | <code>readonly</code> | Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;T&gt;&gt;\[\] | Get the list of matched bindings. If they are not cached, it tries to find them from the context. |
44
+ | [comparator?](./context.contextview.comparator.md) | <code>readonly</code> | [BindingComparator](./context.bindingcomparator.md) \| undefined | <i>(Optional)</i> |
45
+ | [context](./context.contextview.context.md) | <code>readonly</code> | [Context](./context.context.md) | |
46
+ | [filter](./context.contextview.filter.md) | <code>readonly</code> | [BindingFilter](./context.bindingfilter.md) | |
47
47
 
48
48
  ## Methods
49
49
 
@@ -51,7 +51,7 @@ export declare class ContextView<T = unknown> extends EventEmitter implements Co
51
51
  | --- | --- | --- |
52
52
  | [asGetter(session)](./context.contextview.asgetter.md) | | As a <code>Getter</code> function |
53
53
  | [close()](./context.contextview.close.md) | | Stop listening events from the context |
54
- | [findBindings()](./context.contextview.findbindings.md) | | Find matching bindings and refresh the cache |
54
+ | [findBindings()](./context.contextview.findbindings.md) | <code>protected</code> | Find matching bindings and refresh the cache |
55
55
  | [observe(event, binding, context)](./context.contextview.observe.md) | | Listen on <code>bind</code> or <code>unbind</code> and invalidate the cache |
56
56
  | [on(eventName, listener)](./context.contextview.on.md) | | The "bind" event is emitted when a new binding is added to the view. |
57
57
  | [on(eventName, listener)](./context.contextview.on_1.md) | | The "unbind" event is emitted a new binding is removed from the view. |
@@ -24,8 +24,8 @@ export interface ContextViewEvent<T> extends ContextEvent
24
24
 
25
25
  ## Properties
26
26
 
27
- | Property | Type | Description |
28
- | --- | --- | --- |
29
- | [cachedValue?](./context.contextviewevent.cachedvalue.md) | T | <i>(Optional)</i> Optional cached value for an <code>unbind</code> event |
27
+ | Property | Modifiers | Type | Description |
28
+ | --- | --- | --- | --- |
29
+ | [cachedValue?](./context.contextviewevent.cachedvalue.md) | | T | <i>(Optional)</i> Optional cached value for an <code>unbind</code> event |
30
30
 
31
31
 
@@ -32,7 +32,7 @@ export declare class DefaultConfigurationResolver implements ConfigurationResolv
32
32
 
33
33
  | Property | Modifiers | Type | Description |
34
34
  | --- | --- | --- | --- |
35
- | [context](./context.defaultconfigurationresolver.context.md) | | [Context](./context.context.md) | |
35
+ | [context](./context.defaultconfigurationresolver.context.md) | <code>readonly</code> | [Context](./context.context.md) | |
36
36
 
37
37
  ## Methods
38
38
 
@@ -37,8 +37,8 @@ export class DynamicGreetingProvider {
37
37
 
38
38
  ## Properties
39
39
 
40
- | Property | Type | Description |
41
- | --- | --- | --- |
42
- | [value](./context.dynamicvalueproviderclass.value.md) | (...args: [BoundValue](./context.boundvalue.md)<!-- -->\[\]) =&gt; [ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;T&gt; | |
40
+ | Property | Modifiers | Type | Description |
41
+ | --- | --- | --- | --- |
42
+ | [value](./context.dynamicvalueproviderclass.value.md) | | (...args: [BoundValue](./context.boundvalue.md)<!-- -->\[\]) =&gt; [ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;T&gt; | |
43
43
 
44
44
 
@@ -32,7 +32,7 @@ export declare class GenericInterceptorChain<C extends Context = Context>
32
32
 
33
33
  | Property | Modifiers | Type | Description |
34
34
  | --- | --- | --- | --- |
35
- | [getInterceptors](./context.genericinterceptorchain.getinterceptors.md) | | () =&gt; [GenericInterceptorOrKey](./context.genericinterceptororkey.md)<!-- -->&lt;C&gt;\[\] | A getter for an array of interceptor functions or binding keys |
35
+ | [getInterceptors](./context.genericinterceptorchain.getinterceptors.md) | <code>protected</code> | () =&gt; [GenericInterceptorOrKey](./context.genericinterceptororkey.md)<!-- -->&lt;C&gt;\[\] | A getter for an array of interceptor functions or binding keys |
36
36
 
37
37
  ## Methods
38
38
 
@@ -18,7 +18,7 @@ Inject the binding object for the given key. This is useful if a binding needs t
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- binding: (bindingKey?: string | BindingKey<unknown> | undefined, metadata?: InjectBindingMetadata | undefined) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
21
+ binding: (bindingKey?: string | BindingKey<unknown>, metadata?: InjectBindingMetadata) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
22
22
  ```
23
23
 
24
24
  ## Example
@@ -22,6 +22,6 @@ See also `Getter<T>`<!-- -->.
22
22
  <b>Signature:</b>
23
23
 
24
24
  ```typescript
25
- getter: (bindingSelector: BindingSelector<unknown>, metadata?: InjectionMetadata | undefined) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
25
+ getter: (bindingSelector: BindingSelector<unknown>, metadata?: InjectionMetadata) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
26
26
  ```
27
27
 
@@ -25,8 +25,8 @@ export declare namespace inject
25
25
  | --- | --- |
26
26
  | [binding](./context.inject.binding.md) | Inject the binding object for the given key. This is useful if a binding needs to be set up beyond just a constant value allowed by <code>@inject.setter</code>. The injected binding is found or created based on the <code>metadata.bindingCreation</code> option. See <code>BindingCreationPolicy</code> for more details. |
27
27
  | [context](./context.inject.context.md) | Inject the context object. |
28
- | [getter](./context.inject.getter.md) | Inject a function for getting the actual bound value.<!-- -->This is useful when implementing Actions, where the action is instantiated for Sequence constructor, but some of action's dependencies become bound only after other actions have been executed by the sequence.<!-- -->See also <code>Getter&lt;T&gt;</code>. |
29
- | [setter](./context.inject.setter.md) | Inject a function for setting (binding) the given key to a given value. (Only static/constant values are supported, it's not possible to bind a key to a class or a provider.)<!-- -->This is useful e.g. when implementing Actions that are contributing new Elements.<!-- -->See also <code>Setter&lt;T&gt;</code>. |
28
+ | [getter](./context.inject.getter.md) | <p>Inject a function for getting the actual bound value.</p><p>This is useful when implementing Actions, where the action is instantiated for Sequence constructor, but some of action's dependencies become bound only after other actions have been executed by the sequence.</p><p>See also <code>Getter&lt;T&gt;</code>.</p> |
29
+ | [setter](./context.inject.setter.md) | <p>Inject a function for setting (binding) the given key to a given value. (Only static/constant values are supported, it's not possible to bind a key to a class or a provider.)</p><p>This is useful e.g. when implementing Actions that are contributing new Elements.</p><p>See also <code>Setter&lt;T&gt;</code>.</p> |
30
30
  | [tag](./context.inject.tag.md) | Inject an array of values by a tag pattern string or regexp |
31
31
  | [view](./context.inject.view.md) | Inject matching bound values by the filter function |
32
32
 
@@ -22,6 +22,6 @@ See also `Setter<T>`<!-- -->.
22
22
  <b>Signature:</b>
23
23
 
24
24
  ```typescript
25
- setter: (bindingKey: BindingAddress, metadata?: InjectBindingMetadata | undefined) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
25
+ setter: (bindingKey: BindingAddress, metadata?: InjectBindingMetadata) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
26
26
  ```
27
27
 
@@ -18,7 +18,7 @@ Inject an array of values by a tag pattern string or regexp
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- tag: (bindingTag: BindingTag | RegExp, metadata?: InjectionMetadata | undefined) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
21
+ tag: (bindingTag: BindingTag | RegExp, metadata?: InjectionMetadata) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
22
22
  ```
23
23
 
24
24
  ## Example
@@ -18,7 +18,7 @@ Inject matching bound values by the filter function
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- view: (bindingFilter: BindingFilter, metadata?: InjectionMetadata | undefined) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
21
+ view: (bindingFilter: BindingFilter, metadata?: InjectionMetadata) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
22
22
  ```
23
23
 
24
24
  ## Example
@@ -25,6 +25,6 @@ export declare namespace injectable
25
25
 
26
26
  | Function | Description |
27
27
  | --- | --- |
28
- | [provider(specs)](./context.injectable.provider.md) | <code>@injectable.provider</code> to denote a provider class<!-- -->A list of binding scope/tags or template functions to configure the binding |
28
+ | [provider(specs)](./context.injectable.provider.md) | <p><code>@injectable.provider</code> to denote a provider class</p><p>A list of binding scope/tags or template functions to configure the binding</p> |
29
29
 
30
30
 
@@ -24,8 +24,8 @@ export interface InjectBindingMetadata extends InjectionMetadata
24
24
 
25
25
  ## Properties
26
26
 
27
- | Property | Type | Description |
28
- | --- | --- | --- |
29
- | [bindingCreation?](./context.injectbindingmetadata.bindingcreation.md) | [BindingCreationPolicy](./context.bindingcreationpolicy.md) | <i>(Optional)</i> Controls how the underlying binding is resolved/created |
27
+ | Property | Modifiers | Type | Description |
28
+ | --- | --- | --- | --- |
29
+ | [bindingCreation?](./context.injectbindingmetadata.bindingcreation.md) | | [BindingCreationPolicy](./context.bindingcreationpolicy.md) | <i>(Optional)</i> Controls how the underlying binding is resolved/created |
30
30
 
31
31
 
@@ -23,13 +23,13 @@ export interface Injection<ValueType = BoundValue>
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | --- | --- | --- |
28
- | [bindingSelector](./context.injection.bindingselector.md) | [BindingSelector](./context.bindingselector.md)<!-- -->&lt;ValueType&gt; | |
29
- | [member?](./context.injection.member.md) | string | <i>(Optional)</i> |
30
- | [metadata](./context.injection.metadata.md) | [InjectionMetadata](./context.injectionmetadata.md) | |
31
- | [methodDescriptorOrParameterIndex?](./context.injection.methoddescriptororparameterindex.md) | TypedPropertyDescriptor&lt;ValueType&gt; \| number | <i>(Optional)</i> |
32
- | [resolve?](./context.injection.resolve.md) | [ResolverFunction](./context.resolverfunction.md) | <i>(Optional)</i> |
33
- | [target](./context.injection.target.md) | Object | |
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [bindingSelector](./context.injection.bindingselector.md) | | [BindingSelector](./context.bindingselector.md)<!-- -->&lt;ValueType&gt; | |
29
+ | [member?](./context.injection.member.md) | | string | <i>(Optional)</i> |
30
+ | [metadata](./context.injection.metadata.md) | | [InjectionMetadata](./context.injectionmetadata.md) | |
31
+ | [methodDescriptorOrParameterIndex?](./context.injection.methoddescriptororparameterindex.md) | | TypedPropertyDescriptor&lt;ValueType&gt; \| number | <i>(Optional)</i> |
32
+ | [resolve?](./context.injection.resolve.md) | | [ResolverFunction](./context.resolverfunction.md) | <i>(Optional)</i> |
33
+ | [target](./context.injection.target.md) | | Object | |
34
34
 
35
35
 
@@ -21,10 +21,10 @@ export interface InjectionDescriptor
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Type | Description |
25
- | --- | --- | --- |
26
- | [bindingSelector](./context.injectiondescriptor.bindingselector.md) | [BindingSelector](./context.bindingselector.md) | |
27
- | [metadata](./context.injectiondescriptor.metadata.md) | [InjectionMetadata](./context.injectionmetadata.md) | |
28
- | [targetName](./context.injectiondescriptor.targetname.md) | string | |
24
+ | Property | Modifiers | Type | Description |
25
+ | --- | --- | --- | --- |
26
+ | [bindingSelector](./context.injectiondescriptor.bindingselector.md) | | [BindingSelector](./context.bindingselector.md) | |
27
+ | [metadata](./context.injectiondescriptor.metadata.md) | | [InjectionMetadata](./context.injectionmetadata.md) | |
28
+ | [targetName](./context.injectiondescriptor.targetname.md) | | string | |
29
29
 
30
30
 
@@ -23,9 +23,9 @@ export interface InjectionElement
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | --- | --- | --- |
28
- | [type](./context.injectionelement.type.md) | 'injection' | |
29
- | [value](./context.injectionelement.value.md) | Readonly&lt;[Injection](./context.injection.md)<!-- -->&gt; | |
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [type](./context.injectionelement.type.md) | | 'injection' | |
29
+ | [value](./context.injectionelement.value.md) | | Readonly&lt;[Injection](./context.injection.md)<!-- -->&gt; | |
30
30
 
31
31
 
@@ -20,13 +20,13 @@ An object to provide metadata for `@inject`
20
20
  ```typescript
21
21
  export interface InjectionMetadata extends Omit<ResolutionOptions, 'session'>
22
22
  ```
23
- <b>Extends:</b> Omit&lt;[ResolutionOptions](./context.resolutionoptions.md)
23
+ <b>Extends:</b> Omit&lt;[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, 'session'&gt;
24
24
 
25
25
  ## Properties
26
26
 
27
- | Property | Type | Description |
28
- | --- | --- | --- |
29
- | [bindingComparator?](./context.injectionmetadata.bindingcomparator.md) | [BindingComparator](./context.bindingcomparator.md) | <i>(Optional)</i> Optional comparator for matched bindings |
30
- | [decorator?](./context.injectionmetadata.decorator.md) | string | <i>(Optional)</i> Name of the decorator function, such as <code>@inject</code> or <code>@inject.setter</code>. It's usually set by the decorator implementation. |
27
+ | Property | Modifiers | Type | Description |
28
+ | --- | --- | --- | --- |
29
+ | [bindingComparator?](./context.injectionmetadata.bindingcomparator.md) | | [BindingComparator](./context.bindingcomparator.md) | <i>(Optional)</i> Optional comparator for matched bindings |
30
+ | [decorator?](./context.injectionmetadata.decorator.md) | | string | <i>(Optional)</i> Name of the decorator function, such as <code>@inject</code> or <code>@inject.setter</code>. It's usually set by the decorator implementation. |
31
31
 
32
32
 
@@ -18,7 +18,7 @@ Decorator function `@intercept` for classes/methods to apply interceptors. It ca
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare function intercept(...interceptorOrKeys: InterceptorOrKey[]): (target: any, method?: string | undefined, methodDescriptor?: TypedPropertyDescriptor<any> | undefined) => any;
21
+ export declare function intercept(...interceptorOrKeys: InterceptorOrKey[]): (target: any, method?: string, methodDescriptor?: TypedPropertyDescriptor<any>) => any;
22
22
  ```
23
23
 
24
24
  ## Parameters
@@ -29,7 +29,7 @@ export declare function intercept(...interceptorOrKeys: InterceptorOrKey[]): (ta
29
29
 
30
30
  <b>Returns:</b>
31
31
 
32
- (target: any, method?: string \| undefined, methodDescriptor?: TypedPropertyDescriptor&lt;any&gt; \| undefined) =&gt; any
32
+ (target: any, method?: string, methodDescriptor?: TypedPropertyDescriptor&lt;any&gt;) =&gt; any
33
33
 
34
34
  ## Example
35
35
 
@@ -22,7 +22,7 @@ See https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global\_Objec
22
22
  ```typescript
23
23
  export declare class InterceptionHandler<T extends object> implements ProxyHandler<T>
24
24
  ```
25
- <b>Implements:</b> ProxyHandler
25
+ <b>Implements:</b> ProxyHandler&lt;T&gt;
26
26
 
27
27
  ## Constructors
28
28