@loopback/docs 5.1.1 → 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 (337) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/package.json +3 -3
  3. package/site/apidocs/authentication-jwt.myuserservice.md +1 -1
  4. package/site/apidocs/authentication-jwt.refreshtokenrepository.md +1 -1
  5. package/site/apidocs/authentication-jwt.usercredentialsrepository.md +1 -1
  6. package/site/apidocs/authentication-jwt.userrepository.md +3 -3
  7. package/site/apidocs/authentication-passport.strategyadapter.md +1 -1
  8. package/site/apidocs/authentication.authenticateactionprovider.md +5 -5
  9. package/site/apidocs/authentication.authenticationmetadata.md +5 -5
  10. package/site/apidocs/authentication.authenticationmiddlewareprovider.md +1 -1
  11. package/site/apidocs/authentication.authenticationoptions.md +4 -4
  12. package/site/apidocs/authentication.authenticationstrategy.md +3 -3
  13. package/site/apidocs/authentication.authenticationstrategyprovider.md +3 -3
  14. package/site/apidocs/authentication.authmetadataprovider.md +1 -1
  15. package/site/apidocs/authentication.md +3 -3
  16. package/site/apidocs/authorization.authorizationcontext.md +7 -7
  17. package/site/apidocs/authorization.authorizationinterceptor.md +1 -1
  18. package/site/apidocs/authorization.authorizationmetadata.md +8 -8
  19. package/site/apidocs/authorization.authorizationoptions.md +6 -6
  20. package/site/apidocs/authorization.authorizationrequest.md +6 -6
  21. package/site/apidocs/authorization.authorizemethoddecoratorfactory.md +2 -2
  22. package/site/apidocs/boot.baseartifactbooter.md +5 -5
  23. package/site/apidocs/boot.bootable.md +4 -4
  24. package/site/apidocs/boot.instancewithbooters.md +3 -3
  25. package/site/apidocs/boot.md +10 -10
  26. package/site/apidocs/context-explorer.contextbinding.md +4 -4
  27. package/site/apidocs/context-explorer.contextgraph.md +2 -2
  28. package/site/apidocs/context.binding.md +11 -11
  29. package/site/apidocs/context.bindingelement.md +4 -4
  30. package/site/apidocs/context.bindinginspectoptions.md +3 -3
  31. package/site/apidocs/context.bindingkey.md +4 -4
  32. package/site/apidocs/context.bindingscope.md +2 -2
  33. package/site/apidocs/context.bindingtagfilter.md +3 -3
  34. package/site/apidocs/context.configinjectionmetadata.md +4 -4
  35. package/site/apidocs/context.context.find.md +1 -1
  36. package/site/apidocs/context.context.md +15 -15
  37. package/site/apidocs/context.contextinspectoptions.md +3 -3
  38. package/site/apidocs/context.contextobserver.md +4 -4
  39. package/site/apidocs/context.contextsubscriptionmanager.md +5 -5
  40. package/site/apidocs/context.contextview.md +7 -7
  41. package/site/apidocs/context.contextviewevent.md +3 -3
  42. package/site/apidocs/context.defaultconfigurationresolver.md +1 -1
  43. package/site/apidocs/context.dynamicvalueproviderclass.md +3 -3
  44. package/site/apidocs/context.genericinterceptorchain.md +1 -1
  45. package/site/apidocs/context.inject.md +2 -2
  46. package/site/apidocs/context.injectable.md +1 -1
  47. package/site/apidocs/context.injectbindingmetadata.md +3 -3
  48. package/site/apidocs/context.injection.md +8 -8
  49. package/site/apidocs/context.injectiondescriptor.md +5 -5
  50. package/site/apidocs/context.injectionelement.md +4 -4
  51. package/site/apidocs/context.injectionmetadata.md +5 -5
  52. package/site/apidocs/context.interceptionhandler.md +1 -1
  53. package/site/apidocs/context.interceptor.md +1 -1
  54. package/site/apidocs/context.interceptorbindingoptions.md +5 -5
  55. package/site/apidocs/context.invocationcontext.md +7 -7
  56. package/site/apidocs/context.invocationsource.md +4 -4
  57. package/site/apidocs/context.jsonarray.md +1 -1
  58. package/site/apidocs/context.jsonobject.md +1 -1
  59. package/site/apidocs/context.md +9 -9
  60. package/site/apidocs/context.notification.md +3 -3
  61. package/site/apidocs/context.proxysource.md +2 -2
  62. package/site/apidocs/context.resolutioncontext.md +5 -5
  63. package/site/apidocs/context.resolutionerror.md +1 -1
  64. package/site/apidocs/context.resolutionoptions.md +5 -5
  65. package/site/apidocs/context.resolutionsession.md +5 -5
  66. package/site/apidocs/context.subscription.md +3 -3
  67. package/site/apidocs/core.application.md +13 -13
  68. package/site/apidocs/core.applicationconfig.md +4 -4
  69. package/site/apidocs/core.applicationmetadata.md +5 -5
  70. package/site/apidocs/core.component.md +9 -9
  71. package/site/apidocs/core.lifecycleobserverregistry.md +8 -8
  72. package/site/apidocs/core.server.md +3 -3
  73. package/site/apidocs/core.service.md +1 -1
  74. package/site/apidocs/core.serviceoptions.md +3 -3
  75. package/site/apidocs/cron.croncomponent.md +1 -1
  76. package/site/apidocs/cron.md +1 -1
  77. package/site/apidocs/express.basemiddlewarebindingoptions.md +4 -4
  78. package/site/apidocs/express.expressapplication.md +2 -2
  79. package/site/apidocs/express.expressmiddlewareinterceptorprovider.md +4 -4
  80. package/site/apidocs/express.expressserver.md +7 -7
  81. package/site/apidocs/express.handlercontext.md +4 -4
  82. package/site/apidocs/express.invokemiddlewareoptions.md +7 -7
  83. package/site/apidocs/express.middleware.md +1 -1
  84. package/site/apidocs/express.middlewarebindingoptions.md +6 -6
  85. package/site/apidocs/express.middlewarechain.md +1 -1
  86. package/site/apidocs/express.middlewarecontext.md +3 -3
  87. package/site/apidocs/express.middlewarecreationoptions.md +4 -4
  88. package/site/apidocs/express.middlewareinterceptorbindingoptions.md +4 -4
  89. package/site/apidocs/express.middlewareview.md +1 -1
  90. package/site/apidocs/filter.andclause.md +3 -3
  91. package/site/apidocs/filter.filter.md +9 -9
  92. package/site/apidocs/filter.inclusion.md +5 -5
  93. package/site/apidocs/filter.md +3 -3
  94. package/site/apidocs/filter.orclause.md +3 -3
  95. package/site/apidocs/graphql.graphqlresolutioncontext.md +2 -2
  96. package/site/apidocs/graphql.graphqlserver.md +3 -3
  97. package/site/apidocs/graphql.graphqlserveroptions.md +6 -6
  98. package/site/apidocs/graphql.loopbackcontainer.md +1 -1
  99. package/site/apidocs/http-caching-proxy.proxyoptions.md +7 -7
  100. package/site/apidocs/http-server.basehttpoptions.md +4 -4
  101. package/site/apidocs/http-server.httpoptions.md +3 -3
  102. package/site/apidocs/http-server.httpserver.md +8 -8
  103. package/site/apidocs/http-server.httpsoptions.md +3 -3
  104. package/site/apidocs/index.md +1 -1
  105. package/site/apidocs/logging.winstonloggerprovider.md +1 -1
  106. package/site/apidocs/metadata.classdecoratorfactory.md +3 -3
  107. package/site/apidocs/metadata.decoratorfactory.md +11 -11
  108. package/site/apidocs/metadata.decoratoroptions.md +5 -5
  109. package/site/apidocs/metadata.designtimemethodmetadata.md +5 -5
  110. package/site/apidocs/metadata.inspectionoptions.md +3 -3
  111. package/site/apidocs/metadata.metadataaccessor.md +1 -1
  112. package/site/apidocs/metadata.metadatainspector.md +2 -2
  113. package/site/apidocs/metadata.methoddecoratorfactory.md +3 -3
  114. package/site/apidocs/metadata.methodmultidecoratorfactory.md +3 -3
  115. package/site/apidocs/metadata.methodparameterdecoratorfactory.md +3 -3
  116. package/site/apidocs/metadata.parameterdecoratorfactory.md +3 -3
  117. package/site/apidocs/metadata.propertydecoratorfactory.md +3 -3
  118. package/site/apidocs/metrics.metricsoptions.md +7 -7
  119. package/site/apidocs/mock-oauth2-provider.myuser.md +10 -10
  120. package/site/apidocs/model-api-builder.modelapibuilder.md +3 -3
  121. package/site/apidocs/openapi-spec-builder.builderbase.md +1 -1
  122. package/site/apidocs/openapi-spec-builder.componentsspecbuilder.md +1 -1
  123. package/site/apidocs/openapi-spec-builder.openapispecbuilder.md +1 -1
  124. package/site/apidocs/openapi-spec-builder.operationspecbuilder.md +1 -1
  125. package/site/apidocs/openapi-v3.controllerspec.md +5 -5
  126. package/site/apidocs/openapi-v3.md +9 -9
  127. package/site/apidocs/openapi-v3.oasenhancer.md +3 -3
  128. package/site/apidocs/openapi-v3.oasenhancerservice.md +1 -1
  129. package/site/apidocs/openapi-v3.requestbody.md +1 -1
  130. package/site/apidocs/openapi-v3.responsedecoratormetadataitem.md +6 -6
  131. package/site/apidocs/openapi-v3.restendpoint.md +5 -5
  132. package/site/apidocs/openapi-v3.tagsdecoratormetadata.md +3 -3
  133. package/site/apidocs/pooling.pooledvalue.md +4 -4
  134. package/site/apidocs/pooling.poolfactory.md +1 -1
  135. package/site/apidocs/pooling.poolingservice.md +2 -2
  136. package/site/apidocs/pooling.poolingserviceoptions.md +4 -4
  137. package/site/apidocs/repository-json-schema.filterschemaoptions.md +4 -4
  138. package/site/apidocs/repository-json-schema.jsonschemaoptions.md +7 -7
  139. package/site/apidocs/repository-json-schema.md +3 -3
  140. package/site/apidocs/repository-tests.crudfeatures.md +8 -8
  141. package/site/apidocs/repository.anytype.md +2 -2
  142. package/site/apidocs/repository.arraytype.md +2 -2
  143. package/site/apidocs/repository.baserepositoryclass.md +3 -3
  144. package/site/apidocs/repository.belongstoaccessor.md +3 -3
  145. package/site/apidocs/repository.belongstodefinition.md +7 -7
  146. package/site/apidocs/repository.booleantype.md +2 -2
  147. package/site/apidocs/repository.buffertype.md +2 -2
  148. package/site/apidocs/repository.connector.md +5 -5
  149. package/site/apidocs/repository.count.md +3 -3
  150. package/site/apidocs/repository.crudrepository.md +1 -1
  151. package/site/apidocs/repository.crudrepositoryimpl.md +2 -2
  152. package/site/apidocs/repository.datasource.md +5 -5
  153. package/site/apidocs/repository.datetype.md +2 -2
  154. package/site/apidocs/repository.defaultbelongstorepository.md +1 -1
  155. package/site/apidocs/repository.defaultcrudrepository.md +21 -21
  156. package/site/apidocs/repository.defaulthasmanyrepository.md +1 -1
  157. package/site/apidocs/repository.defaulthasmanythroughrepository.md +1 -1
  158. package/site/apidocs/repository.defaulthasonerepository.md +1 -1
  159. package/site/apidocs/repository.defaultkeyvaluerepository.md +2 -2
  160. package/site/apidocs/repository.defaultreferencesmanyrepository.md +1 -1
  161. package/site/apidocs/repository.defaulttransactionalrepository.md +2 -2
  162. package/site/apidocs/repository.entitycrudrepository.md +5 -5
  163. package/site/apidocs/repository.entityrepository.md +1 -1
  164. package/site/apidocs/repository.executablerepository.md +1 -1
  165. package/site/apidocs/repository.hasmanydefinition.md +7 -7
  166. package/site/apidocs/repository.hasmanyrepositoryfactory.md +3 -3
  167. package/site/apidocs/repository.hasonedefinition.md +7 -7
  168. package/site/apidocs/repository.hasonerepositoryfactory.md +3 -3
  169. package/site/apidocs/repository.keyvaluerepository.md +1 -1
  170. package/site/apidocs/repository.md +14 -14
  171. package/site/apidocs/repository.modeldefinition.md +1 -1
  172. package/site/apidocs/repository.modeldefinitionsyntax.md +7 -7
  173. package/site/apidocs/repository.modelrepositoryclass.md +3 -3
  174. package/site/apidocs/repository.modelsettings.md +7 -7
  175. package/site/apidocs/repository.modeltype.md +2 -2
  176. package/site/apidocs/repository.nulltype.md +2 -2
  177. package/site/apidocs/repository.numbertype.md +2 -2
  178. package/site/apidocs/repository.objecttype.md +1 -1
  179. package/site/apidocs/repository.propertydefinition.md +9 -9
  180. package/site/apidocs/repository.propertyform.md +5 -5
  181. package/site/apidocs/repository.referencesmanyaccessor.md +3 -3
  182. package/site/apidocs/repository.referencesmanydefinition.md +6 -6
  183. package/site/apidocs/repository.relationdefinitionbase.md +7 -7
  184. package/site/apidocs/repository.repositorycomponent.md +4 -4
  185. package/site/apidocs/repository.repositorymetadata._constructor_.md +1 -1
  186. package/site/apidocs/repository.repositorymixindoc.md +1 -1
  187. package/site/apidocs/repository.schemamigrationoptions.md +4 -4
  188. package/site/apidocs/repository.stringtype.md +2 -2
  189. package/site/apidocs/repository.transaction.md +3 -3
  190. package/site/apidocs/repository.transactionalrepository.md +1 -1
  191. package/site/apidocs/repository.type.md +3 -3
  192. package/site/apidocs/repository.uniontype.md +2 -2
  193. package/site/apidocs/rest-crud.crudrestapibuilder.md +1 -1
  194. package/site/apidocs/rest-crud.crudrestcontroller.md +3 -3
  195. package/site/apidocs/rest-crud.crudrestcontrolleroptions.md +4 -4
  196. package/site/apidocs/rest-crud.modelcrudrestapiconfig.md +4 -4
  197. package/site/apidocs/rest-explorer.restexplorerbindings.md +1 -1
  198. package/site/apidocs/rest.apiexploreroptions.md +5 -5
  199. package/site/apidocs/rest.baseroute.md +3 -3
  200. package/site/apidocs/rest.bodyparser.md +3 -3
  201. package/site/apidocs/rest.controllerroute.md +4 -4
  202. package/site/apidocs/rest.defaultsequence.md +5 -5
  203. package/site/apidocs/rest.findroutemiddlewareprovider.md +1 -1
  204. package/site/apidocs/rest.httphandler.md +5 -5
  205. package/site/apidocs/rest.httpserverlike.md +3 -3
  206. package/site/apidocs/rest.infospecenhancer.md +1 -1
  207. package/site/apidocs/rest.invokemethodmiddlewareprovider.md +1 -1
  208. package/site/apidocs/rest.md +1 -1
  209. package/site/apidocs/rest.middlewaresequence.md +3 -3
  210. package/site/apidocs/rest.node.md +7 -7
  211. package/site/apidocs/rest.openapispecform.md +4 -4
  212. package/site/apidocs/rest.openapispecoptions.md +7 -7
  213. package/site/apidocs/rest.parseparamsmiddlewareprovider.md +1 -1
  214. package/site/apidocs/rest.redirectroute.md +8 -8
  215. package/site/apidocs/rest.regexprouter.md +3 -3
  216. package/site/apidocs/rest.requestbodyparser.md +1 -1
  217. package/site/apidocs/rest.requestbodyparseroptions.md +7 -7
  218. package/site/apidocs/rest.requestcontext.md +7 -7
  219. package/site/apidocs/rest.requestwithsession.md +3 -3
  220. package/site/apidocs/rest.resolvednode.md +4 -4
  221. package/site/apidocs/rest.resolvedroute.md +4 -4
  222. package/site/apidocs/rest.restapplication.md +3 -3
  223. package/site/apidocs/rest.restbindings.md +1 -1
  224. package/site/apidocs/rest.resthttperrors.validationerrordetails.md +6 -6
  225. package/site/apidocs/rest.restserver.md +22 -22
  226. package/site/apidocs/rest.restserverresolvedoptions.md +13 -13
  227. package/site/apidocs/rest.route.md +2 -2
  228. package/site/apidocs/rest.routeentry.md +5 -5
  229. package/site/apidocs/rest.routesource.md +2 -2
  230. package/site/apidocs/rest.sendresponsemiddlewareprovider.md +1 -1
  231. package/site/apidocs/rest.session.md +3 -3
  232. package/site/apidocs/rest.sessionuserprofile.md +5 -5
  233. package/site/apidocs/rest.trie.md +1 -1
  234. package/site/apidocs/rest.trierouter.md +3 -3
  235. package/site/apidocs/rest.validationoptions.md +8 -8
  236. package/site/apidocs/rest.valuevalidationoptions.md +4 -4
  237. package/site/apidocs/security.defaultsubject.md +4 -4
  238. package/site/apidocs/security.md +2 -2
  239. package/site/apidocs/security.permission.md +1 -1
  240. package/site/apidocs/security.principal.md +3 -3
  241. package/site/apidocs/security.role.md +3 -3
  242. package/site/apidocs/security.scope.md +3 -3
  243. package/site/apidocs/security.subject.md +5 -5
  244. package/site/apidocs/security.typedprincipal.md +3 -3
  245. package/site/apidocs/security.userprofile.md +4 -4
  246. package/site/apidocs/service-proxy.md +1 -1
  247. package/site/apidocs/socketio.defaultsocketiosequence.md +5 -5
  248. package/site/apidocs/socketio.httpserverresolvedoptions.md +7 -7
  249. package/site/apidocs/socketio.socketio.md +1 -1
  250. package/site/apidocs/socketio.socketioapplication.md +1 -1
  251. package/site/apidocs/socketio.socketiobooter.md +1 -1
  252. package/site/apidocs/socketio.socketioconnectioncontext.md +1 -1
  253. package/site/apidocs/socketio.socketiocontrollerfactory.md +4 -4
  254. package/site/apidocs/socketio.socketioinvokemethodprovider.md +1 -1
  255. package/site/apidocs/socketio.socketiometadata.md +4 -4
  256. package/site/apidocs/socketio.socketiorejectprovider.md +1 -1
  257. package/site/apidocs/socketio.socketiosendprovider.md +1 -1
  258. package/site/apidocs/socketio.socketioserver.md +4 -4
  259. package/site/apidocs/socketio.socketioserveroptions.md +4 -4
  260. package/site/apidocs/testlab.expresscontextstub.md +6 -6
  261. package/site/apidocs/testlab.handlercontextstub.md +5 -5
  262. package/site/apidocs/testlab.hostport.md +4 -4
  263. package/site/apidocs/testlab.httpoptions.md +3 -3
  264. package/site/apidocs/testlab.httpsoptions.md +3 -3
  265. package/site/apidocs/testlab.md +1 -1
  266. package/site/apidocs/testlab.restapplicationlike.md +3 -3
  267. package/site/apidocs/testlab.restserverlike.md +4 -4
  268. package/site/apidocs/testlab.testsandbox.md +1 -1
  269. package/site/apidocs/testlab.testsandboxoptions.md +3 -3
  270. package/site/apidocs/tsdocs.apidocsoptions.md +9 -9
  271. package/site/apidocs/tsdocs.extractoroptions.md +8 -8
  272. package/site/apidocs/tsdocs.lernapackage.md +7 -7
  273. package/site/apidocs/typeorm.md +1 -1
  274. package/site/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +8 -0
  275. package/site/changelogs/examples/access-control-migration/CHANGELOG.md +8 -0
  276. package/site/changelogs/examples/binding-resolution/CHANGELOG.md +8 -0
  277. package/site/changelogs/examples/context/CHANGELOG.md +8 -0
  278. package/site/changelogs/examples/express-composition/CHANGELOG.md +8 -0
  279. package/site/changelogs/examples/file-transfer/CHANGELOG.md +8 -0
  280. package/site/changelogs/examples/graphql/CHANGELOG.md +8 -0
  281. package/site/changelogs/examples/greeter-extension/CHANGELOG.md +8 -0
  282. package/site/changelogs/examples/greeting-app/CHANGELOG.md +8 -0
  283. package/site/changelogs/examples/hello-world/CHANGELOG.md +8 -0
  284. package/site/changelogs/examples/lb3-application/CHANGELOG.md +11 -0
  285. package/site/changelogs/examples/log-extension/CHANGELOG.md +11 -0
  286. package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +8 -0
  287. package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +11 -0
  288. package/site/changelogs/examples/passport-login/CHANGELOG.md +8 -0
  289. package/site/changelogs/examples/references-many/CHANGELOG.md +8 -0
  290. package/site/changelogs/examples/rest-crud/CHANGELOG.md +11 -0
  291. package/site/changelogs/examples/rpc-server/CHANGELOG.md +8 -0
  292. package/site/changelogs/examples/soap-calculator/CHANGELOG.md +8 -0
  293. package/site/changelogs/examples/socketio/CHANGELOG.md +8 -0
  294. package/site/changelogs/examples/todo/CHANGELOG.md +8 -0
  295. package/site/changelogs/examples/todo-jwt/CHANGELOG.md +11 -0
  296. package/site/changelogs/examples/todo-list/CHANGELOG.md +8 -0
  297. package/site/changelogs/examples/validation-app/CHANGELOG.md +8 -0
  298. package/site/changelogs/examples/webpack/CHANGELOG.md +8 -0
  299. package/site/changelogs/extensions/apiconnect/CHANGELOG.md +8 -0
  300. package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +8 -0
  301. package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +8 -0
  302. package/site/changelogs/extensions/context-explorer/CHANGELOG.md +8 -0
  303. package/site/changelogs/extensions/cron/CHANGELOG.md +8 -0
  304. package/site/changelogs/extensions/graphql/CHANGELOG.md +8 -0
  305. package/site/changelogs/extensions/health/CHANGELOG.md +8 -0
  306. package/site/changelogs/extensions/logging/CHANGELOG.md +8 -0
  307. package/site/changelogs/extensions/metrics/CHANGELOG.md +8 -0
  308. package/site/changelogs/extensions/pooling/CHANGELOG.md +8 -0
  309. package/site/changelogs/extensions/socketio/CHANGELOG.md +8 -0
  310. package/site/changelogs/extensions/typeorm/CHANGELOG.md +8 -0
  311. package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +8 -0
  312. package/site/changelogs/packages/authentication/CHANGELOG.md +8 -0
  313. package/site/changelogs/packages/authorization/CHANGELOG.md +8 -0
  314. package/site/changelogs/packages/boot/CHANGELOG.md +11 -0
  315. package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +8 -0
  316. package/site/changelogs/packages/build/CHANGELOG.md +8 -0
  317. package/site/changelogs/packages/cli/CHANGELOG.md +24 -0
  318. package/site/changelogs/packages/context/CHANGELOG.md +8 -0
  319. package/site/changelogs/packages/core/CHANGELOG.md +11 -0
  320. package/site/changelogs/packages/eslint-config/CHANGELOG.md +8 -0
  321. package/site/changelogs/packages/express/CHANGELOG.md +8 -0
  322. package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +8 -0
  323. package/site/changelogs/packages/http-server/CHANGELOG.md +8 -0
  324. package/site/changelogs/packages/metadata/CHANGELOG.md +8 -0
  325. package/site/changelogs/packages/model-api-builder/CHANGELOG.md +8 -0
  326. package/site/changelogs/packages/monorepo/CHANGELOG.md +8 -0
  327. package/site/changelogs/packages/openapi-v3/CHANGELOG.md +8 -0
  328. package/site/changelogs/packages/repository/CHANGELOG.md +12 -0
  329. package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +8 -0
  330. package/site/changelogs/packages/repository-tests/CHANGELOG.md +8 -0
  331. package/site/changelogs/packages/rest/CHANGELOG.md +8 -0
  332. package/site/changelogs/packages/rest-crud/CHANGELOG.md +11 -0
  333. package/site/changelogs/packages/rest-explorer/CHANGELOG.md +8 -0
  334. package/site/changelogs/packages/security/CHANGELOG.md +8 -0
  335. package/site/changelogs/packages/service-proxy/CHANGELOG.md +8 -0
  336. package/site/changelogs/packages/testlab/CHANGELOG.md +8 -0
  337. package/site/changelogs/packages/tsdocs/CHANGELOG.md +8 -0
@@ -25,7 +25,7 @@ Functions for more artifacts will be added when needed.
25
25
 
26
26
  | Class | Description |
27
27
  | --- | --- |
28
- | [OASEnhancerService](./openapi-v3.oasenhancerservice.md) | An extension point for OpenAPI Spec enhancement This service is used for enhancing an OpenAPI spec by loading and applying one or more registered enhancers.<!-- -->A typical use of it would be generating the OpenAPI spec for the endpoints on a server in the <code>@loopback/rest</code> module. |
28
+ | [OASEnhancerService](./openapi-v3.oasenhancerservice.md) | <p>An extension point for OpenAPI Spec enhancement This service is used for enhancing an OpenAPI spec by loading and applying one or more registered enhancers.</p><p>A typical use of it would be generating the OpenAPI spec for the endpoints on a server in the <code>@loopback/rest</code> module.</p> |
29
29
 
30
30
  ## Enumerations
31
31
 
@@ -37,28 +37,28 @@ Functions for more artifacts will be added when needed.
37
37
 
38
38
  | Function | Description |
39
39
  | --- | --- |
40
- | [api(spec)](./openapi-v3.api.md) | Decorate the given Controller constructor with metadata describing the HTTP/REST API the Controller implements/provides.<code>@api</code> can be applied to controller classes. |
40
+ | [api(spec)](./openapi-v3.api.md) | <p>Decorate the given Controller constructor with metadata describing the HTTP/REST API the Controller implements/provides.</p><p><code>@api</code> can be applied to controller classes.</p> |
41
41
  | [createEmptyApiSpec()](./openapi-v3.createemptyapispec.md) | Create an empty OpenApiSpec object that's still a valid openapi document. |
42
42
  | [del(path, spec)](./openapi-v3.del.md) | Expose a Controller method as a REST API operation mapped to <code>DELETE</code> request method. |
43
- | [deprecated(isDeprecated)](./openapi-v3.deprecated.md) | Marks an api path as deprecated. When applied to a class, this decorator marks all paths as deprecated.<!-- -->You can optionally mark all controllers in a class as deprecated, but use <code>@deprecated(false)</code> on a specific method to ensure it is not marked as deprecated in the specification. |
43
+ | [deprecated(isDeprecated)](./openapi-v3.deprecated.md) | <p>Marks an api path as deprecated. When applied to a class, this decorator marks all paths as deprecated.</p><p>You can optionally mark all controllers in a class as deprecated, but use <code>@deprecated(false)</code> on a specific method to ensure it is not marked as deprecated in the specification.</p> |
44
44
  | [get(path, spec)](./openapi-v3.get.md) | Expose a Controller method as a REST API operation mapped to <code>GET</code> request method. |
45
45
  | [getControllerSpec(constructor)](./openapi-v3.getcontrollerspec.md) | Get the controller spec for the given class |
46
- | [getFilterSchemaFor(modelCtor, options)](./openapi-v3.getfilterschemafor.md) | Build an OpenAPI schema describing the format of the "filter" object used to query model instances.<!-- -->Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition. |
46
+ | [getFilterSchemaFor(modelCtor, options)](./openapi-v3.getfilterschemafor.md) | <p>Build an OpenAPI schema describing the format of the "filter" object used to query model instances.</p><p>Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition.</p> |
47
47
  | [getModelSchemaRef(modelCtor, options)](./openapi-v3.getmodelschemaref.md) | Describe the provided Model as a reference to a definition shared by multiple endpoints. The definition is included in the returned schema. |
48
- | [getWhereSchemaFor(modelCtor)](./openapi-v3.getwhereschemafor.md) | Build a OpenAPI schema describing the format of the "where" object used to filter model instances to query, update or delete.<!-- -->Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition. |
48
+ | [getWhereSchemaFor(modelCtor)](./openapi-v3.getwhereschemafor.md) | <p>Build a OpenAPI schema describing the format of the "where" object used to filter model instances to query, update or delete.</p><p>Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition.</p> |
49
49
  | [jsonOrBooleanToJSON(jsonOrBool)](./openapi-v3.jsonorbooleantojson.md) | Helper function used to interpret boolean values as JSON Schemas. See http://json-schema.org/draft-06/json-schema-release-notes.html |
50
50
  | [jsonToSchemaObject(json, visited)](./openapi-v3.jsontoschemaobject.md) | Converts JSON Schemas into a SchemaObject |
51
- | [mergeOpenAPISpec(currentSpec, patchSpec)](./openapi-v3.mergeopenapispec.md) | The default merge function to patch the current OpenAPI spec. It leverages module <code>json-merge-patch</code>'s merge API to merge two json objects. It returns a new merged object without modifying the original one.<!-- -->A list of merging rules can be found in test file: https://github.com/pierreinglebert/json-merge-patch/blob/master/test/lib/merge.js |
51
+ | [mergeOpenAPISpec(currentSpec, patchSpec)](./openapi-v3.mergeopenapispec.md) | <p>The default merge function to patch the current OpenAPI spec. It leverages module <code>json-merge-patch</code>'s merge API to merge two json objects. It returns a new merged object without modifying the original one.</p><p>A list of merging rules can be found in test file: https://github.com/pierreinglebert/json-merge-patch/blob/master/test/lib/merge.js</p> |
52
52
  | [mergeSecuritySchemeToSpec(spec, schemeName, schemeSpec)](./openapi-v3.mergesecurityschemetospec.md) | Security scheme merge helper function to patch the current OpenAPI spec. It provides a direct route to add a security schema to the specs components. It returns a new merged object without modifying the original one. |
53
53
  | [operation(verb, path, spec)](./openapi-v3.operation.md) | Expose a Controller method as a REST API operation. |
54
- | [param(paramSpec)](./openapi-v3.param.md) | Describe an input parameter of a Controller method.<code>@param</code> must be applied to parameters. |
54
+ | [param(paramSpec)](./openapi-v3.param.md) | <p>Describe an input parameter of a Controller method.</p><p><code>@param</code> must be applied to parameters.</p> |
55
55
  | [patch(path, spec)](./openapi-v3.patch.md) | Expose a Controller method as a REST API operation mapped to <code>PATCH</code> request method. |
56
56
  | [post(path, spec)](./openapi-v3.post.md) | Expose a Controller method as a REST API operation mapped to <code>POST</code> request method. |
57
57
  | [put(path, spec)](./openapi-v3.put.md) | Expose a Controller method as a REST API operation mapped to <code>PUT</code> request method. |
58
- | [requestBody(requestBodySpec)](./openapi-v3.requestbody.md) | Describe the request body of a Controller method parameter.<!-- -->A typical OpenAPI requestBody spec contains property: - <code>description</code> - <code>required</code> - <code>content</code>. |
58
+ | [requestBody(requestBodySpec)](./openapi-v3.requestbody.md) | <p>Describe the request body of a Controller method parameter.</p><p>A typical OpenAPI requestBody spec contains property: - <code>description</code> - <code>required</code> - <code>content</code>.</p> |
59
59
  | [response(responseCode, responseModelOrSpec)](./openapi-v3.response.md) | Add response object to a path spec. |
60
60
  | [tags(tagNames)](./openapi-v3.tags.md) | Add tags for an endpoint. When applied to a class, this decorator adds the tags to all endpoints. |
61
- | [visibility(visibilityType)](./openapi-v3.visibility.md) | Marks an api path with the specfied visibility. When applied to a class, this decorator marks all paths with the specified visibility.<!-- -->You can optionally mark all controllers in a class with <code>@visibility('undocumented')</code>, but use <code>@visibility('documented')</code> on a specific method to ensure it is not marked as <code>undocumented</code>. |
61
+ | [visibility(visibilityType)](./openapi-v3.visibility.md) | <p>Marks an api path with the specfied visibility. When applied to a class, this decorator marks all paths with the specified visibility.</p><p>You can optionally mark all controllers in a class with <code>@visibility('undocumented')</code>, but use <code>@visibility('documented')</code> on a specific method to ensure it is not marked as <code>undocumented</code>.</p> |
62
62
 
63
63
  ## Interfaces
64
64
 
@@ -23,9 +23,9 @@ export interface OASEnhancer
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | --- | --- | --- |
28
- | [name](./openapi-v3.oasenhancer.name.md) | string | |
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [name](./openapi-v3.oasenhancer.name.md) | | string | |
29
29
 
30
30
  ## Methods
31
31
 
@@ -33,7 +33,7 @@ export declare class OASEnhancerService
33
33
 
34
34
  | Property | Modifiers | Type | Description |
35
35
  | --- | --- | --- | --- |
36
- | [options?](./openapi-v3.oasenhancerservice.options.md) | | [OASEnhancerServiceOptions](./openapi-v3.oasenhancerserviceoptions.md) \| undefined | <i>(Optional)</i> An extension point should be able to receive its options via dependency injection. |
36
+ | [options?](./openapi-v3.oasenhancerservice.options.md) | <code>readonly</code> | [OASEnhancerServiceOptions](./openapi-v3.oasenhancerserviceoptions.md) \| undefined | <i>(Optional)</i> An extension point should be able to receive its options via dependency injection. |
37
37
  | [spec](./openapi-v3.oasenhancerservice.spec.md) | | [OpenApiSpec](./openapi-v3.openapispec.md) | Getter for <code>_spec</code> |
38
38
 
39
39
  ## Methods
@@ -24,6 +24,6 @@ export declare namespace requestBody
24
24
  | Variable | Description |
25
25
  | --- | --- |
26
26
  | [array](./openapi-v3.requestbody.array.md) | Define a requestBody of <code>array</code> type. |
27
- | [file](./openapi-v3.requestbody.file.md) | Define a requestBody of <code>file</code> type. This is used to support multipart/form-data based file upload. Use <code>@requestBody</code> for other content types.[OpenAPI file upload](https://swagger.io/docs/specification/describing-request-body/file-upload) |
27
+ | [file](./openapi-v3.requestbody.file.md) | <p>Define a requestBody of <code>file</code> type. This is used to support multipart/form-data based file upload. Use <code>@requestBody</code> for other content types.</p><p>[OpenAPI file upload](https://swagger.io/docs/specification/describing-request-body/file-upload)</p> |
28
28
 
29
29
 
@@ -21,11 +21,11 @@ export interface ResponseDecoratorMetadataItem
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Type | Description |
25
- | --- | --- | --- |
26
- | [contentType](./openapi-v3.responsedecoratormetadataitem.contenttype.md) | string | |
27
- | [description](./openapi-v3.responsedecoratormetadataitem.description.md) | string | |
28
- | [responseCode](./openapi-v3.responsedecoratormetadataitem.responsecode.md) | number | |
29
- | [responseModelOrSpec](./openapi-v3.responsedecoratormetadataitem.responsemodelorspec.md) | [ResponseModelOrSpec](./openapi-v3.responsemodelorspec.md) | |
24
+ | Property | Modifiers | Type | Description |
25
+ | --- | --- | --- | --- |
26
+ | [contentType](./openapi-v3.responsedecoratormetadataitem.contenttype.md) | | string | |
27
+ | [description](./openapi-v3.responsedecoratormetadataitem.description.md) | | string | |
28
+ | [responseCode](./openapi-v3.responsedecoratormetadataitem.responsecode.md) | | number | |
29
+ | [responseModelOrSpec](./openapi-v3.responsedecoratormetadataitem.responsemodelorspec.md) | | [ResponseModelOrSpec](./openapi-v3.responsemodelorspec.md) | |
30
30
 
31
31
 
@@ -23,10 +23,10 @@ export interface RestEndpoint
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | --- | --- | --- |
28
- | [path](./openapi-v3.restendpoint.path.md) | string | |
29
- | [spec?](./openapi-v3.restendpoint.spec.md) | OperationObject | <i>(Optional)</i> |
30
- | [verb](./openapi-v3.restendpoint.verb.md) | string | |
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [path](./openapi-v3.restendpoint.path.md) | | string | |
29
+ | [spec?](./openapi-v3.restendpoint.spec.md) | | OperationObject | <i>(Optional)</i> |
30
+ | [verb](./openapi-v3.restendpoint.verb.md) | | string | |
31
31
 
32
32
 
@@ -21,8 +21,8 @@ export interface TagsDecoratorMetadata
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Type | Description |
25
- | --- | --- | --- |
26
- | [tags](./openapi-v3.tagsdecoratormetadata.tags.md) | string\[\] | |
24
+ | Property | Modifiers | Type | Description |
25
+ | --- | --- | --- | --- |
26
+ | [tags](./openapi-v3.tagsdecoratormetadata.tags.md) | | string\[\] | |
27
27
 
28
28
 
@@ -23,10 +23,10 @@ export interface PooledValue<T>
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | --- | --- | --- |
28
- | [pool](./pooling.pooledvalue.pool.md) | Pool&lt;T&gt; | The resource pool |
29
- | [value](./pooling.pooledvalue.value.md) | T | Acquired value from the pool |
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [pool](./pooling.pooledvalue.pool.md) | | Pool&lt;T&gt; | The resource pool |
29
+ | [value](./pooling.pooledvalue.value.md) | | T | Acquired value from the pool |
30
30
 
31
31
  ## Methods
32
32
 
@@ -20,7 +20,7 @@ Factory for the pooling service
20
20
  ```typescript
21
21
  export interface PoolFactory<T> extends Factory<T>
22
22
  ```
23
- <b>Extends:</b> Factory
23
+ <b>Extends:</b> Factory&lt;T&gt;
24
24
 
25
25
  ## Methods
26
26
 
@@ -38,8 +38,8 @@ The pool service observes life cycle events to start and stop.
38
38
 
39
39
  | Property | Modifiers | Type | Description |
40
40
  | --- | --- | --- | --- |
41
- | [context](./pooling.poolingservice.context.md) | | [Context](./context.context.md) | |
42
- | [pool](./pooling.poolingservice.pool.md) | | Pool&lt;T&gt; | The resource pool |
41
+ | [context](./pooling.poolingservice.context.md) | <code>readonly</code> | [Context](./context.context.md) | |
42
+ | [pool](./pooling.poolingservice.pool.md) | <code>readonly</code> | Pool&lt;T&gt; | The resource pool |
43
43
 
44
44
  ## Methods
45
45
 
@@ -23,9 +23,9 @@ export interface PoolingServiceOptions<T>
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | --- | --- | --- |
28
- | [factory](./pooling.poolingserviceoptions.factory.md) | [PoolFactory](./pooling.poolfactory.md)<!-- -->&lt;T&gt; \| ((ctx: [Context](./context.context.md)<!-- -->) =&gt; [PoolFactory](./pooling.poolfactory.md)<!-- -->&lt;T&gt;) | A factory to create/destroy/validate resources for the pool or a function to create a factory for the given context |
29
- | [poolOptions?](./pooling.poolingserviceoptions.pooloptions.md) | Options | <i>(Optional)</i> Options for the generic pool |
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [factory](./pooling.poolingserviceoptions.factory.md) | | [PoolFactory](./pooling.poolfactory.md)<!-- -->&lt;T&gt; \| ((ctx: [Context](./context.context.md)<!-- -->) =&gt; [PoolFactory](./pooling.poolfactory.md)<!-- -->&lt;T&gt;) | A factory to create/destroy/validate resources for the pool or a function to create a factory for the given context |
29
+ | [poolOptions?](./pooling.poolingserviceoptions.pooloptions.md) | | Options | <i>(Optional)</i> Options for the generic pool |
30
30
 
31
31
 
@@ -21,9 +21,9 @@ export interface FilterSchemaOptions
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Type | Description |
25
- | --- | --- | --- |
26
- | [exclude?](./repository-json-schema.filterschemaoptions.exclude.md) | string\[\] \| string | <i>(Optional)</i> To exclude one or more property from <code>filter</code> |
27
- | [setTitle?](./repository-json-schema.filterschemaoptions.settitle.md) | boolean | <i>(Optional)</i> Set this flag if you want the schema to set generated title property.<!-- -->By default the setting is enabled. (e.g. {<!-- -->setTitle: true<!-- -->}<!-- -->) |
24
+ | Property | Modifiers | Type | Description |
25
+ | --- | --- | --- | --- |
26
+ | [exclude?](./repository-json-schema.filterschemaoptions.exclude.md) | | string\[\] \| string | <i>(Optional)</i> To exclude one or more property from <code>filter</code> |
27
+ | [setTitle?](./repository-json-schema.filterschemaoptions.settitle.md) | | boolean | <p><i>(Optional)</i> Set this flag if you want the schema to set generated title property.</p><p>By default the setting is enabled. (e.g. {<!-- -->setTitle: true<!-- -->}<!-- -->)</p> |
28
28
 
29
29
 
@@ -21,12 +21,12 @@ export interface JsonSchemaOptions<T extends object>
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Type | Description |
25
- | --- | --- | --- |
26
- | [exclude?](./repository-json-schema.jsonschemaoptions.exclude.md) | (keyof T)\[\] | <i>(Optional)</i> List of model properties to exclude from the schema. |
27
- | [includeRelations?](./repository-json-schema.jsonschemaoptions.includerelations.md) | boolean | <i>(Optional)</i> Set this flag if you want the schema to define navigational properties for model relations. |
28
- | [optional?](./repository-json-schema.jsonschemaoptions.optional.md) | (keyof T)\[\] | <i>(Optional)</i> List of model properties to mark as optional. Overrides the "partial" option if it is not empty. |
29
- | [partial?](./repository-json-schema.jsonschemaoptions.partial.md) | boolean \| 'deep' | <i>(Optional)</i> Set this flag to mark all model properties as optional. This is typically used to describe request body of PATCH endpoints. This option will be overridden by the "optional" option if it is set and non-empty.<!-- -->The flag also applies to nested model instances if its value is set to 'deep', such as: |
30
- | [title?](./repository-json-schema.jsonschemaoptions.title.md) | string | <i>(Optional)</i> The title to use in the generated schema.<!-- -->When using options like <code>exclude</code>, the auto-generated title can be difficult to read for humans. Use this option to change the title to a more meaningful value. |
24
+ | Property | Modifiers | Type | Description |
25
+ | --- | --- | --- | --- |
26
+ | [exclude?](./repository-json-schema.jsonschemaoptions.exclude.md) | | (keyof T)\[\] | <i>(Optional)</i> List of model properties to exclude from the schema. |
27
+ | [includeRelations?](./repository-json-schema.jsonschemaoptions.includerelations.md) | | boolean | <i>(Optional)</i> Set this flag if you want the schema to define navigational properties for model relations. |
28
+ | [optional?](./repository-json-schema.jsonschemaoptions.optional.md) | | (keyof T)\[\] | <i>(Optional)</i> List of model properties to mark as optional. Overrides the "partial" option if it is not empty. |
29
+ | [partial?](./repository-json-schema.jsonschemaoptions.partial.md) | | boolean \| 'deep' | <p><i>(Optional)</i> Set this flag to mark all model properties as optional. This is typically used to describe request body of PATCH endpoints. This option will be overridden by the "optional" option if it is set and non-empty.</p><p>The flag also applies to nested model instances if its value is set to 'deep', such as:</p> |
30
+ | [title?](./repository-json-schema.jsonschemaoptions.title.md) | | string | <p><i>(Optional)</i> The title to use in the generated schema.</p><p>When using options like <code>exclude</code>, the auto-generated title can be difficult to read for humans. Use this option to change the title to a more meaningful value.</p> |
31
31
 
32
32
 
@@ -24,12 +24,12 @@ Modules to easily convert LoopBack4 models that have been decorated with `@model
24
24
  | Function | Description |
25
25
  | --- | --- |
26
26
  | [getFieldsJsonSchemaFor(modelCtor, options)](./repository-json-schema.getfieldsjsonschemafor.md) | Build a JSON schema describing the format of the "fields" object used to include or exclude properties of model instances. |
27
- | [getFilterJsonSchemaFor(modelCtor, options)](./repository-json-schema.getfilterjsonschemafor.md) | Build a JSON schema describing the format of the "filter" object used to query model instances.<!-- -->Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition. |
27
+ | [getFilterJsonSchemaFor(modelCtor, options)](./repository-json-schema.getfilterjsonschemafor.md) | <p>Build a JSON schema describing the format of the "filter" object used to query model instances.</p><p>Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition.</p> |
28
28
  | [getJsonSchema(ctor, options)](./repository-json-schema.getjsonschema.md) | Gets the JSON Schema of a TypeScript model/class by seeing if one exists in a cache. If not, one is generated and then cached. |
29
29
  | [getJsonSchemaRef(modelCtor, options)](./repository-json-schema.getjsonschemaref.md) | Describe the provided Model as a reference to a definition shared by multiple endpoints. The definition is included in the returned schema. |
30
30
  | [getNavigationalPropertyForRelation(relMeta, targetRef)](./repository-json-schema.getnavigationalpropertyforrelation.md) | Checks and return navigational property definition for the relation |
31
- | [getScopeFilterJsonSchemaFor(modelCtor, options)](./repository-json-schema.getscopefilterjsonschemafor.md) | Build a JSON schema describing the format of the "scope" object used to query model instances.<!-- -->Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition. |
32
- | [getWhereJsonSchemaFor(modelCtor, options)](./repository-json-schema.getwherejsonschemafor.md) | Build a JSON schema describing the format of the "where" object used to filter model instances to query, update or delete.<!-- -->Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition. |
31
+ | [getScopeFilterJsonSchemaFor(modelCtor, options)](./repository-json-schema.getscopefilterjsonschemafor.md) | <p>Build a JSON schema describing the format of the "scope" object used to query model instances.</p><p>Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition.</p> |
32
+ | [getWhereJsonSchemaFor(modelCtor, options)](./repository-json-schema.getwherejsonschemafor.md) | <p>Build a JSON schema describing the format of the "where" object used to filter model instances to query, update or delete.</p><p>Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition.</p> |
33
33
  | [isArrayType(type)](./repository-json-schema.isarraytype.md) | Determines whether a given string or constructor is array type or not |
34
34
  | [metaToJsonProperty(meta)](./repository-json-schema.metatojsonproperty.md) | Converts property metadata into a JSON property definition |
35
35
  | [modelToJsonSchema(ctor, jsonSchemaOptions)](./repository-json-schema.modeltojsonschema.md) | Converts a TypeScript class into a JSON Schema using TypeScript's reflection API |
@@ -23,13 +23,13 @@ export interface CrudFeatures
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | --- | --- | --- |
28
- | [emptyValue](./repository-tests.crudfeatures.emptyvalue.md) | undefined \| null | The value used by the database to store properties set to <code>undefined</code>. Typically, SQL databases store both <code>undefined</code> and <code>null</code> as <code>null</code>.<!-- -->Default: <code>undefined</code> |
29
- | [freeFormProperties](./repository-tests.crudfeatures.freeformproperties.md) | boolean | Does the database (or the connector) require a fixed schema, or can it support additional (free-form) properties? SQL databases typically don't support free-form properties.<!-- -->Default: <code>true</code> |
30
- | [hasRevisionToken](./repository-tests.crudfeatures.hasrevisiontoken.md) | boolean | Does the connector have the revision token for replacement operations? (Cloudant)<!-- -->Default: <code>false</code> |
31
- | [idType](./repository-tests.crudfeatures.idtype.md) | 'string' \| 'number' | What type is used for auto-generated primary keys? - SQL databases typically use auto-incremented numbers, - NoSQL databases tend to use GUID/UUID strings.<!-- -->Default: <code>'string'</code>. |
32
- | [supportsInclusionResolvers](./repository-tests.crudfeatures.supportsinclusionresolvers.md) | boolean | Does the repository provide <code>inclusionResolvers</code> object where resolvers can be registered?<!-- -->Default: <code>true</code> |
33
- | [supportsTransactions](./repository-tests.crudfeatures.supportstransactions.md) | boolean | Does the connector support using transactions for performing CRUD operations atomically and being able to commit or rollback the changes? SQL databases usually support transactions<!-- -->Default: <code>false</code> |
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [emptyValue](./repository-tests.crudfeatures.emptyvalue.md) | | undefined \| null | <p>The value used by the database to store properties set to <code>undefined</code>. Typically, SQL databases store both <code>undefined</code> and <code>null</code> as <code>null</code>.</p><p>Default: <code>undefined</code></p> |
29
+ | [freeFormProperties](./repository-tests.crudfeatures.freeformproperties.md) | | boolean | <p>Does the database (or the connector) require a fixed schema, or can it support additional (free-form) properties? SQL databases typically don't support free-form properties.</p><p>Default: <code>true</code></p> |
30
+ | [hasRevisionToken](./repository-tests.crudfeatures.hasrevisiontoken.md) | | boolean | <p>Does the connector have the revision token for replacement operations? (Cloudant)</p><p>Default: <code>false</code></p> |
31
+ | [idType](./repository-tests.crudfeatures.idtype.md) | | 'string' \| 'number' | <p>What type is used for auto-generated primary keys? - SQL databases typically use auto-incremented numbers, - NoSQL databases tend to use GUID/UUID strings.</p><p>Default: <code>'string'</code>.</p> |
32
+ | [supportsInclusionResolvers](./repository-tests.crudfeatures.supportsinclusionresolvers.md) | | boolean | <p>Does the repository provide <code>inclusionResolvers</code> object where resolvers can be registered?</p><p>Default: <code>true</code></p> |
33
+ | [supportsTransactions](./repository-tests.crudfeatures.supportstransactions.md) | | boolean | <p>Does the connector support using transactions for performing CRUD operations atomically and being able to commit or rollback the changes? SQL databases usually support transactions</p><p>Default: <code>false</code></p> |
34
34
 
35
35
 
@@ -20,13 +20,13 @@ Any type
20
20
  ```typescript
21
21
  export declare class AnyType implements Type<any>
22
22
  ```
23
- <b>Implements:</b> [Type](./repository.type.md)
23
+ <b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;any&gt;
24
24
 
25
25
  ## Properties
26
26
 
27
27
  | Property | Modifiers | Type | Description |
28
28
  | --- | --- | --- | --- |
29
- | [name](./repository.anytype.name.md) | | (not declared) | |
29
+ | [name](./repository.anytype.name.md) | <code>readonly</code> | (not declared) | |
30
30
 
31
31
  ## Methods
32
32
 
@@ -20,7 +20,7 @@ Array type, such as string\[\]
20
20
  ```typescript
21
21
  export declare class ArrayType<T> implements Type<T[]>
22
22
  ```
23
- <b>Implements:</b> [Type](./repository.type.md)
23
+ <b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;T\[\]&gt;
24
24
 
25
25
  ## Constructors
26
26
 
@@ -33,7 +33,7 @@ export declare class ArrayType<T> implements Type<T[]>
33
33
  | Property | Modifiers | Type | Description |
34
34
  | --- | --- | --- | --- |
35
35
  | [itemType](./repository.arraytype.itemtype.md) | | [Type](./repository.type.md)<!-- -->&lt;T&gt; | |
36
- | [name](./repository.arraytype.name.md) | | (not declared) | |
36
+ | [name](./repository.arraytype.name.md) | <code>readonly</code> | (not declared) | |
37
37
 
38
38
  ## Methods
39
39
 
@@ -25,9 +25,9 @@ export interface BaseRepositoryClass<M extends typeof Model, R extends Repositor
25
25
 
26
26
  ## Properties
27
27
 
28
- | Property | Type | Description |
29
- | --- | --- | --- |
30
- | [prototype](./repository.baserepositoryclass.prototype.md) | R | |
28
+ | Property | Modifiers | Type | Description |
29
+ | --- | --- | --- | --- |
30
+ | [prototype](./repository.baserepositoryclass.prototype.md) | | R | |
31
31
 
32
32
  ## Methods
33
33
 
@@ -21,8 +21,8 @@ export interface BelongsToAccessor<Target extends Entity, SourceId>
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Type | Description |
25
- | --- | --- | --- |
26
- | [inclusionResolver](./repository.belongstoaccessor.inclusionresolver.md) | [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, Target&gt; | Use <code>resolver</code> property to obtain an InclusionResolver for this relation. |
24
+ | Property | Modifiers | Type | Description |
25
+ | --- | --- | --- | --- |
26
+ | [inclusionResolver](./repository.belongstoaccessor.inclusionresolver.md) | | [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, Target&gt; | Use <code>resolver</code> property to obtain an InclusionResolver for this relation. |
27
27
 
28
28
 
@@ -22,12 +22,12 @@ export interface BelongsToDefinition extends RelationDefinitionBase
22
22
 
23
23
  ## Properties
24
24
 
25
- | Property | Type | Description |
26
- | --- | --- | --- |
27
- | [keyFrom?](./repository.belongstodefinition.keyfrom.md) | string | <i>(Optional)</i> |
28
- | [keyTo?](./repository.belongstodefinition.keyto.md) | string | <i>(Optional)</i> |
29
- | [polymorphic?](./repository.belongstodefinition.polymorphic.md) | boolean \| { discriminator: string; } | <i>(Optional)</i> The polymorphism of the target model. The discriminator is a key of source model. If the target model is not polymorphic, then the value should be left undefined or false; If the key on source model indicating the concrete class of the target instance is default i.e. camelCase(classNameOf(throughModelInstance)) + "Id" Then the discriminator field can be undefined |
30
- | [targetsMany](./repository.belongstodefinition.targetsmany.md) | false | |
31
- | [type](./repository.belongstodefinition.type.md) | [RelationType.belongsTo](./repository.relationtype.md) | |
25
+ | Property | Modifiers | Type | Description |
26
+ | --- | --- | --- | --- |
27
+ | [keyFrom?](./repository.belongstodefinition.keyfrom.md) | | string | <i>(Optional)</i> |
28
+ | [keyTo?](./repository.belongstodefinition.keyto.md) | | string | <i>(Optional)</i> |
29
+ | [polymorphic?](./repository.belongstodefinition.polymorphic.md) | | boolean \| { discriminator: string; } | <i>(Optional)</i> The polymorphism of the target model. The discriminator is a key of source model. If the target model is not polymorphic, then the value should be left undefined or false; If the key on source model indicating the concrete class of the target instance is default i.e. camelCase(classNameOf(throughModelInstance)) + "Id" Then the discriminator field can be undefined |
30
+ | [targetsMany](./repository.belongstodefinition.targetsmany.md) | | false | |
31
+ | [type](./repository.belongstodefinition.type.md) | | [RelationType.belongsTo](./repository.relationtype.md) | |
32
32
 
33
33
 
@@ -20,13 +20,13 @@ Boolean type
20
20
  ```typescript
21
21
  export declare class BooleanType implements Type<boolean>
22
22
  ```
23
- <b>Implements:</b> [Type](./repository.type.md)
23
+ <b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;boolean&gt;
24
24
 
25
25
  ## Properties
26
26
 
27
27
  | Property | Modifiers | Type | Description |
28
28
  | --- | --- | --- | --- |
29
- | [name](./repository.booleantype.name.md) | | (not declared) | |
29
+ | [name](./repository.booleantype.name.md) | <code>readonly</code> | (not declared) | |
30
30
 
31
31
  ## Methods
32
32
 
@@ -20,13 +20,13 @@ Buffer (binary) type
20
20
  ```typescript
21
21
  export declare class BufferType implements Type<Buffer>
22
22
  ```
23
- <b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;Buffer
23
+ <b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;Buffer&gt;
24
24
 
25
25
  ## Properties
26
26
 
27
27
  | Property | Modifiers | Type | Description |
28
28
  | --- | --- | --- | --- |
29
- | [name](./repository.buffertype.name.md) | | (not declared) | |
29
+ | [name](./repository.buffertype.name.md) | <code>readonly</code> | (not declared) | |
30
30
 
31
31
  ## Methods
32
32
 
@@ -23,11 +23,11 @@ export interface Connector
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | --- | --- | --- |
28
- | [configModel?](./repository.connector.configmodel.md) | [Model](./repository.model.md) | <i>(Optional)</i> |
29
- | [interfaces?](./repository.connector.interfaces.md) | (string \| [ConnectorInterfaces.StrongRelation](./repository.connectorinterfaces.strongrelation.md) \| [ConnectorInterfaces.StrongJoins](./repository.connectorinterfaces.strongjoins.md)<!-- -->)\[\] | <i>(Optional)</i> |
30
- | [name](./repository.connector.name.md) | string | |
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [configModel?](./repository.connector.configmodel.md) | | [Model](./repository.model.md) | <i>(Optional)</i> |
29
+ | [interfaces?](./repository.connector.interfaces.md) | | (string \| [ConnectorInterfaces.StrongRelation](./repository.connectorinterfaces.strongrelation.md) \| [ConnectorInterfaces.StrongJoins](./repository.connectorinterfaces.strongjoins.md)<!-- -->)\[\] | <i>(Optional)</i> |
30
+ | [name](./repository.connector.name.md) | | string | |
31
31
 
32
32
  ## Methods
33
33
 
@@ -23,8 +23,8 @@ export interface Count
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | --- | --- | --- |
28
- | [count](./repository.count.count.md) | number | |
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [count](./repository.count.count.md) | | number | |
29
29
 
30
30
 
@@ -20,7 +20,7 @@ Basic CRUD operations for ValueObject and Entity. No ID is required.
20
20
  ```typescript
21
21
  export interface CrudRepository<T extends ValueObject | Entity, Relations extends object = {}> extends Repository<T>
22
22
  ```
23
- <b>Extends:</b> [Repository](./repository.repository.md)
23
+ <b>Extends:</b> [Repository](./repository.repository.md)<!-- -->&lt;T&gt;
24
24
 
25
25
  ## Methods
26
26
 
@@ -20,7 +20,7 @@ Repository implementation
20
20
  ```typescript
21
21
  export declare class CrudRepositoryImpl<T extends Entity, ID> implements EntityCrudRepository<T, ID>
22
22
  ```
23
- <b>Implements:</b> [EntityCrudRepository](./repository.entitycrudrepository.md)
23
+ <b>Implements:</b> [EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;T, ID&gt;
24
24
 
25
25
  ## Example
26
26
 
@@ -53,7 +53,7 @@ export class TestRepository extends CrudRepositoryImpl<Test> {
53
53
  | --- | --- | --- | --- |
54
54
  | [dataSource](./repository.crudrepositoryimpl.datasource.md) | | [DataSource](./repository.datasource.md) | |
55
55
  | [entityClass](./repository.crudrepositoryimpl.entityclass.md) | | typeof [Entity](./repository.entity.md) &amp; { prototype: T; } | |
56
- | [inclusionResolvers](./repository.crudrepositoryimpl.inclusionresolvers.md) | | Map&lt;string, [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;T, [Entity](./repository.entity.md)<!-- -->&gt;&gt; | |
56
+ | [inclusionResolvers](./repository.crudrepositoryimpl.inclusionresolvers.md) | <code>readonly</code> | Map&lt;string, [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;T, [Entity](./repository.entity.md)<!-- -->&gt;&gt; | |
57
57
 
58
58
  ## Methods
59
59
 
@@ -23,10 +23,10 @@ export interface DataSource
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | --- | --- | --- |
28
- | [connector?](./repository.datasource.connector.md) | [Connector](./repository.connector.md) | <i>(Optional)</i> |
29
- | [name](./repository.datasource.name.md) | string | |
30
- | [settings](./repository.datasource.settings.md) | [AnyObject](./repository.anyobject.md) | |
26
+ | Property | Modifiers | Type | Description |
27
+ | --- | --- | --- | --- |
28
+ | [connector?](./repository.datasource.connector.md) | | [Connector](./repository.connector.md) | <i>(Optional)</i> |
29
+ | [name](./repository.datasource.name.md) | | string | |
30
+ | [settings](./repository.datasource.settings.md) | | [AnyObject](./repository.anyobject.md) | |
31
31
 
32
32
 
@@ -20,13 +20,13 @@ Date type
20
20
  ```typescript
21
21
  export declare class DateType implements Type<Date>
22
22
  ```
23
- <b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;Date
23
+ <b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;Date&gt;
24
24
 
25
25
  ## Properties
26
26
 
27
27
  | Property | Modifiers | Type | Description |
28
28
  | --- | --- | --- | --- |
29
- | [name](./repository.datetype.name.md) | | (not declared) | |
29
+ | [name](./repository.datetype.name.md) | <code>readonly</code> | (not declared) | |
30
30
 
31
31
  ## Methods
32
32
 
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.repository.defaultbelongstorepository.html
18
18
  ```typescript
19
19
  export declare class DefaultBelongsToRepository<TargetEntity extends Entity, TargetId, TargetRepository extends EntityCrudRepository<TargetEntity, TargetId>> implements BelongsToRepository<TargetEntity>
20
20
  ```
21
- <b>Implements:</b> [BelongsToRepository](./repository.belongstorepository.md)
21
+ <b>Implements:</b> [BelongsToRepository](./repository.belongstorepository.md)<!-- -->&lt;TargetEntity&gt;
22
22
 
23
23
  ## Constructors
24
24
 
@@ -20,7 +20,7 @@ Default implementation of CRUD repository using legacy juggler model and data so
20
20
  ```typescript
21
21
  export declare class DefaultCrudRepository<T extends Entity, ID, Relations extends object = {}> implements EntityCrudRepository<T, ID, Relations>
22
22
  ```
23
- <b>Implements:</b> [EntityCrudRepository](./repository.entitycrudrepository.md)
23
+ <b>Implements:</b> [EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;T, ID, Relations&gt;
24
24
 
25
25
  ## Constructors
26
26
 
@@ -34,45 +34,45 @@ export declare class DefaultCrudRepository<T extends Entity, ID, Relations exten
34
34
  | --- | --- | --- | --- |
35
35
  | [dataSource](./repository.defaultcrudrepository.datasource.md) | | juggler.DataSource | |
36
36
  | [entityClass](./repository.defaultcrudrepository.entityclass.md) | | typeof [Entity](./repository.entity.md) &amp; { prototype: T; } | |
37
- | [inclusionResolvers](./repository.defaultcrudrepository.inclusionresolvers.md) | | Map&lt;string, [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;T, [Entity](./repository.entity.md)<!-- -->&gt;&gt; | |
37
+ | [inclusionResolvers](./repository.defaultcrudrepository.inclusionresolvers.md) | <code>readonly</code> | Map&lt;string, [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;T, [Entity](./repository.entity.md)<!-- -->&gt;&gt; | |
38
38
  | [modelClass](./repository.defaultcrudrepository.modelclass.md) | | juggler.PersistedModelClass | |
39
39
 
40
40
  ## Methods
41
41
 
42
42
  | Method | Modifiers | Description |
43
43
  | --- | --- | --- |
44
- | [\_createBelongsToAccessorFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository._createbelongstoaccessorfor.md) | | |
45
- | [\_createHasManyRepositoryFactoryFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository._createhasmanyrepositoryfactoryfor.md) | | |
46
- | [\_createHasOneRepositoryFactoryFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository._createhasonerepositoryfactoryfor.md) | | |
47
- | [\_createReferencesManyAccessorFor(relationName, targetRepoGetter)](./repository.defaultcrudrepository._createreferencesmanyaccessorfor.md) | | |
44
+ | [\_createBelongsToAccessorFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository._createbelongstoaccessorfor.md) | <code>protected</code> | |
45
+ | [\_createHasManyRepositoryFactoryFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository._createhasmanyrepositoryfactoryfor.md) | <code>protected</code> | |
46
+ | [\_createHasOneRepositoryFactoryFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository._createhasonerepositoryfactoryfor.md) | <code>protected</code> | |
47
+ | [\_createReferencesManyAccessorFor(relationName, targetRepoGetter)](./repository.defaultcrudrepository._createreferencesmanyaccessorfor.md) | <code>protected</code> | |
48
48
  | [count(where, options)](./repository.defaultcrudrepository.count.md) | | |
49
49
  | [create(entity, options)](./repository.defaultcrudrepository.create.md) | | |
50
50
  | [createAll(entities, options)](./repository.defaultcrudrepository.createall.md) | | |
51
- | [createBelongsToAccessorFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository.createbelongstoaccessorfor.md) | | Function to create a belongs to accessor |
52
- | [createHasManyRepositoryFactoryFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository.createhasmanyrepositoryfactoryfor.md) | | Function to create a constrained relation repository factory |
53
- | [createHasManyThroughRepositoryFactoryFor(relationName, targetRepositoryGetter, throughRepositoryGetter)](./repository.defaultcrudrepository.createhasmanythroughrepositoryfactoryfor.md) | | Function to create a constrained hasManyThrough relation repository factory |
54
- | [createHasOneRepositoryFactoryFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository.createhasonerepositoryfactoryfor.md) | | Function to create a constrained hasOne relation repository factory |
55
- | [createReferencesManyAccessorFor(relationName, targetRepoGetter)](./repository.defaultcrudrepository.createreferencesmanyaccessorfor.md) | | Function to create a references many accessor |
56
- | [definePersistedModel(entityClass)](./repository.defaultcrudrepository.definepersistedmodel.md) | | Creates a legacy persisted model class, attaches it to the datasource and returns it. This method can be overridden in sub-classes to acess methods and properties in the generated model class. |
51
+ | [createBelongsToAccessorFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository.createbelongstoaccessorfor.md) | <code>protected</code> | Function to create a belongs to accessor |
52
+ | [createHasManyRepositoryFactoryFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository.createhasmanyrepositoryfactoryfor.md) | <code>protected</code> | Function to create a constrained relation repository factory |
53
+ | [createHasManyThroughRepositoryFactoryFor(relationName, targetRepositoryGetter, throughRepositoryGetter)](./repository.defaultcrudrepository.createhasmanythroughrepositoryfactoryfor.md) | <code>protected</code> | Function to create a constrained hasManyThrough relation repository factory |
54
+ | [createHasOneRepositoryFactoryFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository.createhasonerepositoryfactoryfor.md) | <code>protected</code> | Function to create a constrained hasOne relation repository factory |
55
+ | [createReferencesManyAccessorFor(relationName, targetRepoGetter)](./repository.defaultcrudrepository.createreferencesmanyaccessorfor.md) | <code>protected</code> | Function to create a references many accessor |
56
+ | [definePersistedModel(entityClass)](./repository.defaultcrudrepository.definepersistedmodel.md) | <code>protected</code> | Creates a legacy persisted model class, attaches it to the datasource and returns it. This method can be overridden in sub-classes to acess methods and properties in the generated model class. |
57
57
  | [delete(entity, options)](./repository.defaultcrudrepository.delete.md) | | |
58
58
  | [deleteAll(where, options)](./repository.defaultcrudrepository.deleteall.md) | | |
59
59
  | [deleteById(id, options)](./repository.defaultcrudrepository.deletebyid.md) | | |
60
- | [ensurePersistable(entity, options)](./repository.defaultcrudrepository.ensurepersistable.md) | | Converts an entity object to a JSON object to check if it contains navigational property. Throws an error if <code>entity</code> contains navigational property. |
61
- | [entityToData(entity, options)](./repository.defaultcrudrepository.entitytodata.md) | | This function works as a persist hook. It converts an entity from the CRUD operations' caller to a persistable data that can will be stored in the back-end database.<!-- -->User can extend <code>DefaultCrudRepository</code> then override this function to execute custom persist hook. |
62
- | [execute(command, parameters, options)](./repository.defaultcrudrepository.execute.md) | | Execute a SQL command.<!-- -->\*\*WARNING:\*\* In general, it is always better to perform database actions through repository methods. Directly executing SQL may lead to unexpected results, corrupted data, security vulnerabilities and other issues. |
63
- | [execute(collectionName, command, parameters)](./repository.defaultcrudrepository.execute_1.md) | | Execute a MongoDB command.<!-- -->\*\*WARNING:\*\* In general, it is always better to perform database actions through repository methods. Directly executing MongoDB commands may lead to unexpected results and other issues. |
64
- | [execute(args)](./repository.defaultcrudrepository.execute_2.md) | | Execute a raw database command using a connector that's not described by LoopBack's <code>execute</code> API yet.<!-- -->\*\*WARNING:\*\* In general, it is always better to perform database actions through repository methods. Directly executing database commands may lead to unexpected results and other issues. |
60
+ | [ensurePersistable(entity, options)](./repository.defaultcrudrepository.ensurepersistable.md) | <code>protected</code> | Converts an entity object to a JSON object to check if it contains navigational property. Throws an error if <code>entity</code> contains navigational property. |
61
+ | [entityToData(entity, options)](./repository.defaultcrudrepository.entitytodata.md) | <code>protected</code> | <p>This function works as a persist hook. It converts an entity from the CRUD operations' caller to a persistable data that can will be stored in the back-end database.</p><p>User can extend <code>DefaultCrudRepository</code> then override this function to execute custom persist hook.</p> |
62
+ | [execute(command, parameters, options)](./repository.defaultcrudrepository.execute.md) | | <p>Execute a SQL command.</p><p>\*\*WARNING:\*\* In general, it is always better to perform database actions through repository methods. Directly executing SQL may lead to unexpected results, corrupted data, security vulnerabilities and other issues.</p> |
63
+ | [execute(collectionName, command, parameters)](./repository.defaultcrudrepository.execute_1.md) | | <p>Execute a MongoDB command.</p><p>\*\*WARNING:\*\* In general, it is always better to perform database actions through repository methods. Directly executing MongoDB commands may lead to unexpected results and other issues.</p> |
64
+ | [execute(args)](./repository.defaultcrudrepository.execute_2.md) | | <p>Execute a raw database command using a connector that's not described by LoopBack's <code>execute</code> API yet.</p><p>\*\*WARNING:\*\* In general, it is always better to perform database actions through repository methods. Directly executing database commands may lead to unexpected results and other issues.</p> |
65
65
  | [exists(id, options)](./repository.defaultcrudrepository.exists.md) | | |
66
66
  | [find(filter, options)](./repository.defaultcrudrepository.find.md) | | |
67
67
  | [findById(id, filter, options)](./repository.defaultcrudrepository.findbyid.md) | | |
68
68
  | [findOne(filter, options)](./repository.defaultcrudrepository.findone.md) | | |
69
- | [includeRelatedModels(entities, include, options)](./repository.defaultcrudrepository.includerelatedmodels.md) | | Returns model instances that include related models of this repository that have a registered resolver. |
70
- | [normalizeFilter(filter)](./repository.defaultcrudrepository.normalizefilter.md) | | Removes juggler's "include" filter as it does not apply to LoopBack 4 relations. |
69
+ | [includeRelatedModels(entities, include, options)](./repository.defaultcrudrepository.includerelatedmodels.md) | <code>protected</code> | Returns model instances that include related models of this repository that have a registered resolver. |
70
+ | [normalizeFilter(filter)](./repository.defaultcrudrepository.normalizefilter.md) | <code>protected</code> | Removes juggler's "include" filter as it does not apply to LoopBack 4 relations. |
71
71
  | [registerInclusionResolver(relationName, resolver)](./repository.defaultcrudrepository.registerinclusionresolver.md) | | Register an inclusion resolver for the related model name. |
72
72
  | [replaceById(id, data, options)](./repository.defaultcrudrepository.replacebyid.md) | | |
73
73
  | [save(entity, options)](./repository.defaultcrudrepository.save.md) | | |
74
- | [toEntities(models)](./repository.defaultcrudrepository.toentities.md) | | |
75
- | [toEntity(model)](./repository.defaultcrudrepository.toentity.md) | | |
74
+ | [toEntities(models)](./repository.defaultcrudrepository.toentities.md) | <code>protected</code> | |
75
+ | [toEntity(model)](./repository.defaultcrudrepository.toentity.md) | <code>protected</code> | |
76
76
  | [update(entity, options)](./repository.defaultcrudrepository.update.md) | | |
77
77
  | [updateAll(data, where, options)](./repository.defaultcrudrepository.updateall.md) | | |
78
78
  | [updateById(id, data, options)](./repository.defaultcrudrepository.updatebyid.md) | | |