@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.
- package/CHANGELOG.md +63 -0
- package/LICENSE +2 -2
- package/package.json +5 -5
- package/site/BelongsTo-relation.md +1 -1
- package/site/Context.md +1 -1
- package/site/Copyright-generator.md +8 -7
- package/site/Crafting-LoopBack-4.md +3 -3
- package/site/DEVELOPING.md +2 -2
- package/site/Discovering-models.md +5 -0
- package/site/Dynamic-models-repositories-controllers.md +2 -2
- package/site/Implementing-features.shelved.md +1 -1
- package/site/Include-filter.md +1 -1
- package/site/Interceptor-generator.md +1 -1
- package/site/LB3-vs-LB4-request-response-cycle.md +4 -4
- package/site/Model-generator.md +1 -1
- package/site/Model.md +2 -2
- package/site/{Polymorphic-relations.md → Polymorphic-relation.md} +2 -2
- package/site/REST-middleware-sequence.md +1 -1
- package/site/Repository-generator.md +2 -2
- package/site/Repository.md +1 -1
- package/site/Request-response-cycle.md +6 -6
- package/site/Rest-Crud-generator.md +7 -1
- package/site/Serving-static-files.md +1 -1
- package/site/Testing-your-application.md +1 -1
- package/site/apidocs/authentication-jwt.myuserservice.md +1 -1
- package/site/apidocs/authentication-jwt.refreshtokenrepository.md +1 -1
- package/site/apidocs/authentication-jwt.usercredentialsrepository.md +1 -1
- package/site/apidocs/authentication-jwt.userrepository.md +3 -3
- package/site/apidocs/authentication-passport.strategyadapter.md +1 -1
- package/site/apidocs/authentication.authenticateactionprovider.md +5 -5
- package/site/apidocs/authentication.authenticationmetadata.md +5 -5
- package/site/apidocs/authentication.authenticationmiddlewareprovider.md +1 -1
- package/site/apidocs/authentication.authenticationoptions.md +4 -4
- package/site/apidocs/authentication.authenticationstrategy.md +3 -3
- package/site/apidocs/authentication.authenticationstrategyprovider.md +3 -3
- package/site/apidocs/authentication.authmetadataprovider.md +1 -1
- package/site/apidocs/authentication.md +3 -3
- package/site/apidocs/authorization.authorizationcontext.md +7 -7
- package/site/apidocs/authorization.authorizationinterceptor.md +1 -1
- package/site/apidocs/authorization.authorizationmetadata.md +8 -8
- package/site/apidocs/authorization.authorizationoptions.md +6 -6
- package/site/apidocs/authorization.authorizationrequest.md +6 -6
- package/site/apidocs/authorization.authorizemethoddecoratorfactory.md +2 -2
- package/site/apidocs/boot.baseartifactbooter.md +5 -5
- package/site/apidocs/boot.bootable.md +4 -4
- package/site/apidocs/boot.bootmixin.md +44 -44
- package/site/apidocs/boot.instancewithbooters.md +3 -3
- package/site/apidocs/boot.md +10 -10
- package/site/apidocs/context-explorer.contextbinding.md +4 -4
- package/site/apidocs/context-explorer.contextgraph.md +2 -2
- package/site/apidocs/context.binding.md +11 -11
- package/site/apidocs/context.bindingelement.md +4 -4
- package/site/apidocs/context.bindinginspectoptions.md +3 -3
- package/site/apidocs/context.bindingkey.md +4 -4
- package/site/apidocs/context.bindingscope.md +2 -2
- package/site/apidocs/context.bindingtagfilter.md +3 -3
- package/site/apidocs/context.config.getter.md +1 -1
- package/site/apidocs/context.config.view.md +1 -1
- package/site/apidocs/context.configinjectionmetadata.md +4 -4
- package/site/apidocs/context.context.find.md +1 -1
- package/site/apidocs/context.context.md +15 -15
- package/site/apidocs/context.contextinspectoptions.md +3 -3
- package/site/apidocs/context.contextobserver.md +4 -4
- package/site/apidocs/context.contextsubscriptionmanager.md +5 -5
- package/site/apidocs/context.contextview.md +7 -7
- package/site/apidocs/context.contextviewevent.md +3 -3
- package/site/apidocs/context.defaultconfigurationresolver.md +1 -1
- package/site/apidocs/context.dynamicvalueproviderclass.md +3 -3
- package/site/apidocs/context.genericinterceptorchain.md +1 -1
- package/site/apidocs/context.inject.binding.md +1 -1
- package/site/apidocs/context.inject.getter.md +1 -1
- package/site/apidocs/context.inject.md +2 -2
- package/site/apidocs/context.inject.setter.md +1 -1
- package/site/apidocs/context.inject.tag.md +1 -1
- package/site/apidocs/context.inject.view.md +1 -1
- package/site/apidocs/context.injectable.md +1 -1
- package/site/apidocs/context.injectbindingmetadata.md +3 -3
- package/site/apidocs/context.injection.md +8 -8
- package/site/apidocs/context.injectiondescriptor.md +5 -5
- package/site/apidocs/context.injectionelement.md +4 -4
- package/site/apidocs/context.injectionmetadata.md +5 -5
- package/site/apidocs/context.intercept.md +2 -2
- package/site/apidocs/context.interceptionhandler.md +1 -1
- package/site/apidocs/context.interceptor.md +1 -1
- package/site/apidocs/context.interceptorbindingoptions.md +5 -5
- package/site/apidocs/context.invocationcontext.md +7 -7
- package/site/apidocs/context.invocationsource.md +4 -4
- package/site/apidocs/context.jsonarray.md +1 -1
- package/site/apidocs/context.jsonobject.md +1 -1
- package/site/apidocs/context.md +9 -9
- package/site/apidocs/context.notification.md +3 -3
- package/site/apidocs/context.proxysource.md +2 -2
- package/site/apidocs/context.resolutioncontext.md +5 -5
- package/site/apidocs/context.resolutionerror.md +1 -1
- package/site/apidocs/context.resolutionoptions.md +5 -5
- package/site/apidocs/context.resolutionsession.md +5 -5
- package/site/apidocs/context.subscription.md +3 -3
- package/site/apidocs/core.application.md +13 -13
- package/site/apidocs/core.applicationconfig.md +4 -4
- package/site/apidocs/core.applicationmetadata.md +5 -5
- package/site/apidocs/core.component.md +9 -9
- package/site/apidocs/core.lifecycleobserverregistry.md +8 -8
- package/site/apidocs/core.server.md +3 -3
- package/site/apidocs/core.service.md +1 -1
- package/site/apidocs/core.serviceoptions.md +3 -3
- package/site/apidocs/cron.croncomponent.md +1 -1
- package/site/apidocs/cron.md +1 -1
- package/site/apidocs/express.basemiddlewarebindingoptions.md +4 -4
- package/site/apidocs/express.expressapplication.md +2 -2
- package/site/apidocs/express.expressmiddlewareinterceptorprovider.md +4 -4
- package/site/apidocs/express.expressserver.md +7 -7
- package/site/apidocs/express.handlercontext.md +4 -4
- package/site/apidocs/express.invokemiddlewareoptions.md +7 -7
- package/site/apidocs/express.middleware.md +1 -1
- package/site/apidocs/express.middlewarebindingoptions.md +6 -6
- package/site/apidocs/express.middlewarechain.md +1 -1
- package/site/apidocs/express.middlewarecontext.md +3 -3
- package/site/apidocs/express.middlewarecreationoptions.md +4 -4
- package/site/apidocs/express.middlewareinterceptorbindingoptions.md +4 -4
- package/site/apidocs/express.middlewaremixin.md +28 -28
- package/site/apidocs/express.middlewareview.md +1 -1
- package/site/apidocs/filter.andclause.md +3 -3
- package/site/apidocs/filter.filter.md +9 -9
- package/site/apidocs/filter.inclusion.md +5 -5
- package/site/apidocs/filter.md +3 -3
- package/site/apidocs/filter.orclause.md +3 -3
- package/site/apidocs/graphql.graphqlresolutioncontext.md +2 -2
- package/site/apidocs/graphql.graphqlserver.md +3 -3
- package/site/apidocs/graphql.graphqlserveroptions.md +6 -6
- package/site/apidocs/graphql.loopbackcontainer.md +1 -1
- package/site/apidocs/http-caching-proxy.proxyoptions.md +7 -7
- package/site/apidocs/http-server.basehttpoptions.md +4 -4
- package/site/apidocs/http-server.httpoptions.md +3 -3
- package/site/apidocs/http-server.httpserver.md +8 -8
- package/site/apidocs/http-server.httpsoptions.md +3 -3
- package/site/apidocs/index.md +1 -1
- package/site/apidocs/logging.winstonloggerprovider.md +1 -1
- package/site/apidocs/metadata.classdecoratorfactory.md +3 -3
- package/site/apidocs/metadata.decoratorfactory.md +11 -11
- package/site/apidocs/metadata.decoratoroptions.md +5 -5
- package/site/apidocs/metadata.designtimemethodmetadata.md +5 -5
- package/site/apidocs/metadata.inspectionoptions.md +3 -3
- package/site/apidocs/metadata.metadataaccessor.md +1 -1
- package/site/apidocs/metadata.metadatainspector.md +2 -2
- package/site/apidocs/metadata.methoddecoratorfactory.md +3 -3
- package/site/apidocs/metadata.methodmultidecoratorfactory.md +3 -3
- package/site/apidocs/metadata.methodparameterdecoratorfactory.md +3 -3
- package/site/apidocs/metadata.parameterdecoratorfactory.md +3 -3
- package/site/apidocs/metadata.propertydecoratorfactory.md +3 -3
- package/site/apidocs/metrics.metricsoptions.md +7 -7
- package/site/apidocs/mock-oauth2-provider.myuser.md +10 -10
- package/site/apidocs/model-api-builder.modelapibuilder.md +3 -3
- package/site/apidocs/openapi-spec-builder.builderbase.md +1 -1
- package/site/apidocs/openapi-spec-builder.componentsspecbuilder.md +1 -1
- package/site/apidocs/openapi-spec-builder.openapispecbuilder.md +1 -1
- package/site/apidocs/openapi-spec-builder.operationspecbuilder.md +1 -1
- package/site/apidocs/openapi-v3.controllerspec.md +5 -5
- package/site/apidocs/openapi-v3.deprecated.md +2 -2
- package/site/apidocs/openapi-v3.md +9 -9
- package/site/apidocs/openapi-v3.oasenhancer.md +3 -3
- package/site/apidocs/openapi-v3.oasenhancerservice.md +1 -1
- package/site/apidocs/openapi-v3.param.query.md +1 -1
- package/site/apidocs/openapi-v3.requestbody.array.md +3 -3
- package/site/apidocs/openapi-v3.requestbody.file.md +3 -3
- package/site/apidocs/openapi-v3.requestbody.md +1 -1
- package/site/apidocs/openapi-v3.responsedecoratormetadataitem.md +6 -6
- package/site/apidocs/openapi-v3.restendpoint.md +5 -5
- package/site/apidocs/openapi-v3.tags.md +2 -2
- package/site/apidocs/openapi-v3.tagsdecoratormetadata.md +3 -3
- package/site/apidocs/openapi-v3.visibility.md +2 -2
- package/site/apidocs/pooling.pooledvalue.md +4 -4
- package/site/apidocs/pooling.poolfactory.md +1 -1
- package/site/apidocs/pooling.poolingservice.md +2 -2
- package/site/apidocs/pooling.poolingserviceoptions.md +4 -4
- package/site/apidocs/repository-json-schema.filterschemaoptions.md +4 -4
- package/site/apidocs/repository-json-schema.jsonschemaoptions.md +7 -7
- package/site/apidocs/repository-json-schema.md +3 -3
- package/site/apidocs/repository-tests.crudfeatures.md +8 -8
- package/site/apidocs/repository.anytype.md +2 -2
- package/site/apidocs/repository.arraytype.md +2 -2
- package/site/apidocs/repository.baserepositoryclass.md +3 -3
- package/site/apidocs/repository.belongstoaccessor.md +3 -3
- package/site/apidocs/repository.belongstodefinition.md +7 -7
- package/site/apidocs/repository.booleantype.md +2 -2
- package/site/apidocs/repository.buffertype.md +2 -2
- package/site/apidocs/repository.connector.md +5 -5
- package/site/apidocs/repository.count.md +3 -3
- package/site/apidocs/repository.crudrepository.md +1 -1
- package/site/apidocs/repository.crudrepositoryimpl.md +2 -2
- package/site/apidocs/repository.datasource.md +5 -5
- package/site/apidocs/repository.datetype.md +2 -2
- package/site/apidocs/repository.defaultbelongstorepository.md +1 -1
- package/site/apidocs/repository.defaultcrudrepository.definepersistedmodel.md +1 -1
- package/site/apidocs/repository.defaultcrudrepository.md +21 -21
- package/site/apidocs/repository.defaulthasmanyrepository.md +1 -1
- package/site/apidocs/repository.defaulthasmanythroughrepository.md +1 -1
- package/site/apidocs/repository.defaulthasonerepository.md +1 -1
- package/site/apidocs/repository.defaultkeyvaluerepository.md +2 -2
- package/site/apidocs/repository.defaultreferencesmanyrepository.md +1 -1
- package/site/apidocs/repository.defaulttransactionalrepository.md +2 -2
- package/site/apidocs/repository.entitycrudrepository.md +5 -5
- package/site/apidocs/repository.entityrepository.md +1 -1
- package/site/apidocs/repository.executablerepository.md +1 -1
- package/site/apidocs/repository.hasmanydefinition.md +7 -7
- package/site/apidocs/repository.hasmanyrepositoryfactory.md +3 -3
- package/site/apidocs/repository.hasonedefinition.md +7 -7
- package/site/apidocs/repository.hasonerepositoryfactory.md +3 -3
- package/site/apidocs/repository.keyvaluerepository.md +1 -1
- package/site/apidocs/repository.md +14 -14
- package/site/apidocs/repository.modeldefinition.md +1 -1
- package/site/apidocs/repository.modeldefinitionsyntax.md +7 -7
- package/site/apidocs/repository.modelrepositoryclass.md +3 -3
- package/site/apidocs/repository.modelsettings.md +7 -7
- package/site/apidocs/repository.modeltype.md +2 -2
- package/site/apidocs/repository.nulltype.md +2 -2
- package/site/apidocs/repository.numbertype.md +2 -2
- package/site/apidocs/repository.objecttype.md +1 -1
- package/site/apidocs/repository.propertydefinition.md +9 -9
- package/site/apidocs/repository.propertyform.md +5 -5
- package/site/apidocs/repository.referencesmanyaccessor.md +3 -3
- package/site/apidocs/repository.referencesmanydefinition.md +6 -6
- package/site/apidocs/repository.relationdefinitionbase.md +7 -7
- package/site/apidocs/repository.repositorycomponent.md +4 -4
- package/site/apidocs/repository.repositorymetadata._constructor_.md +1 -1
- package/site/apidocs/repository.repositorymixin.md +50 -50
- package/site/apidocs/repository.repositorymixindoc.md +1 -1
- package/site/apidocs/repository.schemamigrationoptions.md +4 -4
- package/site/apidocs/repository.stringtype.md +2 -2
- package/site/apidocs/repository.transaction.md +3 -3
- package/site/apidocs/repository.transactionalrepository.md +1 -1
- package/site/apidocs/repository.type.md +3 -3
- package/site/apidocs/repository.uniontype.md +2 -2
- package/site/apidocs/rest-crud.crudrestapibuilder.md +1 -1
- package/site/apidocs/{rest-crud.crudrestcontroller.create.md → rest-crud.crudrestcontroller.find.md} +8 -8
- package/site/apidocs/rest-crud.crudrestcontroller.md +4 -4
- package/site/apidocs/rest-crud.crudrestcontrolleroptions.md +4 -3
- package/site/apidocs/rest-crud.crudrestcontrolleroptions.readonly.md +23 -0
- package/site/apidocs/rest-crud.modelcrudrestapiconfig.md +4 -3
- package/site/apidocs/rest-crud.modelcrudrestapiconfig.readonly.md +23 -0
- package/site/apidocs/rest-explorer.restexplorerbindings.md +1 -1
- package/site/apidocs/rest.apiexploreroptions.md +5 -5
- package/site/apidocs/rest.baseroute.md +3 -3
- package/site/apidocs/rest.bodyparser.md +3 -3
- package/site/apidocs/rest.controllerroute.md +4 -4
- package/site/apidocs/rest.defaultsequence.md +5 -5
- package/site/apidocs/rest.findroutemiddlewareprovider.md +1 -1
- package/site/apidocs/rest.httphandler.md +5 -5
- package/site/apidocs/rest.httpserverlike.md +3 -3
- package/site/apidocs/rest.infospecenhancer.md +1 -1
- package/site/apidocs/rest.invokemethodmiddlewareprovider.md +1 -1
- package/site/apidocs/rest.md +1 -1
- package/site/apidocs/rest.middlewaresequence.md +3 -3
- package/site/apidocs/rest.node.md +7 -7
- package/site/apidocs/rest.openapispecform.md +4 -4
- package/site/apidocs/rest.openapispecoptions.md +7 -7
- package/site/apidocs/rest.parseparamsmiddlewareprovider.md +1 -1
- package/site/apidocs/rest.redirectroute.md +8 -8
- package/site/apidocs/rest.regexprouter.md +3 -3
- package/site/apidocs/rest.requestbodyparser.md +1 -1
- package/site/apidocs/rest.requestbodyparseroptions.md +7 -7
- package/site/apidocs/rest.requestcontext.md +7 -7
- package/site/apidocs/rest.requestwithsession.md +3 -3
- package/site/apidocs/rest.resolvednode.md +4 -4
- package/site/apidocs/rest.resolvedroute.md +4 -4
- package/site/apidocs/rest.restapplication.md +3 -3
- package/site/apidocs/rest.restbindings.md +1 -1
- package/site/apidocs/rest.resthttperrors.validationerrordetails.md +6 -6
- package/site/apidocs/rest.restserver.md +22 -22
- package/site/apidocs/rest.restserverresolvedoptions.md +13 -13
- package/site/apidocs/rest.route.md +2 -2
- package/site/apidocs/rest.routeentry.md +5 -5
- package/site/apidocs/rest.routesource.md +2 -2
- package/site/apidocs/rest.sendresponsemiddlewareprovider.md +1 -1
- package/site/apidocs/rest.session.md +3 -3
- package/site/apidocs/rest.sessionuserprofile.md +5 -5
- package/site/apidocs/rest.trie.md +1 -1
- package/site/apidocs/rest.trierouter.md +3 -3
- package/site/apidocs/rest.validationoptions.md +8 -8
- package/site/apidocs/rest.valuevalidationoptions.md +4 -4
- package/site/apidocs/security.defaultsubject.md +4 -4
- package/site/apidocs/security.md +2 -2
- package/site/apidocs/security.permission.md +1 -1
- package/site/apidocs/security.principal.md +3 -3
- package/site/apidocs/security.role.md +3 -3
- package/site/apidocs/security.scope.md +3 -3
- package/site/apidocs/security.subject.md +5 -5
- package/site/apidocs/security.typedprincipal.md +3 -3
- package/site/apidocs/security.userprofile.md +4 -4
- package/site/apidocs/service-proxy.md +1 -1
- package/site/apidocs/service-proxy.servicemixin.md +43 -43
- package/site/apidocs/service-proxy.serviceproxy.md +2 -2
- package/site/apidocs/socketio.defaultsocketiosequence.md +5 -5
- package/site/apidocs/socketio.httpserverresolvedoptions.md +7 -7
- package/site/apidocs/socketio.socketio.md +1 -1
- package/site/apidocs/socketio.socketioapplication.md +1 -1
- package/site/apidocs/socketio.socketiobooter.md +1 -1
- package/site/apidocs/socketio.socketioconnectioncontext.md +1 -1
- package/site/apidocs/socketio.socketiocontrollerfactory.md +4 -4
- package/site/apidocs/socketio.socketioinvokemethodprovider.md +1 -1
- package/site/apidocs/socketio.socketiometadata.md +4 -4
- package/site/apidocs/socketio.socketiorejectprovider.md +1 -1
- package/site/apidocs/socketio.socketiosendprovider.md +1 -1
- package/site/apidocs/socketio.socketioserver.md +4 -4
- package/site/apidocs/socketio.socketioserveroptions.md +4 -4
- package/site/apidocs/testlab.expresscontextstub.md +6 -6
- package/site/apidocs/testlab.handlercontextstub.md +5 -5
- package/site/apidocs/testlab.hostport.md +4 -4
- package/site/apidocs/testlab.httpoptions.md +3 -3
- package/site/apidocs/testlab.httpsoptions.md +3 -3
- package/site/apidocs/testlab.md +1 -1
- package/site/apidocs/testlab.restapplicationlike.md +3 -3
- package/site/apidocs/testlab.restserverlike.md +4 -4
- package/site/apidocs/testlab.testsandbox.md +1 -1
- package/site/apidocs/testlab.testsandboxoptions.md +3 -3
- package/site/apidocs/tsdocs.apidocsoptions.md +9 -9
- package/site/apidocs/tsdocs.extractoroptions.md +8 -8
- package/site/apidocs/tsdocs.lernapackage.md +7 -7
- package/site/apidocs/typeorm.md +1 -1
- package/site/apidocs/typeorm.typeormmixin.md +61 -61
- package/site/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +30 -0
- package/site/changelogs/examples/access-control-migration/CHANGELOG.md +30 -0
- package/site/changelogs/examples/binding-resolution/CHANGELOG.md +30 -0
- package/site/changelogs/examples/context/CHANGELOG.md +30 -0
- package/site/changelogs/examples/express-composition/CHANGELOG.md +30 -0
- package/site/changelogs/examples/file-transfer/CHANGELOG.md +30 -0
- package/site/changelogs/examples/graphql/CHANGELOG.md +30 -0
- package/site/changelogs/examples/greeter-extension/CHANGELOG.md +30 -0
- package/site/changelogs/examples/greeting-app/CHANGELOG.md +30 -0
- package/site/changelogs/examples/hello-world/CHANGELOG.md +30 -0
- package/site/changelogs/examples/lb3-application/CHANGELOG.md +33 -0
- package/site/changelogs/examples/log-extension/CHANGELOG.md +33 -0
- package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +30 -0
- package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +34 -1
- package/site/changelogs/examples/passport-login/CHANGELOG.md +30 -0
- package/site/changelogs/examples/references-many/CHANGELOG.md +29 -0
- package/site/changelogs/examples/rest-crud/CHANGELOG.md +33 -0
- package/site/changelogs/examples/rpc-server/CHANGELOG.md +30 -0
- package/site/changelogs/examples/soap-calculator/CHANGELOG.md +30 -0
- package/site/changelogs/examples/socketio/CHANGELOG.md +30 -0
- package/site/changelogs/examples/todo/CHANGELOG.md +30 -0
- package/site/changelogs/examples/todo-jwt/CHANGELOG.md +33 -0
- package/site/changelogs/examples/todo-list/CHANGELOG.md +30 -0
- package/site/changelogs/examples/validation-app/CHANGELOG.md +30 -0
- package/site/changelogs/examples/webpack/CHANGELOG.md +30 -0
- package/site/changelogs/extensions/apiconnect/CHANGELOG.md +30 -0
- package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +30 -0
- package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +30 -0
- package/site/changelogs/extensions/context-explorer/CHANGELOG.md +30 -0
- package/site/changelogs/extensions/cron/CHANGELOG.md +30 -0
- package/site/changelogs/extensions/graphql/CHANGELOG.md +30 -0
- package/site/changelogs/extensions/health/CHANGELOG.md +30 -0
- package/site/changelogs/extensions/logging/CHANGELOG.md +30 -0
- package/site/changelogs/extensions/metrics/CHANGELOG.md +30 -0
- package/site/changelogs/extensions/pooling/CHANGELOG.md +30 -0
- package/site/changelogs/extensions/socketio/CHANGELOG.md +30 -0
- package/site/changelogs/extensions/typeorm/CHANGELOG.md +32 -0
- package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +309 -0
- package/site/changelogs/packages/authentication/CHANGELOG.md +30 -0
- package/site/changelogs/packages/authorization/CHANGELOG.md +30 -0
- package/site/changelogs/packages/boot/CHANGELOG.md +33 -0
- package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +30 -0
- package/site/changelogs/packages/build/CHANGELOG.md +28 -0
- package/site/changelogs/packages/cli/CHANGELOG.md +62 -0
- package/site/changelogs/packages/context/CHANGELOG.md +30 -0
- package/site/changelogs/packages/core/CHANGELOG.md +33 -0
- package/site/changelogs/packages/eslint-config/CHANGELOG.md +27 -0
- package/site/changelogs/packages/express/CHANGELOG.md +30 -0
- package/site/changelogs/packages/filter/CHANGELOG.md +34 -0
- package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +30 -0
- package/site/changelogs/packages/http-server/CHANGELOG.md +35 -0
- package/site/changelogs/packages/metadata/CHANGELOG.md +30 -0
- package/site/changelogs/packages/model-api-builder/CHANGELOG.md +30 -0
- package/site/changelogs/packages/monorepo/CHANGELOG.md +24 -0
- package/site/changelogs/packages/openapi-spec-builder/CHANGELOG.md +30 -0
- package/site/changelogs/packages/openapi-v3/CHANGELOG.md +36 -0
- package/site/changelogs/packages/repository/CHANGELOG.md +39 -0
- package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +33 -0
- package/site/changelogs/packages/repository-tests/CHANGELOG.md +31 -0
- package/site/changelogs/packages/rest/CHANGELOG.md +30 -0
- package/site/changelogs/packages/rest-crud/CHANGELOG.md +36 -0
- package/site/changelogs/packages/rest-explorer/CHANGELOG.md +30 -0
- package/site/changelogs/packages/security/CHANGELOG.md +30 -0
- package/site/changelogs/packages/service-proxy/CHANGELOG.md +30 -0
- package/site/changelogs/packages/testlab/CHANGELOG.md +24 -0
- package/site/changelogs/packages/tsdocs/CHANGELOG.md +30 -0
- package/site/decorators/Decorators_openapi.md +3 -3
- package/site/deployment/Deploy-for-GDPR-readiness.md +1 -1
- package/site/migration/LB3-vs-LB4-booting.md +1 -1
- package/site/migration/auth/passport.md +2 -2
- package/site/readmes/loopback-next/examples/lb3-application/README.md +1 -1
- package/site/readmes/loopback-next/examples/log-extension/README.md +1 -1
- package/site/readmes/loopback-next/examples/rest-crud/README.md +1 -1
- package/site/readmes/loopback-next/examples/todo-jwt/README.md +1 -1
- package/site/readmes/loopback-next/packages/boot/README.md +1 -1
- package/site/readmes/loopback-next/packages/build/README.md +2 -2
- package/site/readmes/loopback-next/packages/rest-crud/README.md +3 -2
- package/site/sidebars/lb4_sidebar.yml +4 -0
- package/site/tutorials/core/11-summary.md +1 -1
- package/site/tutorials/core/3-context-in-action.md +3 -3
- package/site/tutorials/soap-calculator/soap-calculator-tutorial-add-controller.md +1 -1
- package/site/tutorials/soap-calculator/soap-calculator-tutorial-scaffolding.md +1 -1
|
@@ -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) |
|
|
42
|
-
| [pool](./pooling.poolingservice.pool.md) |
|
|
41
|
+
| [context](./pooling.poolingservice.context.md) | <code>readonly</code> | [Context](./context.context.md) | |
|
|
42
|
+
| [pool](./pooling.poolingservice.pool.md) | <code>readonly</code> | Pool<T> | 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)<!-- --><T> \| ((ctx: [Context](./context.context.md)<!-- -->) => [PoolFactory](./pooling.poolfactory.md)<!-- --><T>) | 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)<!-- --><T> \| ((ctx: [Context](./context.context.md)<!-- -->) => [PoolFactory](./pooling.poolfactory.md)<!-- --><T>) | 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
|
|
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
|
|
30
|
-
| [title?](./repository-json-schema.jsonschemaoptions.title.md) | string | <i>(Optional)</i> The title to use in the generated schema
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
30
|
-
| [hasRevisionToken](./repository-tests.crudfeatures.hasrevisiontoken.md) | boolean | Does the connector have the revision token for replacement operations? (Cloudant)
|
|
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
|
|
32
|
-
| [supportsInclusionResolvers](./repository-tests.crudfeatures.supportsinclusionresolvers.md) | boolean | Does the repository provide <code>inclusionResolvers</code> object where resolvers can be registered
|
|
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
|
|
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)<!-- --><any>
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
27
|
| Property | Modifiers | Type | Description |
|
|
28
28
|
| --- | --- | --- | --- |
|
|
29
|
-
| [name](./repository.anytype.name.md) |
|
|
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)<!-- --><T\[\]>
|
|
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)<!-- --><T> | |
|
|
36
|
-
| [name](./repository.arraytype.name.md) |
|
|
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)<!-- --><[Entity](./repository.entity.md)<!-- -->, Target> | 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)<!-- --><[Entity](./repository.entity.md)<!-- -->, Target> | 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)<!-- --><boolean>
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
27
|
| Property | Modifiers | Type | Description |
|
|
28
28
|
| --- | --- | --- | --- |
|
|
29
|
-
| [name](./repository.booleantype.name.md) |
|
|
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)<!-- --><Buffer
|
|
23
|
+
<b>Implements:</b> [Type](./repository.type.md)<!-- --><Buffer>
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
27
|
| Property | Modifiers | Type | Description |
|
|
28
28
|
| --- | --- | --- | --- |
|
|
29
|
-
| [name](./repository.buffertype.name.md) |
|
|
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)<!-- --><T>
|
|
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)<!-- --><T, ID>
|
|
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) & { prototype: T; } | |
|
|
56
|
-
| [inclusionResolvers](./repository.crudrepositoryimpl.inclusionresolvers.md) |
|
|
56
|
+
| [inclusionResolvers](./repository.crudrepositoryimpl.inclusionresolvers.md) | <code>readonly</code> | Map<string, [InclusionResolver](./repository.inclusionresolver.md)<!-- --><T, [Entity](./repository.entity.md)<!-- -->>> | |
|
|
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)<!-- --><Date
|
|
23
|
+
<b>Implements:</b> [Type](./repository.type.md)<!-- --><Date>
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
27
|
| Property | Modifiers | Type | Description |
|
|
28
28
|
| --- | --- | --- | --- |
|
|
29
|
-
| [name](./repository.datetype.name.md) |
|
|
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)<!-- --><TargetEntity>
|
|
22
22
|
|
|
23
23
|
## Constructors
|
|
24
24
|
|
|
@@ -13,7 +13,7 @@ permalink: /doc/en/lb4/apidocs.repository.defaultcrudrepository.definepersistedm
|
|
|
13
13
|
|
|
14
14
|
## DefaultCrudRepository.definePersistedModel() method
|
|
15
15
|
|
|
16
|
-
Creates a legacy persisted model class, attaches it to the datasource and returns it. This method can be
|
|
16
|
+
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.
|
|
17
17
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
@@ -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)<!-- --><T, ID, Relations>
|
|
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) & { prototype: T; } | |
|
|
37
|
-
| [inclusionResolvers](./repository.defaultcrudrepository.inclusionresolvers.md) |
|
|
37
|
+
| [inclusionResolvers](./repository.defaultcrudrepository.inclusionresolvers.md) | <code>readonly</code> | Map<string, [InclusionResolver](./repository.inclusionresolver.md)<!-- --><T, [Entity](./repository.entity.md)<!-- -->>> | |
|
|
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) |
|
|
52
|
-
| [createHasManyRepositoryFactoryFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository.createhasmanyrepositoryfactoryfor.md) |
|
|
53
|
-
| [createHasManyThroughRepositoryFactoryFor(relationName, targetRepositoryGetter, throughRepositoryGetter)](./repository.defaultcrudrepository.createhasmanythroughrepositoryfactoryfor.md) |
|
|
54
|
-
| [createHasOneRepositoryFactoryFor(relationName, targetRepositoryGetter)](./repository.defaultcrudrepository.createhasonerepositoryfactoryfor.md) |
|
|
55
|
-
| [createReferencesManyAccessorFor(relationName, targetRepoGetter)](./repository.defaultcrudrepository.createreferencesmanyaccessorfor.md) |
|
|
56
|
-
| [definePersistedModel(entityClass)](./repository.defaultcrudrepository.definepersistedmodel.md) |
|
|
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) |
|
|
61
|
-
| [entityToData(entity, options)](./repository.defaultcrudrepository.entitytodata.md) |
|
|
62
|
-
| [execute(command, parameters, options)](./repository.defaultcrudrepository.execute.md) | | Execute a SQL command
|
|
63
|
-
| [execute(collectionName, command, parameters)](./repository.defaultcrudrepository.execute_1.md) | | Execute a MongoDB command
|
|
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
|
|
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) |
|
|
70
|
-
| [normalizeFilter(filter)](./repository.defaultcrudrepository.normalizefilter.md) |
|
|
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) | | |
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.repository.defaulthasmanyrepository.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class DefaultHasManyRepository<TargetEntity extends Entity, TargetID, TargetRepository extends EntityCrudRepository<TargetEntity, TargetID>> implements HasManyRepository<TargetEntity>
|
|
20
20
|
```
|
|
21
|
-
<b>Implements:</b> [HasManyRepository](./repository.hasmanyrepository.md)
|
|
21
|
+
<b>Implements:</b> [HasManyRepository](./repository.hasmanyrepository.md)<!-- --><TargetEntity>
|
|
22
22
|
|
|
23
23
|
## Constructors
|
|
24
24
|
|
|
@@ -22,7 +22,7 @@ Warning: The hasManyThrough interface is experimental and is subject to change.
|
|
|
22
22
|
```typescript
|
|
23
23
|
export declare class DefaultHasManyThroughRepository<TargetEntity extends Entity, TargetID, TargetRepository extends EntityCrudRepository<TargetEntity, TargetID>, ThroughEntity extends Entity, ThroughID, ThroughRepository extends EntityCrudRepository<ThroughEntity, ThroughID>> implements HasManyThroughRepository<TargetEntity, TargetID, ThroughEntity>
|
|
24
24
|
```
|
|
25
|
-
<b>Implements:</b> [HasManyThroughRepository](./repository.hasmanythroughrepository.md)
|
|
25
|
+
<b>Implements:</b> [HasManyThroughRepository](./repository.hasmanythroughrepository.md)<!-- --><TargetEntity, TargetID, ThroughEntity>
|
|
26
26
|
|
|
27
27
|
## Constructors
|
|
28
28
|
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.repository.defaulthasonerepository.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class DefaultHasOneRepository<TargetEntity extends Entity, TargetID, TargetRepository extends EntityCrudRepository<TargetEntity, TargetID>> implements HasOneRepository<TargetEntity>
|
|
20
20
|
```
|
|
21
|
-
<b>Implements:</b> [HasOneRepository](./repository.hasonerepository.md)
|
|
21
|
+
<b>Implements:</b> [HasOneRepository](./repository.hasonerepository.md)<!-- --><TargetEntity>
|
|
22
22
|
|
|
23
23
|
## Constructors
|
|
24
24
|
|
|
@@ -20,7 +20,7 @@ An implementation of KeyValueRepository based on loopback-datasource-juggler
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare class DefaultKeyValueRepository<T extends Model> implements KeyValueRepository<T>
|
|
22
22
|
```
|
|
23
|
-
<b>Implements:</b> [KeyValueRepository](./repository.keyvaluerepository.md)
|
|
23
|
+
<b>Implements:</b> [KeyValueRepository](./repository.keyvaluerepository.md)<!-- --><T>
|
|
24
24
|
|
|
25
25
|
## Constructors
|
|
26
26
|
|
|
@@ -44,7 +44,7 @@ export declare class DefaultKeyValueRepository<T extends Model> implements KeyVa
|
|
|
44
44
|
| [get(key, options)](./repository.defaultkeyvaluerepository.get.md) | | |
|
|
45
45
|
| [keys(filter, options)](./repository.defaultkeyvaluerepository.keys.md) | | |
|
|
46
46
|
| [set(key, value, options)](./repository.defaultkeyvaluerepository.set.md) | | |
|
|
47
|
-
| [toEntity(modelData)](./repository.defaultkeyvaluerepository.toentity.md) |
|
|
47
|
+
| [toEntity(modelData)](./repository.defaultkeyvaluerepository.toentity.md) | <code>protected</code> | |
|
|
48
48
|
| [ttl(key, options)](./repository.defaultkeyvaluerepository.ttl.md) | | |
|
|
49
49
|
|
|
50
50
|
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.repository.defaultreferencesmanyrepository.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class DefaultReferencesManyRepository<TargetEntity extends Entity, TargetIds, TargetRepository extends EntityCrudRepository<TargetEntity, TargetIds>> implements ReferencesManyRepository<TargetEntity>
|
|
20
20
|
```
|
|
21
|
-
<b>Implements:</b> [ReferencesManyRepository](./repository.referencesmanyrepository.md)
|
|
21
|
+
<b>Implements:</b> [ReferencesManyRepository](./repository.referencesmanyrepository.md)<!-- --><TargetEntity>
|
|
22
22
|
|
|
23
23
|
## Constructors
|
|
24
24
|
|
|
@@ -20,9 +20,9 @@ Default implementation of CRUD repository using legacy juggler model and data so
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare class DefaultTransactionalRepository<T extends Entity, ID, Relations extends object = {}> extends DefaultCrudRepository<T, ID, Relations> implements TransactionalEntityRepository<T, ID, Relations>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)
|
|
23
|
+
<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- --><T, ID, Relations>
|
|
24
24
|
|
|
25
|
-
<b>Implements:</b> [TransactionalEntityRepository](./repository.transactionalentityrepository.md)
|
|
25
|
+
<b>Implements:</b> [TransactionalEntityRepository](./repository.transactionalentityrepository.md)<!-- --><T, ID, Relations>
|
|
26
26
|
|
|
27
27
|
## Methods
|
|
28
28
|
|
|
@@ -20,14 +20,14 @@ CRUD operations for a repository of entities
|
|
|
20
20
|
```typescript
|
|
21
21
|
export interface EntityCrudRepository<T extends Entity, ID, Relations extends object = {}> extends EntityRepository<T, ID>, CrudRepository<T, Relations>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> [EntityRepository](./repository.entityrepository.md)<!-- --><T, ID>, [CrudRepository](./repository.crudrepository.md)
|
|
23
|
+
<b>Extends:</b> [EntityRepository](./repository.entityrepository.md)<!-- --><T, ID>, [CrudRepository](./repository.crudrepository.md)<!-- --><T, Relations>
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [entityClass](./repository.entitycrudrepository.entityclass.md) | typeof [Entity](./repository.entity.md) & { prototype: T; } | |
|
|
30
|
-
| [inclusionResolvers](./repository.entitycrudrepository.inclusionresolvers.md) | Map<string, [InclusionResolver](./repository.inclusionresolver.md)<!-- --><T, [Entity](./repository.entity.md)<!-- -->>> | |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [entityClass](./repository.entitycrudrepository.entityclass.md) | | typeof [Entity](./repository.entity.md) & { prototype: T; } | |
|
|
30
|
+
| [inclusionResolvers](./repository.entitycrudrepository.inclusionresolvers.md) | | Map<string, [InclusionResolver](./repository.inclusionresolver.md)<!-- --><T, [Entity](./repository.entity.md)<!-- -->>> | |
|
|
31
31
|
|
|
32
32
|
## Methods
|
|
33
33
|
|
|
@@ -20,6 +20,6 @@ Base interface for a repository of entities
|
|
|
20
20
|
```typescript
|
|
21
21
|
export interface EntityRepository<T extends Entity, ID> extends ExecutableRepository<T>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> [ExecutableRepository](./repository.executablerepository.md)
|
|
23
|
+
<b>Extends:</b> [ExecutableRepository](./repository.executablerepository.md)<!-- --><T>
|
|
24
24
|
|
|
25
25
|
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.repository.executablerepository.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export interface ExecutableRepository<T extends Model> extends Repository<T>
|
|
20
20
|
```
|
|
21
|
-
<b>Extends:</b> [Repository](./repository.repository.md)
|
|
21
|
+
<b>Extends:</b> [Repository](./repository.repository.md)<!-- --><T>
|
|
22
22
|
|
|
23
23
|
## Methods
|
|
24
24
|
|
|
@@ -24,12 +24,12 @@ export interface HasManyDefinition extends RelationDefinitionBase
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [keyFrom?](./repository.hasmanydefinition.keyfrom.md) | string | <i>(Optional)</i> |
|
|
30
|
-
| [keyTo?](./repository.hasmanydefinition.keyto.md) | string | <i>(Optional)</i> keyTo: The foreign key used by the target model for this relation. keyFrom: The source key used by the source model for this relation
|
|
31
|
-
| [targetsMany](./repository.hasmanydefinition.targetsmany.md) | true | |
|
|
32
|
-
| [through?](./repository.hasmanydefinition.through.md) | { model: [TypeResolver](./repository.typeresolver.md)<!-- --><[Entity](./repository.entity.md)<!-- -->, typeof [Entity](./repository.entity.md)<!-- -->>; keyFrom?: string; keyTo?: string; polymorphic?: boolean \| { discriminator: string; }; } | <i>(Optional)</i> Description of the through model of the hasManyThrough relation
|
|
33
|
-
| [type](./repository.hasmanydefinition.type.md) | [RelationType.hasMany](./repository.relationtype.md) | |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [keyFrom?](./repository.hasmanydefinition.keyfrom.md) | | string | <i>(Optional)</i> |
|
|
30
|
+
| [keyTo?](./repository.hasmanydefinition.keyto.md) | | string | <p><i>(Optional)</i> keyTo: The foreign key used by the target model for this relation. keyFrom: The source key used by the source model for this relation.</p><p>E.g. when a Customer has many Order instances, then keyTo is "customerId". Note that "customerId" is the default FK assumed by the framework, users can provide a custom FK name by setting "keyTo". And Customer.id is keyFrom. keyFrom defaults to the id property of a model. Users can provide a custom source key name by setting "keyTo".</p> |
|
|
31
|
+
| [targetsMany](./repository.hasmanydefinition.targetsmany.md) | | true | |
|
|
32
|
+
| [through?](./repository.hasmanydefinition.through.md) | | { model: [TypeResolver](./repository.typeresolver.md)<!-- --><[Entity](./repository.entity.md)<!-- -->, typeof [Entity](./repository.entity.md)<!-- -->>; keyFrom?: string; keyTo?: string; polymorphic?: boolean \| { discriminator: string; }; } | <p><i>(Optional)</i> Description of the through model of the hasManyThrough relation.</p><p>A <code>hasManyThrough</code> relation defines a many-to-many connection with another model. This relation indicates that the declaring model can be matched with zero or more instances of another model by proceeding through a third model.</p><p>E.g a Category has many Products, and a Product can have many Categories. CategoryProductLink can be the through model. Such a through model has information of foreign keys of the source model(Category) and the target model(Product).</p><p>Warning: The hasManyThrough interface is experimental and is subject to change. If backwards-incompatible changes are made, a new major version may not be released.</p> |
|
|
33
|
+
| [type](./repository.hasmanydefinition.type.md) | | [RelationType.hasMany](./repository.relationtype.md) | |
|
|
34
34
|
|
|
35
35
|
|
|
@@ -21,8 +21,8 @@ export interface HasManyRepositoryFactory<Target extends Entity, ForeignKeyType>
|
|
|
21
21
|
|
|
22
22
|
## Properties
|
|
23
23
|
|
|
24
|
-
| Property | Type | Description |
|
|
25
|
-
| --- | --- | --- |
|
|
26
|
-
| [inclusionResolver](./repository.hasmanyrepositoryfactory.inclusionresolver.md) | [InclusionResolver](./repository.inclusionresolver.md)<!-- --><[Entity](./repository.entity.md)<!-- -->, Target> | Use <code>resolver</code> property to obtain an InclusionResolver for this relation. |
|
|
24
|
+
| Property | Modifiers | Type | Description |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
| [inclusionResolver](./repository.hasmanyrepositoryfactory.inclusionresolver.md) | | [InclusionResolver](./repository.inclusionresolver.md)<!-- --><[Entity](./repository.entity.md)<!-- -->, Target> | Use <code>resolver</code> property to obtain an InclusionResolver for this relation. |
|
|
27
27
|
|
|
28
28
|
|