@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
|
@@ -20,80 +20,80 @@ A mixin class for Application that creates a .repository() function to register
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare function RepositoryMixin<T extends MixinTarget<Application>>(superClass: T): {
|
|
22
22
|
new (...args: any[]): {
|
|
23
|
-
repository<R extends Repository<any>>(repoClass: Class<R>, nameOrOptions?: string | BindingFromClassOptions
|
|
23
|
+
repository<R extends Repository<any>>(repoClass: Class<R>, nameOrOptions?: string | BindingFromClassOptions): Binding<R>;
|
|
24
24
|
getRepository<R_1 extends Repository<any>>(repo: Class<R_1>): Promise<R_1>;
|
|
25
|
-
dataSource<D extends juggler.DataSource>(dataSource: D | Class<D>, nameOrOptions?: string | BindingFromClassOptions
|
|
25
|
+
dataSource<D extends juggler.DataSource>(dataSource: D | Class<D>, nameOrOptions?: string | BindingFromClassOptions): Binding<D>;
|
|
26
26
|
model<M extends Class<unknown>>(modelClass: M): Binding<M>;
|
|
27
|
-
component<C extends Component = Component>(componentCtor: Constructor<C>, nameOrOptions?: string | BindingFromClassOptions
|
|
27
|
+
component<C extends Component = Component>(componentCtor: Constructor<C>, nameOrOptions?: string | BindingFromClassOptions): Binding<C>;
|
|
28
28
|
mountComponentRepositories(componentInstanceOrClass: Class<unknown> | RepositoryComponent): void;
|
|
29
29
|
mountComponentModels(component: RepositoryComponent): void;
|
|
30
30
|
migrateSchema(options?: SchemaMigrationOptions): Promise<void>;
|
|
31
|
-
readonly options:
|
|
31
|
+
readonly options: import("@loopback/core").ApplicationConfig;
|
|
32
32
|
readonly state: string;
|
|
33
|
-
controller: <T_1>(controllerCtor:
|
|
34
|
-
server: <T_2 extends
|
|
35
|
-
servers: <T_3 extends
|
|
36
|
-
getServer: <T_4 extends
|
|
33
|
+
controller: <T_1>(controllerCtor: import("@loopback/core").ControllerClass<T_1>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_1>;
|
|
34
|
+
server: <T_2 extends import("@loopback/core").Server>(ctor: Constructor<T_2>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_2>;
|
|
35
|
+
servers: <T_3 extends import("@loopback/core").Server>(ctors: Constructor<T_3>[]) => Binding<any>[];
|
|
36
|
+
getServer: <T_4 extends import("@loopback/core").Server>(target: string | Constructor<T_4>) => Promise<T_4>;
|
|
37
37
|
init: () => Promise<void>;
|
|
38
|
-
onInit: (fn: () =>
|
|
38
|
+
onInit: (fn: () => import("@loopback/core").ValueOrPromise<void>) => Binding<import("@loopback/core").LifeCycleObserver>;
|
|
39
39
|
start: () => Promise<void>;
|
|
40
|
-
onStart: (fn: () =>
|
|
40
|
+
onStart: (fn: () => import("@loopback/core").ValueOrPromise<void>) => Binding<import("@loopback/core").LifeCycleObserver>;
|
|
41
41
|
stop: () => Promise<void>;
|
|
42
|
-
onStop: (fn: () =>
|
|
43
|
-
setMetadata: (metadata:
|
|
44
|
-
lifeCycleObserver: <T_5 extends
|
|
45
|
-
service: <S>(cls:
|
|
46
|
-
interceptor: (interceptor:
|
|
42
|
+
onStop: (fn: () => import("@loopback/core").ValueOrPromise<void>) => Binding<import("@loopback/core").LifeCycleObserver>;
|
|
43
|
+
setMetadata: (metadata: import("@loopback/core").ApplicationMetadata) => void;
|
|
44
|
+
lifeCycleObserver: <T_5 extends import("@loopback/core").LifeCycleObserver>(ctor: Constructor<T_5>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_5>;
|
|
45
|
+
service: <S>(cls: import("@loopback/core").ServiceOrProviderClass<S>, nameOrOptions?: string | import("@loopback/core").ServiceOptions | undefined) => Binding<S>;
|
|
46
|
+
interceptor: (interceptor: import("@loopback/core").Interceptor | Constructor<import("@loopback/core").Provider<import("@loopback/core").Interceptor>>, nameOrOptions?: string | import("@loopback/core").InterceptorBindingOptions | undefined) => Binding<import("@loopback/core").Interceptor>;
|
|
47
47
|
readonly name: string;
|
|
48
|
-
readonly subscriptionManager:
|
|
48
|
+
readonly subscriptionManager: import("@loopback/core").ContextSubscriptionManager;
|
|
49
49
|
scope: BindingScope;
|
|
50
|
-
readonly parent:
|
|
51
|
-
emitEvent: <T_6 extends
|
|
50
|
+
readonly parent: import("@loopback/core").Context | undefined;
|
|
51
|
+
emitEvent: <T_6 extends import("@loopback/core").ContextEvent>(type: string, event: T_6) => void;
|
|
52
52
|
emitError: (err: unknown) => void;
|
|
53
|
-
bind: <ValueType = any>(key:
|
|
53
|
+
bind: <ValueType = any>(key: import("@loopback/core").BindingAddress<ValueType>) => Binding<ValueType>;
|
|
54
54
|
add: (binding: Binding<unknown>) => Application;
|
|
55
|
-
configure: <ConfigValueType = any>(key?:
|
|
56
|
-
getConfigAsValueOrPromise: <ConfigValueType_1>(key:
|
|
57
|
-
getConfig: <ConfigValueType_2>(key:
|
|
58
|
-
getConfigSync: <ConfigValueType_3>(key:
|
|
59
|
-
unbind: (key:
|
|
60
|
-
subscribe: (observer:
|
|
61
|
-
unsubscribe: (observer:
|
|
55
|
+
configure: <ConfigValueType = any>(key?: import("@loopback/core").BindingAddress<unknown> | undefined) => Binding<ConfigValueType>;
|
|
56
|
+
getConfigAsValueOrPromise: <ConfigValueType_1>(key: import("@loopback/core").BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => import("@loopback/core").ValueOrPromise<ConfigValueType_1 | undefined>;
|
|
57
|
+
getConfig: <ConfigValueType_2>(key: import("@loopback/core").BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => Promise<ConfigValueType_2 | undefined>;
|
|
58
|
+
getConfigSync: <ConfigValueType_3>(key: import("@loopback/core").BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => ConfigValueType_3 | undefined;
|
|
59
|
+
unbind: (key: import("@loopback/core").BindingAddress<unknown>) => boolean;
|
|
60
|
+
subscribe: (observer: import("@loopback/core").ContextEventObserver) => import("@loopback/core").Subscription;
|
|
61
|
+
unsubscribe: (observer: import("@loopback/core").ContextEventObserver) => boolean;
|
|
62
62
|
close: () => void;
|
|
63
|
-
isSubscribed: (observer:
|
|
64
|
-
createView: <T_7 = unknown>(filter:
|
|
65
|
-
contains: (key:
|
|
66
|
-
isBound: (key:
|
|
67
|
-
getOwnerContext: (keyOrBinding:
|
|
68
|
-
getScopedContext: (scope: BindingScope.APPLICATION | BindingScope.SERVER | BindingScope.REQUEST) =>
|
|
69
|
-
getResolutionContext: (binding: Readonly<Binding<unknown>>) =>
|
|
70
|
-
isVisibleTo: (ctx:
|
|
71
|
-
find: <ValueType_1 = any>(pattern?: string | RegExp |
|
|
72
|
-
findByTag: <ValueType_2 = any>(tagFilter: RegExp |
|
|
63
|
+
isSubscribed: (observer: import("@loopback/core").ContextObserver) => boolean;
|
|
64
|
+
createView: <T_7 = unknown>(filter: import("@loopback/core").BindingFilter, comparator?: import("@loopback/core").BindingComparator | undefined, options?: Omit<import("@loopback/core").ResolutionOptions, "session"> | undefined) => import("@loopback/core").ContextView<T_7>;
|
|
65
|
+
contains: (key: import("@loopback/core").BindingAddress<unknown>) => boolean;
|
|
66
|
+
isBound: (key: import("@loopback/core").BindingAddress<unknown>) => boolean;
|
|
67
|
+
getOwnerContext: (keyOrBinding: import("@loopback/core").BindingAddress<unknown> | Readonly<Binding<unknown>>) => import("@loopback/core").Context | undefined;
|
|
68
|
+
getScopedContext: (scope: BindingScope.APPLICATION | BindingScope.SERVER | BindingScope.REQUEST) => import("@loopback/core").Context | undefined;
|
|
69
|
+
getResolutionContext: (binding: Readonly<Binding<unknown>>) => import("@loopback/core").Context | undefined;
|
|
70
|
+
isVisibleTo: (ctx: import("@loopback/core").Context) => boolean;
|
|
71
|
+
find: <ValueType_1 = any>(pattern?: string | RegExp | import("@loopback/core").BindingFilter | undefined) => Readonly<Binding<ValueType_1>>[];
|
|
72
|
+
findByTag: <ValueType_2 = any>(tagFilter: RegExp | import("@loopback/core").BindingTag) => Readonly<Binding<ValueType_2>>[];
|
|
73
73
|
get: {
|
|
74
|
-
<ValueType_3>(keyWithPath:
|
|
75
|
-
<ValueType_4>(keyWithPath:
|
|
74
|
+
<ValueType_3>(keyWithPath: import("@loopback/core").BindingAddress<ValueType_3>, session?: import("@loopback/core").ResolutionSession | undefined): Promise<ValueType_3>;
|
|
75
|
+
<ValueType_4>(keyWithPath: import("@loopback/core").BindingAddress<ValueType_4>, options: import("@loopback/core").ResolutionOptions): Promise<ValueType_4 | undefined>;
|
|
76
76
|
};
|
|
77
77
|
getSync: {
|
|
78
|
-
<ValueType_5>(keyWithPath:
|
|
79
|
-
<ValueType_6>(keyWithPath:
|
|
78
|
+
<ValueType_5>(keyWithPath: import("@loopback/core").BindingAddress<ValueType_5>, session?: import("@loopback/core").ResolutionSession | undefined): ValueType_5;
|
|
79
|
+
<ValueType_6>(keyWithPath: import("@loopback/core").BindingAddress<ValueType_6>, options?: import("@loopback/core").ResolutionOptions | undefined): ValueType_6 | undefined;
|
|
80
80
|
};
|
|
81
81
|
getBinding: {
|
|
82
|
-
<ValueType_7 = any>(key:
|
|
83
|
-
<ValueType_8>(key:
|
|
82
|
+
<ValueType_7 = any>(key: import("@loopback/core").BindingAddress<ValueType_7>): Binding<ValueType_7>;
|
|
83
|
+
<ValueType_8>(key: import("@loopback/core").BindingAddress<ValueType_8>, options?: {
|
|
84
84
|
optional?: boolean | undefined;
|
|
85
85
|
} | undefined): Binding<ValueType_8> | undefined;
|
|
86
86
|
};
|
|
87
|
-
findOrCreateBinding: <T_8>(key:
|
|
88
|
-
getValueOrPromise: <ValueType_9>(keyWithPath:
|
|
89
|
-
toJSON: () =>
|
|
90
|
-
inspect: (options?:
|
|
87
|
+
findOrCreateBinding: <T_8>(key: import("@loopback/core").BindingAddress<T_8>, policy?: import("@loopback/core").BindingCreationPolicy | undefined) => Binding<T_8>;
|
|
88
|
+
getValueOrPromise: <ValueType_9>(keyWithPath: import("@loopback/core").BindingAddress<ValueType_9>, optionsOrSession?: import("@loopback/core").ResolutionOptionsOrSession | undefined) => import("@loopback/core").ValueOrPromise<ValueType_9 | undefined>;
|
|
89
|
+
toJSON: () => import("@loopback/core").JSONObject;
|
|
90
|
+
inspect: (options?: import("@loopback/core").ContextInspectOptions | undefined) => import("@loopback/core").JSONObject;
|
|
91
91
|
on: {
|
|
92
|
-
(eventName: "bind" | "unbind", listener:
|
|
92
|
+
(eventName: "bind" | "unbind", listener: import("@loopback/core").ContextEventListener): Application;
|
|
93
93
|
(event: string | symbol, listener: (...args: any[]) => void): Application;
|
|
94
94
|
};
|
|
95
95
|
once: {
|
|
96
|
-
(eventName: "bind" | "unbind", listener:
|
|
96
|
+
(eventName: "bind" | "unbind", listener: import("@loopback/core").ContextEventListener): Application;
|
|
97
97
|
(event: string | symbol, listener: (...args: any[]) => void): Application;
|
|
98
98
|
};
|
|
99
99
|
addListener: (event: string | symbol, listener: (...args: any[]) => void) => Application;
|
|
@@ -105,7 +105,7 @@ export declare function RepositoryMixin<T extends MixinTarget<Application>>(supe
|
|
|
105
105
|
listeners: (event: string | symbol) => Function[];
|
|
106
106
|
rawListeners: (event: string | symbol) => Function[];
|
|
107
107
|
emit: (event: string | symbol, ...args: any[]) => boolean;
|
|
108
|
-
listenerCount: (
|
|
108
|
+
listenerCount: (event: string | symbol) => number;
|
|
109
109
|
prependListener: (event: string | symbol, listener: (...args: any[]) => void) => Application;
|
|
110
110
|
prependOnceListener: (event: string | symbol, listener: (...args: any[]) => void) => Application;
|
|
111
111
|
eventNames: () => (string | symbol)[];
|
|
@@ -121,7 +121,7 @@ export declare function RepositoryMixin<T extends MixinTarget<Application>>(supe
|
|
|
121
121
|
|
|
122
122
|
<b>Returns:</b>
|
|
123
123
|
|
|
124
|
-
{ new (...args: any\[\]): { repository<R extends [Repository](./repository.repository.md)<!-- --><any>>(repoClass: [Class](./repository.class.md)<!-- --><R>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><R>; getRepository<R\_1 extends [Repository](./repository.repository.md)<!-- --><any>>(repo: [Class](./repository.class.md)<!-- --><R\_1>): Promise<R\_1>; dataSource<D extends juggler.DataSource>(dataSource: D \| [Class](./repository.class.md)<!-- --><D>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><D>; model<M extends [Class](./repository.class.md)<!-- --><unknown>>(modelClass: M): [Binding](./context.binding.md)<!-- --><M>; component<C extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->>(componentCtor: [Constructor](./context.constructor.md)<!-- --><C>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><C>; mountComponentRepositories(componentInstanceOrClass: [Class](./repository.class.md)<!-- --><unknown> \| [RepositoryComponent](./repository.repositorycomponent.md)<!-- -->): void; mountComponentModels(component: [RepositoryComponent](./repository.repositorycomponent.md)<!-- -->): void; migrateSchema(options?: [SchemaMigrationOptions](./repository.schemamigrationoptions.md)<!-- -->): Promise<void>; readonly options: loopbackContext.[ApplicationConfig](./core.applicationconfig.md)<!-- -->; readonly state: string; controller: <T\_1>(controllerCtor: loopbackContext.[ControllerClass](./core.controllerclass.md)<!-- --><T\_1>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_1>; server: <T\_2 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctor: [Constructor](./context.constructor.md)<!-- --><T\_2>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_2>; servers: <T\_3 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctors: [Constructor](./context.constructor.md)<!-- --><T\_3>\[\]) => [Binding](./context.binding.md)<!-- --><any>\[\]; getServer: <T\_4 extends loopbackContext.[Server](./core.server.md)<!-- -->>(target: string \| [Constructor](./context.constructor.md)<!-- --><T\_4>) => Promise<T\_4>; init: () => Promise<void>; onInit: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; start: () => Promise<void>; onStart: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; stop: () => Promise<void>; onStop: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; setMetadata: (metadata: loopbackContext.[ApplicationMetadata](./core.applicationmetadata.md)<!-- -->) => void; lifeCycleObserver: <T\_5 extends loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>(ctor: [Constructor](./context.constructor.md)<!-- --><T\_5>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_5>; service: <S>(cls: loopbackContext.[ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- --><S>, nameOrOptions?: string \| loopbackContext.[ServiceOptions](./core.serviceoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><S>; interceptor: (interceptor: loopbackContext.[Interceptor](./context.interceptor.md) \| [Constructor](./context.constructor.md)<!-- --><loopbackContext.[Provider](./context.provider.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>>, nameOrOptions?: string \| loopbackContext.[InterceptorBindingOptions](./context.interceptorbindingoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>; readonly name: string; readonly subscriptionManager: loopbackContext.[ContextSubscriptionManager](./context.contextsubscriptionmanager.md)<!-- -->; scope: [BindingScope](./context.bindingscope.md)<!-- -->; readonly parent: loopbackContext.[Context](./context.context.md) \| undefined; emitEvent: <T\_6 extends loopbackContext.[ContextEvent](./context.contextevent.md)<!-- -->>(type: string, event: T\_6) => void; emitError: (err: unknown) => void; bind: <ValueType = any>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType>) => [Binding](./context.binding.md)<!-- --><ValueType>; add: (binding: [Binding](./context.binding.md)<!-- --><unknown>) => [Application](./core.application.md)<!-- -->; configure: <ConfigValueType = any>(key?: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| undefined) => [Binding](./context.binding.md)<!-- --><ConfigValueType>; getConfigAsValueOrPromise: <ConfigValueType\_1>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ConfigValueType\_1 \| undefined>; getConfig: <ConfigValueType\_2>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => Promise<ConfigValueType\_2 \| undefined>; getConfigSync: <ConfigValueType\_3>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => ConfigValueType\_3 \| undefined; unbind: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; subscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => loopbackContext.[Subscription](./context.subscription.md)<!-- -->; unsubscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => boolean; close: () => void; isSubscribed: (observer: loopbackContext.[ContextObserver](./context.contextobserver.md)<!-- -->) => boolean; createView: <T\_7 = unknown>(filter: loopbackContext.[BindingFilter](./context.bindingfilter.md)<!-- -->, comparator?: loopbackContext.[BindingComparator](./context.bindingcomparator.md) \| undefined, options?: Omit<loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, "session"> \| undefined) => loopbackContext.[ContextView](./context.contextview.md)<!-- --><T\_7>; contains: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; isBound: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; getOwnerContext: (keyOrBinding: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; getScopedContext: (scope: [BindingScope.APPLICATION](./context.bindingscope.md) \| [BindingScope.SERVER](./context.bindingscope.md) \| [BindingScope.REQUEST](./context.bindingscope.md)<!-- -->) => loopbackContext.[Context](./context.context.md) \| undefined; getResolutionContext: (binding: Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; isVisibleTo: (ctx: loopbackContext.[Context](./context.context.md)<!-- -->) => boolean; find: <ValueType\_1 = any>(pattern?: string \| RegExp \| loopbackContext.[BindingFilter](./context.bindingfilter.md) \| undefined) => Readonly<[Binding](./context.binding.md)<!-- --><ValueType\_1>>\[\]; findByTag: <ValueType\_2 = any>(tagFilter: RegExp \| loopbackContext.[BindingTag](./context.bindingtag.md)<!-- -->) => Readonly<[Binding](./context.binding.md)<!-- --><ValueType\_2>>\[\]; get: { <ValueType\_3>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_3>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): Promise<ValueType\_3>; <ValueType\_4>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_4>, options: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->): Promise<ValueType\_4 \| undefined>; }; getSync: { <ValueType\_5>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_5>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): ValueType\_5; <ValueType\_6>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_6>, options?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined): ValueType\_6 \| undefined; }; getBinding: { <ValueType\_7 = any>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_7>): [Binding](./context.binding.md)<!-- --><ValueType\_7>; <ValueType\_8>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_8>, options?: { optional?: boolean \| undefined; } \| undefined): [Binding](./context.binding.md)<!-- --><ValueType\_8> \| undefined; }; findOrCreateBinding: <T\_8>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><T\_8>, policy?: loopbackContext.[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_8>; getValueOrPromise: <ValueType\_9>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_9>, optionsOrSession?: loopbackContext.[ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ValueType\_9 \| undefined>; toJSON: () => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; inspect: (options?: loopbackContext.[ContextInspectOptions](./context.contextinspectoptions.md) \| undefined) => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; on: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Application](./core.application.md)<!-- -->; }; once: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Application](./core.application.md)<!-- -->; }; addListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; removeListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; off: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; removeAllListeners: (event?: string \| symbol \| undefined) => [Application](./core.application.md)<!-- -->; setMaxListeners: (n: number) => [Application](./core.application.md)<!-- -->; getMaxListeners: () => number; listeners: (event: string \| symbol) => Function\[\]; rawListeners: (event: string \| symbol) => Function\[\]; emit: (event: string \| symbol, ...args: any\[\]) => boolean; listenerCount: (type: string \| symbol) => number; prependListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; prependOnceListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; eventNames: () => (string \| symbol)\[\]; }; } & T
|
|
124
|
+
{ new (...args: any\[\]): { repository<R extends [Repository](./repository.repository.md)<!-- --><any>>(repoClass: [Class](./repository.class.md)<!-- --><R>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md)<!-- -->): [Binding](./context.binding.md)<!-- --><R>; getRepository<R\_1 extends [Repository](./repository.repository.md)<!-- --><any>>(repo: [Class](./repository.class.md)<!-- --><R\_1>): Promise<R\_1>; dataSource<D extends juggler.DataSource>(dataSource: D \| [Class](./repository.class.md)<!-- --><D>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md)<!-- -->): [Binding](./context.binding.md)<!-- --><D>; model<M extends [Class](./repository.class.md)<!-- --><unknown>>(modelClass: M): [Binding](./context.binding.md)<!-- --><M>; component<C extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->>(componentCtor: [Constructor](./context.constructor.md)<!-- --><C>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md)<!-- -->): [Binding](./context.binding.md)<!-- --><C>; mountComponentRepositories(componentInstanceOrClass: [Class](./repository.class.md)<!-- --><unknown> \| [RepositoryComponent](./repository.repositorycomponent.md)<!-- -->): void; mountComponentModels(component: [RepositoryComponent](./repository.repositorycomponent.md)<!-- -->): void; migrateSchema(options?: [SchemaMigrationOptions](./repository.schemamigrationoptions.md)<!-- -->): Promise<void>; readonly options: import("@loopback/core").[ApplicationConfig](./core.applicationconfig.md)<!-- -->; readonly state: string; controller: <T\_1>(controllerCtor: import("@loopback/core").[ControllerClass](./core.controllerclass.md)<!-- --><T\_1>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_1>; server: <T\_2 extends import("@loopback/core").[Server](./core.server.md)<!-- -->>(ctor: [Constructor](./context.constructor.md)<!-- --><T\_2>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_2>; servers: <T\_3 extends import("@loopback/core").[Server](./core.server.md)<!-- -->>(ctors: [Constructor](./context.constructor.md)<!-- --><T\_3>\[\]) => [Binding](./context.binding.md)<!-- --><any>\[\]; getServer: <T\_4 extends import("@loopback/core").[Server](./core.server.md)<!-- -->>(target: string \| [Constructor](./context.constructor.md)<!-- --><T\_4>) => Promise<T\_4>; init: () => Promise<void>; onInit: (fn: () => import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><import("@loopback/core").[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; start: () => Promise<void>; onStart: (fn: () => import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><import("@loopback/core").[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; stop: () => Promise<void>; onStop: (fn: () => import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><import("@loopback/core").[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; setMetadata: (metadata: import("@loopback/core").[ApplicationMetadata](./core.applicationmetadata.md)<!-- -->) => void; lifeCycleObserver: <T\_5 extends import("@loopback/core").[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>(ctor: [Constructor](./context.constructor.md)<!-- --><T\_5>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_5>; service: <S>(cls: import("@loopback/core").[ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- --><S>, nameOrOptions?: string \| import("@loopback/core").[ServiceOptions](./core.serviceoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><S>; interceptor: (interceptor: import("@loopback/core").[Interceptor](./context.interceptor.md) \| [Constructor](./context.constructor.md)<!-- --><import("@loopback/core").[Provider](./context.provider.md)<!-- --><import("@loopback/core").[Interceptor](./context.interceptor.md)<!-- -->>>, nameOrOptions?: string \| import("@loopback/core").[InterceptorBindingOptions](./context.interceptorbindingoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><import("@loopback/core").[Interceptor](./context.interceptor.md)<!-- -->>; readonly name: string; readonly subscriptionManager: import("@loopback/core").[ContextSubscriptionManager](./context.contextsubscriptionmanager.md)<!-- -->; scope: [BindingScope](./context.bindingscope.md)<!-- -->; readonly parent: import("@loopback/core").[Context](./context.context.md) \| undefined; emitEvent: <T\_6 extends import("@loopback/core").[ContextEvent](./context.contextevent.md)<!-- -->>(type: string, event: T\_6) => void; emitError: (err: unknown) => void; bind: <ValueType = any>(key: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType>) => [Binding](./context.binding.md)<!-- --><ValueType>; add: (binding: [Binding](./context.binding.md)<!-- --><unknown>) => [Application](./core.application.md)<!-- -->; configure: <ConfigValueType = any>(key?: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| undefined) => [Binding](./context.binding.md)<!-- --><ConfigValueType>; getConfigAsValueOrPromise: <ConfigValueType\_1>(key: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<!-- --><ConfigValueType\_1 \| undefined>; getConfig: <ConfigValueType\_2>(key: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => Promise<ConfigValueType\_2 \| undefined>; getConfigSync: <ConfigValueType\_3>(key: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => ConfigValueType\_3 \| undefined; unbind: (key: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; subscribe: (observer: import("@loopback/core").[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => import("@loopback/core").[Subscription](./context.subscription.md)<!-- -->; unsubscribe: (observer: import("@loopback/core").[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => boolean; close: () => void; isSubscribed: (observer: import("@loopback/core").[ContextObserver](./context.contextobserver.md)<!-- -->) => boolean; createView: <T\_7 = unknown>(filter: import("@loopback/core").[BindingFilter](./context.bindingfilter.md)<!-- -->, comparator?: import("@loopback/core").[BindingComparator](./context.bindingcomparator.md) \| undefined, options?: Omit<import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, "session"> \| undefined) => import("@loopback/core").[ContextView](./context.contextview.md)<!-- --><T\_7>; contains: (key: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; isBound: (key: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; getOwnerContext: (keyOrBinding: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => import("@loopback/core").[Context](./context.context.md) \| undefined; getScopedContext: (scope: [BindingScope.APPLICATION](./context.bindingscope.md) \| [BindingScope.SERVER](./context.bindingscope.md) \| [BindingScope.REQUEST](./context.bindingscope.md)<!-- -->) => import("@loopback/core").[Context](./context.context.md) \| undefined; getResolutionContext: (binding: Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => import("@loopback/core").[Context](./context.context.md) \| undefined; isVisibleTo: (ctx: import("@loopback/core").[Context](./context.context.md)<!-- -->) => boolean; find: <ValueType\_1 = any>(pattern?: string \| RegExp \| import("@loopback/core").[BindingFilter](./context.bindingfilter.md) \| undefined) => Readonly<[Binding](./context.binding.md)<!-- --><ValueType\_1>>\[\]; findByTag: <ValueType\_2 = any>(tagFilter: RegExp \| import("@loopback/core").[BindingTag](./context.bindingtag.md)<!-- -->) => Readonly<[Binding](./context.binding.md)<!-- --><ValueType\_2>>\[\]; get: { <ValueType\_3>(keyWithPath: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_3>, session?: import("@loopback/core").[ResolutionSession](./context.resolutionsession.md) \| undefined): Promise<ValueType\_3>; <ValueType\_4>(keyWithPath: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_4>, options: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md)<!-- -->): Promise<ValueType\_4 \| undefined>; }; getSync: { <ValueType\_5>(keyWithPath: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_5>, session?: import("@loopback/core").[ResolutionSession](./context.resolutionsession.md) \| undefined): ValueType\_5; <ValueType\_6>(keyWithPath: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_6>, options?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined): ValueType\_6 \| undefined; }; getBinding: { <ValueType\_7 = any>(key: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_7>): [Binding](./context.binding.md)<!-- --><ValueType\_7>; <ValueType\_8>(key: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_8>, options?: { optional?: boolean \| undefined; } \| undefined): [Binding](./context.binding.md)<!-- --><ValueType\_8> \| undefined; }; findOrCreateBinding: <T\_8>(key: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><T\_8>, policy?: import("@loopback/core").[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_8>; getValueOrPromise: <ValueType\_9>(keyWithPath: import("@loopback/core").[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_9>, optionsOrSession?: import("@loopback/core").[ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) \| undefined) => import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<!-- --><ValueType\_9 \| undefined>; toJSON: () => import("@loopback/core").[JSONObject](./context.jsonobject.md)<!-- -->; inspect: (options?: import("@loopback/core").[ContextInspectOptions](./context.contextinspectoptions.md) \| undefined) => import("@loopback/core").[JSONObject](./context.jsonobject.md)<!-- -->; on: { (eventName: "bind" \| "unbind", listener: import("@loopback/core").[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Application](./core.application.md)<!-- -->; }; once: { (eventName: "bind" \| "unbind", listener: import("@loopback/core").[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Application](./core.application.md)<!-- -->; }; addListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; removeListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; off: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; removeAllListeners: (event?: string \| symbol \| undefined) => [Application](./core.application.md)<!-- -->; setMaxListeners: (n: number) => [Application](./core.application.md)<!-- -->; getMaxListeners: () => number; listeners: (event: string \| symbol) => Function\[\]; rawListeners: (event: string \| symbol) => Function\[\]; emit: (event: string \| symbol, ...args: any\[\]) => boolean; listenerCount: (event: string \| symbol) => number; prependListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; prependOnceListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; eventNames: () => (string \| symbol)\[\]; }; } & T
|
|
125
125
|
|
|
126
126
|
A new class that extends the super class with repository related methods
|
|
127
127
|
|
|
@@ -36,7 +36,7 @@ export declare class RepositoryMixinDoc
|
|
|
36
36
|
| [component(component)](./repository.repositorymixindoc.component.md) | | Add a component to this application. Also mounts all the components repositories. |
|
|
37
37
|
| [dataSource(dataSource, name)](./repository.repositorymixindoc.datasource.md) | | Add the dataSource to this application. |
|
|
38
38
|
| [getRepository(repo)](./repository.repositorymixindoc.getrepository.md) | | Retrieve the repository instance from the given Repository class |
|
|
39
|
-
| [migrateSchema(options)](./repository.repositorymixindoc.migrateschema.md) | | Update or recreate the database schema for all repositories
|
|
39
|
+
| [migrateSchema(options)](./repository.repositorymixindoc.migrateschema.md) | | <p>Update or recreate the database schema for all repositories.</p><p>\*\*WARNING\*\*: By default, <code>migrateSchema()</code> will attempt to preserve data while updating the schema in your target database, but this is not guaranteed to be safe.</p><p>Please check the documentation for your specific connector(s) for a detailed breakdown of behaviors for automigrate!</p> |
|
|
40
40
|
| [mountComponentRepository(component)](./repository.repositorymixindoc.mountcomponentrepository.md) | | Get an instance of a component and mount all it's repositories. This function is intended to be used internally by component() |
|
|
41
41
|
| [repository(repo)](./repository.repositorymixindoc.repository.md) | | Add a repository to this application. |
|
|
42
42
|
|
|
@@ -22,9 +22,9 @@ export interface SchemaMigrationOptions extends Options
|
|
|
22
22
|
|
|
23
23
|
## Properties
|
|
24
24
|
|
|
25
|
-
| Property | Type | Description |
|
|
26
|
-
| --- | --- | --- |
|
|
27
|
-
| [existingSchema?](./repository.schemamigrationoptions.existingschema.md) | 'drop' \| 'alter' | <i>(Optional)</i> When set to 'drop', schema migration will drop existing tables and recreate them from scratch, removing any existing data along the way
|
|
28
|
-
| [models?](./repository.schemamigrationoptions.models.md) | string\[\] | <i>(Optional)</i> List of model names to migrate
|
|
25
|
+
| Property | Modifiers | Type | Description |
|
|
26
|
+
| --- | --- | --- | --- |
|
|
27
|
+
| [existingSchema?](./repository.schemamigrationoptions.existingschema.md) | | 'drop' \| 'alter' | <p><i>(Optional)</i> When set to 'drop', schema migration will drop existing tables and recreate them from scratch, removing any existing data along the way.</p><p>When set to 'alter', schema migration will try to preserve current schema and data, and perform a non-destructive incremental update.</p> |
|
|
28
|
+
| [models?](./repository.schemamigrationoptions.models.md) | | string\[\] | <p><i>(Optional)</i> List of model names to migrate.</p><p>By default, all models are migrated.</p> |
|
|
29
29
|
|
|
30
30
|
|
|
@@ -20,13 +20,13 @@ String type
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare class StringType implements Type<string>
|
|
22
22
|
```
|
|
23
|
-
<b>Implements:</b> [Type](./repository.type.md)
|
|
23
|
+
<b>Implements:</b> [Type](./repository.type.md)<!-- --><string>
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
27
|
| Property | Modifiers | Type | Description |
|
|
28
28
|
| --- | --- | --- | --- |
|
|
29
|
-
| [name](./repository.stringtype.name.md) |
|
|
29
|
+
| [name](./repository.stringtype.name.md) | <code>readonly</code> | (not declared) | |
|
|
30
30
|
|
|
31
31
|
## Methods
|
|
32
32
|
|
|
@@ -23,9 +23,9 @@ export interface Transaction
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [id](./repository.transaction.id.md) | string | The transaction Identifier |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [id](./repository.transaction.id.md) | | string | The transaction Identifier |
|
|
29
29
|
|
|
30
30
|
## Methods
|
|
31
31
|
|
|
@@ -20,7 +20,7 @@ Repository Interface for Repositories that support Transactions
|
|
|
20
20
|
```typescript
|
|
21
21
|
export interface TransactionalRepository<T extends Entity> 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
|
|
|
@@ -21,9 +21,9 @@ export interface Type<T>
|
|
|
21
21
|
|
|
22
22
|
## Properties
|
|
23
23
|
|
|
24
|
-
| Property | Type | Description |
|
|
25
|
-
| --- | --- | --- |
|
|
26
|
-
| [name](./repository.type.name.md) | string | Name of the type |
|
|
24
|
+
| Property | Modifiers | Type | Description |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
| [name](./repository.type.name.md) | | string | Name of the type |
|
|
27
27
|
|
|
28
28
|
## Methods
|
|
29
29
|
|
|
@@ -20,7 +20,7 @@ Union type, such as string \| number
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare class UnionType 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
|
## Constructors
|
|
26
26
|
|
|
@@ -33,7 +33,7 @@ export declare class UnionType implements Type<any>
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
35
|
| [itemTypes](./repository.uniontype.itemtypes.md) | | [Type](./repository.type.md)<!-- --><any>\[\] | |
|
|
36
|
-
| [name](./repository.uniontype.name.md) |
|
|
36
|
+
| [name](./repository.uniontype.name.md) | <code>readonly</code> | (not declared) | |
|
|
37
37
|
|
|
38
38
|
## Methods
|
|
39
39
|
|
|
@@ -24,7 +24,7 @@ export declare class CrudRestApiBuilder implements ModelApiBuilder
|
|
|
24
24
|
|
|
25
25
|
| Property | Modifiers | Type | Description |
|
|
26
26
|
| --- | --- | --- | --- |
|
|
27
|
-
| [pattern](./rest-crud.crudrestapibuilder.pattern.md) |
|
|
27
|
+
| [pattern](./rest-crud.crudrestapibuilder.pattern.md) | <code>readonly</code> | string | |
|
|
28
28
|
|
|
29
29
|
## Methods
|
|
30
30
|
|
package/site/apidocs/{rest-crud.crudrestcontroller.create.md → rest-crud.crudrestcontroller.find.md}
RENAMED
|
@@ -1,34 +1,34 @@
|
|
|
1
1
|
---
|
|
2
2
|
lang: en
|
|
3
|
-
title: 'API docs: rest-crud.crudrestcontroller.
|
|
3
|
+
title: 'API docs: rest-crud.crudrestcontroller.find'
|
|
4
4
|
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
|
|
5
5
|
sidebar: lb4_sidebar
|
|
6
6
|
editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest-crud
|
|
7
|
-
permalink: /doc/en/lb4/apidocs.rest-crud.crudrestcontroller.
|
|
7
|
+
permalink: /doc/en/lb4/apidocs.rest-crud.crudrestcontroller.find.html
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
11
11
|
|
|
12
|
-
[Home](./index.md) > [@loopback/rest-crud](./rest-crud.md) > [CrudRestController](./rest-crud.crudrestcontroller.md) > [
|
|
12
|
+
[Home](./index.md) > [@loopback/rest-crud](./rest-crud.md) > [CrudRestController](./rest-crud.crudrestcontroller.md) > [find](./rest-crud.crudrestcontroller.find.md)
|
|
13
13
|
|
|
14
|
-
## CrudRestController.
|
|
14
|
+
## CrudRestController.find() method
|
|
15
15
|
|
|
16
|
-
Implementation of the endpoint `
|
|
16
|
+
Implementation of the endpoint `GET /`<!-- -->.
|
|
17
17
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
|
|
21
|
+
find(filter?: Filter<T>): Promise<(T & Relations)[]>;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
## Parameters
|
|
25
25
|
|
|
26
26
|
| Parameter | Type | Description |
|
|
27
27
|
| --- | --- | --- |
|
|
28
|
-
|
|
|
28
|
+
| filter | [Filter](./filter.filter.md)<!-- --><T> | <i>(Optional)</i> Filter |
|
|
29
29
|
|
|
30
30
|
<b>Returns:</b>
|
|
31
31
|
|
|
32
|
-
Promise<T>
|
|
32
|
+
Promise<(T & Relations)\[\]>
|
|
33
33
|
|
|
34
34
|
|
|
@@ -23,14 +23,14 @@ export interface CrudRestController<T extends Entity, IdType, IdName extends key
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [repository](./rest-crud.crudrestcontroller.repository.md) | [EntityCrudRepository](./repository.entitycrudrepository.md)<!-- --><T, IdType> | The backing repository used to access & modify model data. |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [repository](./rest-crud.crudrestcontroller.repository.md) | <code>readonly</code> | [EntityCrudRepository](./repository.entitycrudrepository.md)<!-- --><T, IdType> | The backing repository used to access & modify model data. |
|
|
29
29
|
|
|
30
30
|
## Methods
|
|
31
31
|
|
|
32
32
|
| Method | Description |
|
|
33
33
|
| --- | --- |
|
|
34
|
-
| [
|
|
34
|
+
| [find(filter)](./rest-crud.crudrestcontroller.find.md) | Implementation of the endpoint <code>GET /</code>. |
|
|
35
35
|
|
|
36
36
|
|
|
@@ -23,8 +23,9 @@ export interface CrudRestControllerOptions
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [basePath](./rest-crud.crudrestcontrolleroptions.basepath.md) | string | The base path where to "mount" the controller. |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [basePath](./rest-crud.crudrestcontrolleroptions.basepath.md) | | string | The base path where to "mount" the controller. |
|
|
29
|
+
| [readonly?](./rest-crud.crudrestcontrolleroptions.readonly.md) | | boolean | <i>(Optional)</i> Whether to generate readonly APIs |
|
|
29
30
|
|
|
30
31
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
lang: en
|
|
3
|
+
title: 'API docs: rest-crud.crudrestcontrolleroptions.readonly'
|
|
4
|
+
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
|
|
5
|
+
sidebar: lb4_sidebar
|
|
6
|
+
editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest-crud
|
|
7
|
+
permalink: /doc/en/lb4/apidocs.rest-crud.crudrestcontrolleroptions.readonly.html
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
11
|
+
|
|
12
|
+
[Home](./index.md) > [@loopback/rest-crud](./rest-crud.md) > [CrudRestControllerOptions](./rest-crud.crudrestcontrolleroptions.md) > [readonly](./rest-crud.crudrestcontrolleroptions.readonly.md)
|
|
13
|
+
|
|
14
|
+
## CrudRestControllerOptions.readonly property
|
|
15
|
+
|
|
16
|
+
Whether to generate readonly APIs
|
|
17
|
+
|
|
18
|
+
<b>Signature:</b>
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
readonly?: boolean;
|
|
22
|
+
```
|
|
23
|
+
|
|
@@ -22,8 +22,9 @@ export interface ModelCrudRestApiConfig extends ModelApiConfig
|
|
|
22
22
|
|
|
23
23
|
## Properties
|
|
24
24
|
|
|
25
|
-
| Property | Type | Description |
|
|
26
|
-
| --- | --- | --- |
|
|
27
|
-
| [basePath](./rest-crud.modelcrudrestapiconfig.basepath.md) | string | |
|
|
25
|
+
| Property | Modifiers | Type | Description |
|
|
26
|
+
| --- | --- | --- | --- |
|
|
27
|
+
| [basePath](./rest-crud.modelcrudrestapiconfig.basepath.md) | | string | |
|
|
28
|
+
| [readonly?](./rest-crud.modelcrudrestapiconfig.readonly.md) | | boolean | <i>(Optional)</i> If true, the generated controller only has find and count APIs |
|
|
28
29
|
|
|
29
30
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
lang: en
|
|
3
|
+
title: 'API docs: rest-crud.modelcrudrestapiconfig.readonly'
|
|
4
|
+
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
|
|
5
|
+
sidebar: lb4_sidebar
|
|
6
|
+
editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest-crud
|
|
7
|
+
permalink: /doc/en/lb4/apidocs.rest-crud.modelcrudrestapiconfig.readonly.html
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
11
|
+
|
|
12
|
+
[Home](./index.md) > [@loopback/rest-crud](./rest-crud.md) > [ModelCrudRestApiConfig](./rest-crud.modelcrudrestapiconfig.md) > [readonly](./rest-crud.modelcrudrestapiconfig.readonly.md)
|
|
13
|
+
|
|
14
|
+
## ModelCrudRestApiConfig.readonly property
|
|
15
|
+
|
|
16
|
+
If true, the generated controller only has find and count APIs
|
|
17
|
+
|
|
18
|
+
<b>Signature:</b>
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
readonly?: boolean;
|
|
22
|
+
```
|
|
23
|
+
|
|
@@ -26,6 +26,6 @@ export declare namespace RestExplorerBindings
|
|
|
26
26
|
| Variable | Description |
|
|
27
27
|
| --- | --- |
|
|
28
28
|
| [COMPONENT](./rest-explorer.restexplorerbindings.component.md) | Binding key for RestExplorerComponent |
|
|
29
|
-
| [CONFIG](./rest-explorer.restexplorerbindings.config.md) | Binding key for configuration of RestExplorerComponent
|
|
29
|
+
| [CONFIG](./rest-explorer.restexplorerbindings.config.md) | <p>Binding key for configuration of RestExplorerComponent.</p><p>We recommend <code>ctx.configure(RestExplorerBindings.COMPONENT)</code> to be used instead of <code>ctx.bind(RestExplorerBindings.CONFIG)</code>.</p> |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -21,10 +21,10 @@ export interface ApiExplorerOptions
|
|
|
21
21
|
|
|
22
22
|
## Properties
|
|
23
23
|
|
|
24
|
-
| Property | Type | Description |
|
|
25
|
-
| --- | --- | --- |
|
|
26
|
-
| [disabled?](./rest.apiexploreroptions.disabled.md) | true | <i>(Optional)</i> Set this flag to disable the built-in redirect to externally hosted API Explorer UI. |
|
|
27
|
-
| [httpUrl?](./rest.apiexploreroptions.httpurl.md) | string | <i>(Optional)</i> URL for the API explorer served over <code>http</code> protocol to deal with mixed content security imposed by browsers as the spec is exposed over <code>http</code> by default. See https://github.com/loopbackio/loopback-next/issues/1603 |
|
|
28
|
-
| [url?](./rest.apiexploreroptions.url.md) | string | <i>(Optional)</i> URL for the hosted API explorer UI default to https://loopback.io/api-explorer |
|
|
24
|
+
| Property | Modifiers | Type | Description |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
| [disabled?](./rest.apiexploreroptions.disabled.md) | | true | <i>(Optional)</i> Set this flag to disable the built-in redirect to externally hosted API Explorer UI. |
|
|
27
|
+
| [httpUrl?](./rest.apiexploreroptions.httpurl.md) | | string | <i>(Optional)</i> URL for the API explorer served over <code>http</code> protocol to deal with mixed content security imposed by browsers as the spec is exposed over <code>http</code> by default. See https://github.com/loopbackio/loopback-next/issues/1603 |
|
|
28
|
+
| [url?](./rest.apiexploreroptions.url.md) | | string | <i>(Optional)</i> URL for the hosted API explorer UI default to https://loopback.io/api-explorer |
|
|
29
29
|
|
|
30
30
|
|
|
@@ -32,9 +32,9 @@ export declare abstract class BaseRoute implements RouteEntry
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [path](./rest.baseroute.path.md) |
|
|
36
|
-
| [spec](./rest.baseroute.spec.md) |
|
|
37
|
-
| [verb](./rest.baseroute.verb.md) |
|
|
35
|
+
| [path](./rest.baseroute.path.md) | <code>readonly</code> | string | |
|
|
36
|
+
| [spec](./rest.baseroute.spec.md) | <code>readonly</code> | OperationObject | |
|
|
37
|
+
| [verb](./rest.baseroute.verb.md) | <code>readonly</code> | string | |
|
|
38
38
|
|
|
39
39
|
## Methods
|
|
40
40
|
|
|
@@ -23,9 +23,9 @@ export interface BodyParser
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [name](./rest.bodyparser.name.md) | string \| symbol | Name of the parser |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [name](./rest.bodyparser.name.md) | | string \| symbol | Name of the parser |
|
|
29
29
|
|
|
30
30
|
## Methods
|
|
31
31
|
|
|
@@ -32,10 +32,10 @@ export declare class ControllerRoute<T> extends BaseRoute
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [\_controllerCtor](./rest.controllerroute._controllerctor.md) |
|
|
36
|
-
| [\_controllerFactory](./rest.controllerroute._controllerfactory.md) |
|
|
37
|
-
| [\_controllerName](./rest.controllerroute._controllername.md) |
|
|
38
|
-
| [\_methodName](./rest.controllerroute._methodname.md) |
|
|
35
|
+
| [\_controllerCtor](./rest.controllerroute._controllerctor.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [ControllerClass](./rest.controllerclass.md)<!-- --><T> | |
|
|
36
|
+
| [\_controllerFactory](./rest.controllerroute._controllerfactory.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [ControllerFactory](./rest.controllerfactory.md)<!-- --><T> | |
|
|
37
|
+
| [\_controllerName](./rest.controllerroute._controllername.md) | <p><code>protected</code></p><p><code>readonly</code></p> | string | |
|
|
38
|
+
| [\_methodName](./rest.controllerroute._methodname.md) | <p><code>protected</code></p><p><code>readonly</code></p> | string | |
|
|
39
39
|
|
|
40
40
|
## Methods
|
|
41
41
|
|
|
@@ -46,10 +46,10 @@ app.bind(CoreBindings.SEQUENCE).toClass(MySequence);
|
|
|
46
46
|
|
|
47
47
|
| Property | Modifiers | Type | Description |
|
|
48
48
|
| --- | --- | --- | --- |
|
|
49
|
-
| [findRoute](./rest.defaultsequence.findroute.md) |
|
|
50
|
-
| [invoke](./rest.defaultsequence.invoke.md) |
|
|
51
|
-
| [invokeMiddleware](./rest.defaultsequence.invokemiddleware.md) |
|
|
52
|
-
| [parseParams](./rest.defaultsequence.parseparams.md) |
|
|
49
|
+
| [findRoute](./rest.defaultsequence.findroute.md) | <code>protected</code> | [FindRoute](./rest.findroute.md) | |
|
|
50
|
+
| [invoke](./rest.defaultsequence.invoke.md) | <code>protected</code> | [InvokeMethod](./rest.invokemethod.md) | |
|
|
51
|
+
| [invokeMiddleware](./rest.defaultsequence.invokemiddleware.md) | <code>protected</code> | [InvokeMiddleware](./express.invokemiddleware.md) | Optional invoker for registered middleware in a chain. To be injected via SequenceActions.INVOKE\_MIDDLEWARE. |
|
|
52
|
+
| [parseParams](./rest.defaultsequence.parseparams.md) | <code>protected</code> | [ParseParams](./rest.parseparams.md) | |
|
|
53
53
|
| [reject](./rest.defaultsequence.reject.md) | | [Reject](./rest.reject.md) | |
|
|
54
54
|
| [send](./rest.defaultsequence.send.md) | | [Send](./rest.send.md) | |
|
|
55
55
|
|
|
@@ -57,6 +57,6 @@ app.bind(CoreBindings.SEQUENCE).toClass(MySequence);
|
|
|
57
57
|
|
|
58
58
|
| Method | Modifiers | Description |
|
|
59
59
|
| --- | --- | --- |
|
|
60
|
-
| [handle(context)](./rest.defaultsequence.handle.md) | | Runs the default sequence. Given a handler context (request and response), running the sequence will produce a response or an error
|
|
60
|
+
| [handle(context)](./rest.defaultsequence.handle.md) | | <p>Runs the default sequence. Given a handler context (request and response), running the sequence will produce a response or an error.</p><p>Default sequence executes these steps - Executes middleware for CORS, OpenAPI spec endpoints - Finds the appropriate controller method, swagger spec and args for invocation - Parses HTTP request to get API argument list - Invokes the API which is defined in the Application Controller - Writes the result from API into the HTTP response - Error is caught and logged using 'logError' if any of the above steps in the sequence fails with an error.</p> |
|
|
61
61
|
|
|
62
62
|
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.rest.findroutemiddlewareprovider.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class FindRouteMiddlewareProvider implements Provider<Middleware>
|
|
20
20
|
```
|
|
21
|
-
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[Middleware](./express.middleware.md)
|
|
21
|
+
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->>
|
|
22
22
|
|
|
23
23
|
## Methods
|
|
24
24
|
|