@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
|
@@ -23,12 +23,12 @@ export interface InvokeMiddlewareOptions
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [chain?](./express.invokemiddlewareoptions.chain.md) | string | <i>(Optional)</i> Name of the extension point. Default to the <code>extensionPoint</code> tag value from the binding |
|
|
29
|
-
| [middlewareList?](./express.invokemiddlewareoptions.middlewarelist.md) | [MiddlewareOrKey](./express.middlewareorkey.md)<!-- -->\[\] | <i>(Optional)</i> Pre-built middleware list. If set, the list will be used to create the middleware chain without discovering again within the context. |
|
|
30
|
-
| [next?](./express.invokemiddlewareoptions.next.md) | [Next](./context.next.md) | <i>(Optional)</i> Optional next handler |
|
|
31
|
-
| [orderedGroups?](./express.invokemiddlewareoptions.orderedgroups.md) | string\[\] | <i>(Optional)</i> An array of group names to denote the order of execution, such as <code>['cors', 'caching', 'rate-limiting']</code>. |
|
|
32
|
-
| [validate?](./express.invokemiddlewareoptions.validate.md) | (groups: string\[\]) => void | <i>(Optional)</i> An optional function to validate the sorted groups before invoking the middleware chain |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [chain?](./express.invokemiddlewareoptions.chain.md) | | string | <i>(Optional)</i> Name of the extension point. Default to the <code>extensionPoint</code> tag value from the binding |
|
|
29
|
+
| [middlewareList?](./express.invokemiddlewareoptions.middlewarelist.md) | | [MiddlewareOrKey](./express.middlewareorkey.md)<!-- -->\[\] | <i>(Optional)</i> Pre-built middleware list. If set, the list will be used to create the middleware chain without discovering again within the context. |
|
|
30
|
+
| [next?](./express.invokemiddlewareoptions.next.md) | | [Next](./context.next.md) | <i>(Optional)</i> Optional next handler |
|
|
31
|
+
| [orderedGroups?](./express.invokemiddlewareoptions.orderedgroups.md) | | string\[\] | <i>(Optional)</i> An array of group names to denote the order of execution, such as <code>['cors', 'caching', 'rate-limiting']</code>. |
|
|
32
|
+
| [validate?](./express.invokemiddlewareoptions.validate.md) | | (groups: string\[\]) => void | <i>(Optional)</i> An optional function to validate the sorted groups before invoking the middleware chain |
|
|
33
33
|
|
|
34
34
|
|
|
@@ -20,7 +20,7 @@ Interface LoopBack 4 middleware to be executed within sequence of actions. A mid
|
|
|
20
20
|
```typescript
|
|
21
21
|
export interface Middleware extends GenericInterceptor<MiddlewareContext>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> [GenericInterceptor](./context.genericinterceptor.md)<!-- --><[MiddlewareContext](./express.middlewarecontext.md)
|
|
23
|
+
<b>Extends:</b> [GenericInterceptor](./context.genericinterceptor.md)<!-- --><[MiddlewareContext](./express.middlewarecontext.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
## Remarks
|
|
26
26
|
|
|
@@ -20,14 +20,14 @@ Options to bind middleware as a request context based interceptor within an `Inv
|
|
|
20
20
|
```typescript
|
|
21
21
|
export interface MiddlewareBindingOptions extends BaseMiddlewareBindingOptions<MiddlewareContext>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> [BaseMiddlewareBindingOptions](./express.basemiddlewarebindingoptions.md)<!-- --><[MiddlewareContext](./express.middlewarecontext.md)
|
|
23
|
+
<b>Extends:</b> [BaseMiddlewareBindingOptions](./express.basemiddlewarebindingoptions.md)<!-- --><[MiddlewareContext](./express.middlewarecontext.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [chain?](./express.middlewarebindingoptions.chain.md) | string | <i>(Optional)</i> Name of the middleware extension point. Default to <code>DEFAULT_MIDDLEWARE_CHAIN</code>. |
|
|
30
|
-
| [downstreamGroups?](./express.middlewarebindingoptions.downstreamgroups.md) | string \| string\[\] | <i>(Optional)</i> An array of group names for downstream middleware in the cascading order
|
|
31
|
-
| [upstreamGroups?](./express.middlewarebindingoptions.upstreamgroups.md) | string \| string\[\] | <i>(Optional)</i> An array of group names for upstream middleware in the cascading order
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [chain?](./express.middlewarebindingoptions.chain.md) | | string | <i>(Optional)</i> Name of the middleware extension point. Default to <code>DEFAULT_MIDDLEWARE_CHAIN</code>. |
|
|
30
|
+
| [downstreamGroups?](./express.middlewarebindingoptions.downstreamgroups.md) | | string \| string\[\] | <p><i>(Optional)</i> An array of group names for downstream middleware in the cascading order.</p><p>For example, the <code>sendResponse</code> depends on <code>invokeMethod</code> for response processing. The <code>downstreamGroups</code> for <code>sendResponse</code> should be <code>['invokeMethod']</code>. The order of groups in the array does not matter.</p> |
|
|
31
|
+
| [upstreamGroups?](./express.middlewarebindingoptions.upstreamgroups.md) | | string \| string\[\] | <p><i>(Optional)</i> An array of group names for upstream middleware in the cascading order.</p><p>For example, the <code>invokeMethod</code> depends on <code>parseParams</code> for request processing. The <code>upstreamGroups</code> for <code>invokeMethod</code> should be <code>['parseParams']</code>. The order of groups in the array does not matter.</p> |
|
|
32
32
|
|
|
33
33
|
|
|
@@ -20,6 +20,6 @@ An interceptor chain of middleware. This represents a list of cascading middlewa
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare class MiddlewareChain extends GenericInterceptorChain<MiddlewareContext>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> [GenericInterceptorChain](./context.genericinterceptorchain.md)<!-- --><[MiddlewareContext](./express.middlewarecontext.md)
|
|
23
|
+
<b>Extends:</b> [GenericInterceptorChain](./context.genericinterceptorchain.md)<!-- --><[MiddlewareContext](./express.middlewarecontext.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
|
|
@@ -34,14 +34,14 @@ export declare class MiddlewareContext extends Context implements HandlerContext
|
|
|
34
34
|
|
|
35
35
|
| Property | Modifiers | Type | Description |
|
|
36
36
|
| --- | --- | --- | --- |
|
|
37
|
-
| [request](./express.middlewarecontext.request.md) |
|
|
38
|
-
| [response](./express.middlewarecontext.response.md) |
|
|
37
|
+
| [request](./express.middlewarecontext.request.md) | <code>readonly</code> | Request | |
|
|
38
|
+
| [response](./express.middlewarecontext.response.md) | <code>readonly</code> | Response | |
|
|
39
39
|
| [responseFinished](./express.middlewarecontext.responsefinished.md) | | boolean | A flag to tell if the response is finished. |
|
|
40
40
|
|
|
41
41
|
## Methods
|
|
42
42
|
|
|
43
43
|
| Method | Modifiers | Description |
|
|
44
44
|
| --- | --- | --- |
|
|
45
|
-
| [setupBindings()](./express.middlewarecontext.setupbindings.md) |
|
|
45
|
+
| [setupBindings()](./express.middlewarecontext.setupbindings.md) | <code>protected</code> | |
|
|
46
46
|
|
|
47
47
|
|
|
@@ -23,9 +23,9 @@ export interface MiddlewareCreationOptions
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [injectConfiguration?](./express.middlewarecreationoptions.injectconfiguration.md) | boolean \| 'watch' | <i>(Optional)</i> A flag to control if configuration for the middleware can be injected lazily
|
|
29
|
-
| [providerClassName?](./express.middlewarecreationoptions.providerclassname.md) | string | <i>(Optional)</i> Class name for the created provider class. It's only used if <code>injectConfiguration</code> is not set to <code>false</code>. |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [injectConfiguration?](./express.middlewarecreationoptions.injectconfiguration.md) | | boolean \| 'watch' | <p><i>(Optional)</i> A flag to control if configuration for the middleware can be injected lazily.</p><p>- <code>true</code> (default): creates a provider class with <code>@config</code> - <code>false</code>: No configuration injection is supported - 'watch': creates a provider class with <code>@config.view</code></p> |
|
|
29
|
+
| [providerClassName?](./express.middlewarecreationoptions.providerclassname.md) | | string | <i>(Optional)</i> Class name for the created provider class. It's only used if <code>injectConfiguration</code> is not set to <code>false</code>. |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -20,12 +20,12 @@ Options to bind a middleware as an interceptor to the context
|
|
|
20
20
|
```typescript
|
|
21
21
|
export interface MiddlewareInterceptorBindingOptions extends BaseMiddlewareBindingOptions<InvocationContext>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> [BaseMiddlewareBindingOptions](./express.basemiddlewarebindingoptions.md)<!-- --><[InvocationContext](./context.invocationcontext.md)
|
|
23
|
+
<b>Extends:</b> [BaseMiddlewareBindingOptions](./express.basemiddlewarebindingoptions.md)<!-- --><[InvocationContext](./context.invocationcontext.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [global?](./express.middlewareinterceptorbindingoptions.global.md) | boolean | <i>(Optional)</i> A flag to control if the interceptor should be global. Default to <code>true</code>. |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [global?](./express.middlewareinterceptorbindingoptions.global.md) | | boolean | <i>(Optional)</i> A flag to control if the interceptor should be global. Default to <code>true</code>. |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -18,43 +18,43 @@ permalink: /doc/en/lb4/apidocs.express.middlewaremixin.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare function MiddlewareMixin<T extends MixinTarget<Context>>(superClass: T): {
|
|
20
20
|
new (...args: any[]): {
|
|
21
|
-
expressMiddleware(key: BindingAddress, middleware: ExpressRequestHandler | ExpressRequestHandler[], options?: MiddlewareBindingOptions
|
|
22
|
-
expressMiddleware<CFG>(middlewareFactory: ExpressMiddlewareFactory<CFG>, middlewareConfig?: CFG | undefined, options?: MiddlewareBindingOptions
|
|
23
|
-
expressMiddleware<CFG_1>(factoryOrKey: BindingAddress<Middleware> | ExpressMiddlewareFactory<CFG_1>, configOrHandler: ExpressRequestHandler | ExpressRequestHandler[] | CFG_1, options?: MiddlewareBindingOptions
|
|
21
|
+
expressMiddleware(key: BindingAddress, middleware: ExpressRequestHandler | ExpressRequestHandler[], options?: MiddlewareBindingOptions): Binding<Middleware>;
|
|
22
|
+
expressMiddleware<CFG>(middlewareFactory: ExpressMiddlewareFactory<CFG>, middlewareConfig?: CFG | undefined, options?: MiddlewareBindingOptions): Binding<Middleware>;
|
|
23
|
+
expressMiddleware<CFG_1>(factoryOrKey: BindingAddress<Middleware> | ExpressMiddlewareFactory<CFG_1>, configOrHandler: ExpressRequestHandler | ExpressRequestHandler[] | CFG_1, options?: MiddlewareBindingOptions): Binding<Middleware>;
|
|
24
24
|
middleware(middleware: Middleware | Constructor<Provider<Middleware>>, options?: MiddlewareBindingOptions): Binding<Middleware>;
|
|
25
25
|
readonly name: string;
|
|
26
|
-
readonly subscriptionManager:
|
|
27
|
-
scope:
|
|
26
|
+
readonly subscriptionManager: import("@loopback/core").ContextSubscriptionManager;
|
|
27
|
+
scope: import("@loopback/core").BindingScope;
|
|
28
28
|
readonly parent: Context | undefined;
|
|
29
|
-
emitEvent: <T_1 extends
|
|
29
|
+
emitEvent: <T_1 extends import("@loopback/core").ContextEvent>(type: string, event: T_1) => void;
|
|
30
30
|
emitError: (err: unknown) => void;
|
|
31
31
|
bind: <ValueType = any>(key: BindingAddress<ValueType>) => Binding<ValueType>;
|
|
32
32
|
add: (binding: Binding<unknown>) => Context;
|
|
33
33
|
configure: <ConfigValueType = any>(key?: BindingAddress<unknown> | undefined) => Binding<ConfigValueType>;
|
|
34
|
-
getConfigAsValueOrPromise: <ConfigValueType_1>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?:
|
|
35
|
-
getConfig: <ConfigValueType_2>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?:
|
|
36
|
-
getConfigSync: <ConfigValueType_3>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?:
|
|
34
|
+
getConfigAsValueOrPromise: <ConfigValueType_1>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => import("@loopback/core").ValueOrPromise<ConfigValueType_1 | undefined>;
|
|
35
|
+
getConfig: <ConfigValueType_2>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => Promise<ConfigValueType_2 | undefined>;
|
|
36
|
+
getConfigSync: <ConfigValueType_3>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => ConfigValueType_3 | undefined;
|
|
37
37
|
unbind: (key: BindingAddress<unknown>) => boolean;
|
|
38
|
-
subscribe: (observer:
|
|
39
|
-
unsubscribe: (observer:
|
|
38
|
+
subscribe: (observer: import("@loopback/core").ContextEventObserver) => import("@loopback/core").Subscription;
|
|
39
|
+
unsubscribe: (observer: import("@loopback/core").ContextEventObserver) => boolean;
|
|
40
40
|
close: () => void;
|
|
41
|
-
isSubscribed: (observer:
|
|
42
|
-
createView: <T_2 = unknown>(filter:
|
|
41
|
+
isSubscribed: (observer: import("@loopback/core").ContextObserver) => boolean;
|
|
42
|
+
createView: <T_2 = 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_2>;
|
|
43
43
|
contains: (key: BindingAddress<unknown>) => boolean;
|
|
44
44
|
isBound: (key: BindingAddress<unknown>) => boolean;
|
|
45
45
|
getOwnerContext: (keyOrBinding: BindingAddress<unknown> | Readonly<Binding<unknown>>) => Context | undefined;
|
|
46
|
-
getScopedContext: (scope:
|
|
46
|
+
getScopedContext: (scope: import("@loopback/core").BindingScope.APPLICATION | import("@loopback/core").BindingScope.SERVER | import("@loopback/core").BindingScope.REQUEST) => Context | undefined;
|
|
47
47
|
getResolutionContext: (binding: Readonly<Binding<unknown>>) => Context | undefined;
|
|
48
48
|
isVisibleTo: (ctx: Context) => boolean;
|
|
49
|
-
find: <ValueType_1 = any>(pattern?: string | RegExp |
|
|
50
|
-
findByTag: <ValueType_2 = any>(tagFilter: RegExp |
|
|
49
|
+
find: <ValueType_1 = any>(pattern?: string | RegExp | import("@loopback/core").BindingFilter | undefined) => Readonly<Binding<ValueType_1>>[];
|
|
50
|
+
findByTag: <ValueType_2 = any>(tagFilter: RegExp | import("@loopback/core").BindingTag) => Readonly<Binding<ValueType_2>>[];
|
|
51
51
|
get: {
|
|
52
|
-
<ValueType_3>(keyWithPath: BindingAddress<ValueType_3>, session?:
|
|
53
|
-
<ValueType_4>(keyWithPath: BindingAddress<ValueType_4>, options:
|
|
52
|
+
<ValueType_3>(keyWithPath: BindingAddress<ValueType_3>, session?: import("@loopback/core").ResolutionSession | undefined): Promise<ValueType_3>;
|
|
53
|
+
<ValueType_4>(keyWithPath: BindingAddress<ValueType_4>, options: import("@loopback/core").ResolutionOptions): Promise<ValueType_4 | undefined>;
|
|
54
54
|
};
|
|
55
55
|
getSync: {
|
|
56
|
-
<ValueType_5>(keyWithPath: BindingAddress<ValueType_5>, session?:
|
|
57
|
-
<ValueType_6>(keyWithPath: BindingAddress<ValueType_6>, options?:
|
|
56
|
+
<ValueType_5>(keyWithPath: BindingAddress<ValueType_5>, session?: import("@loopback/core").ResolutionSession | undefined): ValueType_5;
|
|
57
|
+
<ValueType_6>(keyWithPath: BindingAddress<ValueType_6>, options?: import("@loopback/core").ResolutionOptions | undefined): ValueType_6 | undefined;
|
|
58
58
|
};
|
|
59
59
|
getBinding: {
|
|
60
60
|
<ValueType_7 = any>(key: BindingAddress<ValueType_7>): Binding<ValueType_7>;
|
|
@@ -62,16 +62,16 @@ export declare function MiddlewareMixin<T extends MixinTarget<Context>>(superCla
|
|
|
62
62
|
optional?: boolean | undefined;
|
|
63
63
|
} | undefined): Binding<ValueType_8> | undefined;
|
|
64
64
|
};
|
|
65
|
-
findOrCreateBinding: <T_3>(key: BindingAddress<T_3>, policy?:
|
|
66
|
-
getValueOrPromise: <ValueType_9>(keyWithPath: BindingAddress<ValueType_9>, optionsOrSession?:
|
|
67
|
-
toJSON: () =>
|
|
68
|
-
inspect: (options?:
|
|
65
|
+
findOrCreateBinding: <T_3>(key: BindingAddress<T_3>, policy?: import("@loopback/core").BindingCreationPolicy | undefined) => Binding<T_3>;
|
|
66
|
+
getValueOrPromise: <ValueType_9>(keyWithPath: BindingAddress<ValueType_9>, optionsOrSession?: import("@loopback/core").ResolutionOptionsOrSession | undefined) => import("@loopback/core").ValueOrPromise<ValueType_9 | undefined>;
|
|
67
|
+
toJSON: () => import("@loopback/core").JSONObject;
|
|
68
|
+
inspect: (options?: import("@loopback/core").ContextInspectOptions | undefined) => import("@loopback/core").JSONObject;
|
|
69
69
|
on: {
|
|
70
|
-
(eventName: "bind" | "unbind", listener:
|
|
70
|
+
(eventName: "bind" | "unbind", listener: import("@loopback/core").ContextEventListener): Context;
|
|
71
71
|
(event: string | symbol, listener: (...args: any[]) => void): Context;
|
|
72
72
|
};
|
|
73
73
|
once: {
|
|
74
|
-
(eventName: "bind" | "unbind", listener:
|
|
74
|
+
(eventName: "bind" | "unbind", listener: import("@loopback/core").ContextEventListener): Context;
|
|
75
75
|
(event: string | symbol, listener: (...args: any[]) => void): Context;
|
|
76
76
|
};
|
|
77
77
|
addListener: (event: string | symbol, listener: (...args: any[]) => void) => Context;
|
|
@@ -83,7 +83,7 @@ export declare function MiddlewareMixin<T extends MixinTarget<Context>>(superCla
|
|
|
83
83
|
listeners: (event: string | symbol) => Function[];
|
|
84
84
|
rawListeners: (event: string | symbol) => Function[];
|
|
85
85
|
emit: (event: string | symbol, ...args: any[]) => boolean;
|
|
86
|
-
listenerCount: (
|
|
86
|
+
listenerCount: (event: string | symbol) => number;
|
|
87
87
|
prependListener: (event: string | symbol, listener: (...args: any[]) => void) => Context;
|
|
88
88
|
prependOnceListener: (event: string | symbol, listener: (...args: any[]) => void) => Context;
|
|
89
89
|
eventNames: () => (string | symbol)[];
|
|
@@ -99,6 +99,6 @@ export declare function MiddlewareMixin<T extends MixinTarget<Context>>(superCla
|
|
|
99
99
|
|
|
100
100
|
<b>Returns:</b>
|
|
101
101
|
|
|
102
|
-
{ new (...args: any\[\]): { expressMiddleware(key: [BindingAddress](./context.bindingaddress.md)<!-- -->, middleware: [ExpressRequestHandler](./express.expressrequesthandler.md) \| [ExpressRequestHandler](./express.expressrequesthandler.md)<!-- -->\[\], options?: [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->>; expressMiddleware<CFG>(middlewareFactory: [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- --><CFG>, middlewareConfig?: CFG \| undefined, options?: [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->>; expressMiddleware<CFG\_1>(factoryOrKey: [BindingAddress](./context.bindingaddress.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->> \| [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- --><CFG\_1>, configOrHandler: [ExpressRequestHandler](./express.expressrequesthandler.md) \| [ExpressRequestHandler](./express.expressrequesthandler.md)<!-- -->\[\] \| CFG\_1, options?: [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->>; middleware(middleware: [Middleware](./express.middleware.md) \| [Constructor](./context.constructor.md)<!-- --><[Provider](./context.provider.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->>>, options?: [MiddlewareBindingOptions](./express.middlewarebindingoptions.md)<!-- -->): [Binding](./context.binding.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->>; readonly name: string; readonly subscriptionManager: loopbackContext.[ContextSubscriptionManager](./context.contextsubscriptionmanager.md)<!-- -->; scope: loopbackContext.[BindingScope](./context.bindingscope.md)<!-- -->; readonly parent: [Context](./context.context.md) \| undefined; emitEvent: <T\_1 extends loopbackContext.[ContextEvent](./context.contextevent.md)<!-- -->>(type: string, event: T\_1) => void; emitError: (err: unknown) => void; bind: <ValueType = any>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType>) => [Binding](./context.binding.md)<!-- --><ValueType>; add: (binding: [Binding](./context.binding.md)<!-- --><unknown>) => [Context](./context.context.md)<!-- -->; configure: <ConfigValueType = any>(key?: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| undefined) => [Binding](./context.binding.md)<!-- --><ConfigValueType>; getConfigAsValueOrPromise: <ConfigValueType\_1>(key: [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: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => Promise<ConfigValueType\_2 \| undefined>; getConfigSync: <ConfigValueType\_3>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => ConfigValueType\_3 \| undefined; unbind: (key: [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\_2 = 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\_2>; contains: (key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; isBound: (key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; getOwnerContext: (keyOrBinding: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => [Context](./context.context.md) \| undefined; getScopedContext: (scope: loopbackContext.[BindingScope.APPLICATION](./context.bindingscope.md) \| loopbackContext.[BindingScope.SERVER](./context.bindingscope.md) \| loopbackContext.[BindingScope.REQUEST](./context.bindingscope.md)<!-- -->) => [Context](./context.context.md) \| undefined; getResolutionContext: (binding: Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => [Context](./context.context.md) \| undefined; isVisibleTo: (ctx: [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: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_3>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): Promise<ValueType\_3>; <ValueType\_4>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_4>, options: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->): Promise<ValueType\_4 \| undefined>; }; getSync: { <ValueType\_5>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_5>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): ValueType\_5; <ValueType\_6>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_6>, options?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined): ValueType\_6 \| undefined; }; getBinding: { <ValueType\_7 = any>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_7>): [Binding](./context.binding.md)<!-- --><ValueType\_7>; <ValueType\_8>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_8>, options?: { optional?: boolean \| undefined; } \| undefined): [Binding](./context.binding.md)<!-- --><ValueType\_8> \| undefined; }; findOrCreateBinding: <T\_3>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><T\_3>, policy?: loopbackContext.[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_3>; getValueOrPromise: <ValueType\_9>(keyWithPath: [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)<!-- -->): [Context](./context.context.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Context](./context.context.md)<!-- -->; }; once: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Context](./context.context.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Context](./context.context.md)<!-- -->; }; addListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Context](./context.context.md)<!-- -->; removeListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Context](./context.context.md)<!-- -->; off: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Context](./context.context.md)<!-- -->; removeAllListeners: (event?: string \| symbol \| undefined) => [Context](./context.context.md)<!-- -->; setMaxListeners: (n: number) => [Context](./context.context.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) => [Context](./context.context.md)<!-- -->; prependOnceListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Context](./context.context.md)<!-- -->; eventNames: () => (string \| symbol)\[\]; }; } & T
|
|
102
|
+
{ new (...args: any\[\]): { expressMiddleware(key: [BindingAddress](./context.bindingaddress.md)<!-- -->, middleware: [ExpressRequestHandler](./express.expressrequesthandler.md) \| [ExpressRequestHandler](./express.expressrequesthandler.md)<!-- -->\[\], options?: [MiddlewareBindingOptions](./express.middlewarebindingoptions.md)<!-- -->): [Binding](./context.binding.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->>; expressMiddleware<CFG>(middlewareFactory: [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- --><CFG>, middlewareConfig?: CFG \| undefined, options?: [MiddlewareBindingOptions](./express.middlewarebindingoptions.md)<!-- -->): [Binding](./context.binding.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->>; expressMiddleware<CFG\_1>(factoryOrKey: [BindingAddress](./context.bindingaddress.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->> \| [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- --><CFG\_1>, configOrHandler: [ExpressRequestHandler](./express.expressrequesthandler.md) \| [ExpressRequestHandler](./express.expressrequesthandler.md)<!-- -->\[\] \| CFG\_1, options?: [MiddlewareBindingOptions](./express.middlewarebindingoptions.md)<!-- -->): [Binding](./context.binding.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->>; middleware(middleware: [Middleware](./express.middleware.md) \| [Constructor](./context.constructor.md)<!-- --><[Provider](./context.provider.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->>>, options?: [MiddlewareBindingOptions](./express.middlewarebindingoptions.md)<!-- -->): [Binding](./context.binding.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->>; readonly name: string; readonly subscriptionManager: import("@loopback/core").[ContextSubscriptionManager](./context.contextsubscriptionmanager.md)<!-- -->; scope: import("@loopback/core").[BindingScope](./context.bindingscope.md)<!-- -->; readonly parent: [Context](./context.context.md) \| undefined; emitEvent: <T\_1 extends import("@loopback/core").[ContextEvent](./context.contextevent.md)<!-- -->>(type: string, event: T\_1) => void; emitError: (err: unknown) => void; bind: <ValueType = any>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType>) => [Binding](./context.binding.md)<!-- --><ValueType>; add: (binding: [Binding](./context.binding.md)<!-- --><unknown>) => [Context](./context.context.md)<!-- -->; configure: <ConfigValueType = any>(key?: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| undefined) => [Binding](./context.binding.md)<!-- --><ConfigValueType>; getConfigAsValueOrPromise: <ConfigValueType\_1>(key: [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: [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: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => ConfigValueType\_3 \| undefined; unbind: (key: [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\_2 = 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\_2>; contains: (key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; isBound: (key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; getOwnerContext: (keyOrBinding: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => [Context](./context.context.md) \| undefined; getScopedContext: (scope: import("@loopback/core").[BindingScope.APPLICATION](./context.bindingscope.md) \| import("@loopback/core").[BindingScope.SERVER](./context.bindingscope.md) \| import("@loopback/core").[BindingScope.REQUEST](./context.bindingscope.md)<!-- -->) => [Context](./context.context.md) \| undefined; getResolutionContext: (binding: Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => [Context](./context.context.md) \| undefined; isVisibleTo: (ctx: [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: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_3>, session?: import("@loopback/core").[ResolutionSession](./context.resolutionsession.md) \| undefined): Promise<ValueType\_3>; <ValueType\_4>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_4>, options: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md)<!-- -->): Promise<ValueType\_4 \| undefined>; }; getSync: { <ValueType\_5>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_5>, session?: import("@loopback/core").[ResolutionSession](./context.resolutionsession.md) \| undefined): ValueType\_5; <ValueType\_6>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_6>, options?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined): ValueType\_6 \| undefined; }; getBinding: { <ValueType\_7 = any>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_7>): [Binding](./context.binding.md)<!-- --><ValueType\_7>; <ValueType\_8>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_8>, options?: { optional?: boolean \| undefined; } \| undefined): [Binding](./context.binding.md)<!-- --><ValueType\_8> \| undefined; }; findOrCreateBinding: <T\_3>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><T\_3>, policy?: import("@loopback/core").[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_3>; getValueOrPromise: <ValueType\_9>(keyWithPath: [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)<!-- -->): [Context](./context.context.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Context](./context.context.md)<!-- -->; }; once: { (eventName: "bind" \| "unbind", listener: import("@loopback/core").[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Context](./context.context.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Context](./context.context.md)<!-- -->; }; addListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Context](./context.context.md)<!-- -->; removeListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Context](./context.context.md)<!-- -->; off: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Context](./context.context.md)<!-- -->; removeAllListeners: (event?: string \| symbol \| undefined) => [Context](./context.context.md)<!-- -->; setMaxListeners: (n: number) => [Context](./context.context.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) => [Context](./context.context.md)<!-- -->; prependOnceListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Context](./context.context.md)<!-- -->; eventNames: () => (string \| symbol)\[\]; }; } & T
|
|
103
103
|
|
|
104
104
|
|
|
@@ -32,7 +32,7 @@ export declare class MiddlewareView extends ContextView
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [middlewareBindingKeys](./express.middlewareview.middlewarebindingkeys.md) |
|
|
35
|
+
| [middlewareBindingKeys](./express.middlewareview.middlewarebindingkeys.md) | <code>readonly</code> | string\[\] | A list of binding keys sorted by group for registered middleware |
|
|
36
36
|
|
|
37
37
|
## Methods
|
|
38
38
|
|
|
@@ -32,8 +32,8 @@ export interface AndClause<MT extends object>
|
|
|
32
32
|
|
|
33
33
|
## Properties
|
|
34
34
|
|
|
35
|
-
| Property | Type | Description |
|
|
36
|
-
| --- | --- | --- |
|
|
37
|
-
| [and](./filter.andclause.and.md) | [Where](./filter.where.md)<!-- --><MT>\[\] | |
|
|
35
|
+
| Property | Modifiers | Type | Description |
|
|
36
|
+
| --- | --- | --- | --- |
|
|
37
|
+
| [and](./filter.andclause.and.md) | | [Where](./filter.where.md)<!-- --><MT>\[\] | |
|
|
38
38
|
|
|
39
39
|
|
|
@@ -23,14 +23,14 @@ export interface Filter<MT extends object = AnyObject>
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [fields?](./filter.filter.fields.md) | [Fields](./filter.fields.md)<!-- --><MT> | <i>(Optional)</i> To include/exclude fields |
|
|
29
|
-
| [include?](./filter.filter.include.md) | [InclusionFilter](./filter.inclusionfilter.md)<!-- -->\[\] | <i>(Optional)</i> To include related objects |
|
|
30
|
-
| [limit?](./filter.filter.limit.md) | number | <i>(Optional)</i> Maximum number of entities |
|
|
31
|
-
| [offset?](./filter.filter.offset.md) | number | <i>(Optional)</i> Offset N number of entities. An alias for <code>skip</code> |
|
|
32
|
-
| [order?](./filter.filter.order.md) | string\[\] | <i>(Optional)</i> Sorting order for matched entities. Each item should be formatted as <code>fieldName ASC</code> or <code>fieldName DESC</code>. For example: <code>['f1 ASC', 'f2 DESC', 'f3 ASC']</code
|
|
33
|
-
| [skip?](./filter.filter.skip.md) | number | <i>(Optional)</i> Skip N number of entities |
|
|
34
|
-
| [where?](./filter.filter.where.md) | [Where](./filter.where.md)<!-- --><MT> | <i>(Optional)</i> The matching criteria |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [fields?](./filter.filter.fields.md) | | [Fields](./filter.fields.md)<!-- --><MT> | <i>(Optional)</i> To include/exclude fields |
|
|
29
|
+
| [include?](./filter.filter.include.md) | | [InclusionFilter](./filter.inclusionfilter.md)<!-- -->\[\] | <i>(Optional)</i> To include related objects |
|
|
30
|
+
| [limit?](./filter.filter.limit.md) | | number | <i>(Optional)</i> Maximum number of entities |
|
|
31
|
+
| [offset?](./filter.filter.offset.md) | | number | <i>(Optional)</i> Offset N number of entities. An alias for <code>skip</code> |
|
|
32
|
+
| [order?](./filter.filter.order.md) | | string\[\] | <p><i>(Optional)</i> Sorting order for matched entities. Each item should be formatted as <code>fieldName ASC</code> or <code>fieldName DESC</code>. For example: <code>['f1 ASC', 'f2 DESC', 'f3 ASC']</code>.</p><p>We might want to use <code>Order</code> in the future. Keep it as <code>string[]</code> for now for compatibility with LoopBack 3.x.</p> |
|
|
33
|
+
| [skip?](./filter.filter.skip.md) | | number | <i>(Optional)</i> Skip N number of entities |
|
|
34
|
+
| [where?](./filter.filter.where.md) | | [Where](./filter.where.md)<!-- --><MT> | <i>(Optional)</i> The matching criteria |
|
|
35
35
|
|
|
36
36
|
|
|
@@ -27,10 +27,10 @@ export interface Inclusion
|
|
|
27
27
|
|
|
28
28
|
## Properties
|
|
29
29
|
|
|
30
|
-
| Property | Type | Description |
|
|
31
|
-
| --- | --- | --- |
|
|
32
|
-
| [relation](./filter.inclusion.relation.md) | string | |
|
|
33
|
-
| [scope?](./filter.inclusion.scope.md) | [Filter](./filter.filter.md)<!-- --><AnyObject> & { totalLimit?: number; } | <i>(Optional)</i> |
|
|
34
|
-
| [targetType?](./filter.inclusion.targettype.md) | string | <i>(Optional)</i> |
|
|
30
|
+
| Property | Modifiers | Type | Description |
|
|
31
|
+
| --- | --- | --- | --- |
|
|
32
|
+
| [relation](./filter.inclusion.relation.md) | | string | |
|
|
33
|
+
| [scope?](./filter.inclusion.scope.md) | | [Filter](./filter.filter.md)<!-- --><AnyObject> & { totalLimit?: number; } | <i>(Optional)</i> |
|
|
34
|
+
| [targetType?](./filter.inclusion.targettype.md) | | string | <i>(Optional)</i> |
|
|
35
35
|
|
|
36
36
|
|
package/site/apidocs/filter.md
CHANGED
|
@@ -39,7 +39,7 @@ This lightweight module provides strongly-typed typings and filter builders to i
|
|
|
39
39
|
| --- | --- |
|
|
40
40
|
| [AndClause](./filter.andclause.md) | And clause |
|
|
41
41
|
| [Filter](./filter.filter.md) | Query filter object |
|
|
42
|
-
| [Inclusion](./filter.inclusion.md) | Inclusion of related items
|
|
42
|
+
| [Inclusion](./filter.inclusion.md) | <p>Inclusion of related items</p><p>Note: scope means filter on related items</p><p>Example: <code>{relation: 'aRelationName', scope: {<AFilterObject>}}</code></p> |
|
|
43
43
|
| [OrClause](./filter.orclause.md) | Or clause |
|
|
44
44
|
|
|
45
45
|
## Type Aliases
|
|
@@ -48,12 +48,12 @@ This lightweight module provides strongly-typed typings and filter builders to i
|
|
|
48
48
|
| --- | --- |
|
|
49
49
|
| [Condition](./filter.condition.md) | Condition clause |
|
|
50
50
|
| [Direction](./filter.direction.md) | Order by direction |
|
|
51
|
-
| [Fields](./filter.fields.md) | Selection of fields
|
|
51
|
+
| [Fields](./filter.fields.md) | <p>Selection of fields</p><p>Example: <code>{afieldname: true}</code></p> |
|
|
52
52
|
| [FilterExcludingWhere](./filter.filterexcludingwhere.md) | Filter without <code>where</code> property |
|
|
53
53
|
| [InclusionFilter](./filter.inclusionfilter.md) | Inclusion filter type e.g. 'property', {<!-- -->relation: 'property'<!-- -->} |
|
|
54
54
|
| [KeyOf](./filter.keyof.md) | Key types of a given model, excluding operators |
|
|
55
55
|
| [Operators](./filter.operators.md) | Operators for where clauses |
|
|
56
|
-
| [Order](./filter.order.md) | Order by
|
|
56
|
+
| [Order](./filter.order.md) | <p>Order by</p><p>Example: <code>{afieldname: 'ASC'}</code></p> |
|
|
57
57
|
| [PredicateComparison](./filter.predicatecomparison.md) | Matching predicate comparison |
|
|
58
58
|
| [ShortHandEqualType](./filter.shorthandequaltype.md) | Value types for <code>{propertyName: value}</code> |
|
|
59
59
|
| [Where](./filter.where.md) | Where clause |
|
|
@@ -32,8 +32,8 @@ export interface OrClause<MT extends object>
|
|
|
32
32
|
|
|
33
33
|
## Properties
|
|
34
34
|
|
|
35
|
-
| Property | Type | Description |
|
|
36
|
-
| --- | --- | --- |
|
|
37
|
-
| [or](./filter.orclause.or.md) | [Where](./filter.where.md)<!-- --><MT>\[\] | |
|
|
35
|
+
| Property | Modifiers | Type | Description |
|
|
36
|
+
| --- | --- | --- | --- |
|
|
37
|
+
| [or](./filter.orclause.or.md) | | [Where](./filter.where.md)<!-- --><MT>\[\] | |
|
|
38
38
|
|
|
39
39
|
|
|
@@ -32,7 +32,7 @@ export declare class GraphQLResolutionContext extends Context
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [resolverClass](./graphql.graphqlresolutioncontext.resolverclass.md) |
|
|
36
|
-
| [resolverData](./graphql.graphqlresolutioncontext.resolverdata.md) |
|
|
35
|
+
| [resolverClass](./graphql.graphqlresolutioncontext.resolverclass.md) | <code>readonly</code> | [Constructor](./context.constructor.md)<!-- --><unknown> | |
|
|
36
|
+
| [resolverData](./graphql.graphqlresolutioncontext.resolverdata.md) | <code>readonly</code> | ResolverData<unknown> | |
|
|
37
37
|
|
|
38
38
|
|
|
@@ -34,9 +34,9 @@ export declare class GraphQLServer extends Context implements Server
|
|
|
34
34
|
|
|
35
35
|
| Property | Modifiers | Type | Description |
|
|
36
36
|
| --- | --- | --- | --- |
|
|
37
|
-
| [expressApp](./graphql.graphqlserver.expressapp.md) |
|
|
38
|
-
| [httpServer?](./graphql.graphqlserver.httpserver.md) |
|
|
39
|
-
| [listening](./graphql.graphqlserver.listening.md) |
|
|
37
|
+
| [expressApp](./graphql.graphqlserver.expressapp.md) | <code>readonly</code> | express.Application | |
|
|
38
|
+
| [httpServer?](./graphql.graphqlserver.httpserver.md) | <code>readonly</code> | [HttpServer](./http-server.httpserver.md) | <i>(Optional)</i> |
|
|
39
|
+
| [listening](./graphql.graphqlserver.listening.md) | <code>readonly</code> | boolean | Is the GraphQL listening |
|
|
40
40
|
|
|
41
41
|
## Methods
|
|
42
42
|
|
|
@@ -24,11 +24,11 @@ export interface GraphQLServerOptions extends HttpOptions
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [apollo?](./graphql.graphqlserveroptions.apollo.md) | ApolloServerExpressConfig | <i>(Optional)</i> ApolloServerExpress related configuration |
|
|
30
|
-
| [asMiddlewareOnly?](./graphql.graphqlserveroptions.asmiddlewareonly.md) | boolean | <i>(Optional)</i> Use as a middleware for RestServer instead of a standalone server |
|
|
31
|
-
| [expressSettings?](./graphql.graphqlserveroptions.expresssettings.md) | Record<string, unknown> | <i>(Optional)</i> Express settings |
|
|
32
|
-
| [middlewareOptions?](./graphql.graphqlserveroptions.middlewareoptions.md) | GetMiddlewareOptions | <i>(Optional)</i> Middleware options for GraphQL |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [apollo?](./graphql.graphqlserveroptions.apollo.md) | | ApolloServerExpressConfig | <i>(Optional)</i> ApolloServerExpress related configuration |
|
|
30
|
+
| [asMiddlewareOnly?](./graphql.graphqlserveroptions.asmiddlewareonly.md) | | boolean | <i>(Optional)</i> Use as a middleware for RestServer instead of a standalone server |
|
|
31
|
+
| [expressSettings?](./graphql.graphqlserveroptions.expresssettings.md) | | Record<string, unknown> | <i>(Optional)</i> Express settings |
|
|
32
|
+
| [middlewareOptions?](./graphql.graphqlserveroptions.middlewareoptions.md) | | GetMiddlewareOptions | <i>(Optional)</i> Middleware options for GraphQL |
|
|
33
33
|
|
|
34
34
|
|
|
@@ -32,7 +32,7 @@ export declare class LoopBackContainer implements ContainerType
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [ctx](./graphql.loopbackcontainer.ctx.md) |
|
|
35
|
+
| [ctx](./graphql.loopbackcontainer.ctx.md) | <code>readonly</code> | [Context](./context.context.md) | |
|
|
36
36
|
|
|
37
37
|
## Methods
|
|
38
38
|
|
|
@@ -21,12 +21,12 @@ export interface ProxyOptions
|
|
|
21
21
|
|
|
22
22
|
## Properties
|
|
23
23
|
|
|
24
|
-
| Property | Type | Description |
|
|
25
|
-
| --- | --- | --- |
|
|
26
|
-
| [cachePath](./http-caching-proxy.proxyoptions.cachepath.md) | string | Directory where to keep the cached snapshots. |
|
|
27
|
-
| [logError?](./http-caching-proxy.proxyoptions.logerror.md) | boolean | <i>(Optional)</i> A flag if the error should be logged |
|
|
28
|
-
| [port?](./http-caching-proxy.proxyoptions.port.md) | number | <i>(Optional)</i> The port where the HTTP proxy should listen at. Default: 0 (let the system pick a free port) |
|
|
29
|
-
| [timeout?](./http-caching-proxy.proxyoptions.timeout.md) | number | <i>(Optional)</i> Timeout to connect to the target service |
|
|
30
|
-
| [ttl?](./http-caching-proxy.proxyoptions.ttl.md) | number | <i>(Optional)</i> How long to keep snapshots before making a new request to the backend. The value is in milliseconds
|
|
24
|
+
| Property | Modifiers | Type | Description |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
| [cachePath](./http-caching-proxy.proxyoptions.cachepath.md) | | string | Directory where to keep the cached snapshots. |
|
|
27
|
+
| [logError?](./http-caching-proxy.proxyoptions.logerror.md) | | boolean | <i>(Optional)</i> A flag if the error should be logged |
|
|
28
|
+
| [port?](./http-caching-proxy.proxyoptions.port.md) | | number | <i>(Optional)</i> The port where the HTTP proxy should listen at. Default: 0 (let the system pick a free port) |
|
|
29
|
+
| [timeout?](./http-caching-proxy.proxyoptions.timeout.md) | | number | <i>(Optional)</i> Timeout to connect to the target service |
|
|
30
|
+
| [ttl?](./http-caching-proxy.proxyoptions.ttl.md) | | number | <p><i>(Optional)</i> How long to keep snapshots before making a new request to the backend. The value is in milliseconds.</p><p>Default: one day</p> |
|
|
31
31
|
|
|
32
32
|
|
|
@@ -20,12 +20,12 @@ Base options that are common to http and https servers
|
|
|
20
20
|
```typescript
|
|
21
21
|
export interface BaseHttpOptions extends ListenOptions, Partial<HttpServerProperties>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> ListenOptions, Partial<[HttpServerProperties](./http-server.httpserverproperties.md)
|
|
23
|
+
<b>Extends:</b> ListenOptions, Partial<[HttpServerProperties](./http-server.httpserverproperties.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [gracePeriodForClose?](./http-server.basehttpoptions.graceperiodforclose.md) | number | <i>(Optional)</i> The <code>gracePeriodForClose</code> property controls how to stop the server gracefully. Its value is the number of milliseconds to wait before in-flight requests finish when the server is being stopped. With this setting, we also reject new requests from existing keep-alive connections in addition to stopping accepting new connections
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [gracePeriodForClose?](./http-server.basehttpoptions.graceperiodforclose.md) | | number | <p><i>(Optional)</i> The <code>gracePeriodForClose</code> property controls how to stop the server gracefully. Its value is the number of milliseconds to wait before in-flight requests finish when the server is being stopped. With this setting, we also reject new requests from existing keep-alive connections in addition to stopping accepting new connections.</p><p>Defaults to Infinity (don't force-close). If you want to immediately destroy all sockets set its value to <code>0</code>.</p><p>See [stoppable](https://www.npmjs.com/package/stoppable)</p> |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -24,8 +24,8 @@ export interface HttpOptions extends BaseHttpOptions
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [protocol?](./http-server.httpoptions.protocol.md) | 'http' | <i>(Optional)</i> |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [protocol?](./http-server.httpoptions.protocol.md) | | 'http' | <i>(Optional)</i> |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -31,14 +31,14 @@ export declare class HttpServer
|
|
|
31
31
|
|
|
32
32
|
| Property | Modifiers | Type | Description |
|
|
33
33
|
| --- | --- | --- | --- |
|
|
34
|
-
| [address](./http-server.httpserver.address.md) |
|
|
35
|
-
| [host](./http-server.httpserver.host.md) |
|
|
36
|
-
| [listening](./http-server.httpserver.listening.md) |
|
|
37
|
-
| [port](./http-server.httpserver.port.md) |
|
|
38
|
-
| [protocol](./http-server.httpserver.protocol.md) |
|
|
39
|
-
| [server](./http-server.httpserver.server.md) |
|
|
40
|
-
| [serverOptions](./http-server.httpserver.serveroptions.md) |
|
|
41
|
-
| [url](./http-server.httpserver.url.md) |
|
|
34
|
+
| [address](./http-server.httpserver.address.md) | <code>readonly</code> | string \| AddressInfo \| undefined | Address of the HTTP / HTTPS server |
|
|
35
|
+
| [host](./http-server.httpserver.host.md) | <code>readonly</code> | string \| undefined | Host of the HTTP / HTTPS server |
|
|
36
|
+
| [listening](./http-server.httpserver.listening.md) | <code>readonly</code> | boolean | State of the HTTP / HTTPS server |
|
|
37
|
+
| [port](./http-server.httpserver.port.md) | <code>readonly</code> | number | Port number of the HTTP / HTTPS server |
|
|
38
|
+
| [protocol](./http-server.httpserver.protocol.md) | <code>readonly</code> | [HttpProtocol](./http-server.httpprotocol.md) | Protocol of the HTTP / HTTPS server |
|
|
39
|
+
| [server](./http-server.httpserver.server.md) | <code>readonly</code> | http.Server \| https.Server | |
|
|
40
|
+
| [serverOptions](./http-server.httpserver.serveroptions.md) | <code>readonly</code> | [HttpServerOptions](./http-server.httpserveroptions.md) | |
|
|
41
|
+
| [url](./http-server.httpserver.url.md) | <code>readonly</code> | string | URL of the HTTP / HTTPS server |
|
|
42
42
|
|
|
43
43
|
## Methods
|
|
44
44
|
|
|
@@ -24,8 +24,8 @@ export interface HttpsOptions extends BaseHttpOptions, https.ServerOptions
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [protocol](./http-server.httpsoptions.protocol.md) | 'https' | |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [protocol](./http-server.httpsoptions.protocol.md) | | 'https' | |
|
|
30
30
|
|
|
31
31
|
|
package/site/apidocs/index.md
CHANGED
|
@@ -42,7 +42,7 @@ permalink: /doc/en/lb4/apidocs.index.html
|
|
|
42
42
|
| [@loopback/openapi-spec-builder](./openapi-spec-builder.md) | A package to simplify creating OpenAPI specification documents in your tests using the builder pattern. |
|
|
43
43
|
| [@loopback/openapi-v3](./openapi-v3.md) | Decorators that describe LoopBack artifacts as OpenAPI 3.0.0 metadata and utilities that transfer LoopBack metadata to OpenAPI 3.0.0 specifications. |
|
|
44
44
|
| [@loopback/pooling](./pooling.md) | |
|
|
45
|
-
| [@loopback/repository](./repository.md) | A common set of interfaces for interacting with databases
|
|
45
|
+
| [@loopback/repository](./repository.md) | <p>A common set of interfaces for interacting with databases.</p><p>This module provides data access facilities to various databases and services as well as the constructs for modeling and accessing those data.</p> |
|
|
46
46
|
| [@loopback/repository-json-schema](./repository-json-schema.md) | Convert a TypeScript class/model to a JSON Schema for users, leveraging LoopBack4's decorators, metadata, and reflection system. |
|
|
47
47
|
| [@loopback/repository-tests](./repository-tests.md) | A test suite verifying functionality of <code>@loopback/repository</code> in a connector -independent way. |
|
|
48
48
|
| [@loopback/rest](./rest.md) | The REST API package for loopback-next. |
|
|
@@ -20,7 +20,7 @@ A provider class that creates WinstonLogger instances
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare class WinstonLoggerProvider implements Provider<Logger>
|
|
22
22
|
```
|
|
23
|
-
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><Logger
|
|
23
|
+
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><Logger>
|
|
24
24
|
|
|
25
25
|
## Constructors
|
|
26
26
|
|
|
@@ -20,7 +20,7 @@ Factory for class decorators
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare class ClassDecoratorFactory<T> extends DecoratorFactory<T, T, ClassDecorator>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- --><T, T, ClassDecorator
|
|
23
|
+
<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- --><T, T, ClassDecorator>
|
|
24
24
|
|
|
25
25
|
## Methods
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ export declare class ClassDecoratorFactory<T> extends DecoratorFactory<T, T, Cla
|
|
|
28
28
|
| --- | --- | --- |
|
|
29
29
|
| [create()](./metadata.classdecoratorfactory.create.md) | | |
|
|
30
30
|
| [createDecorator(key, spec, options)](./metadata.classdecoratorfactory.createdecorator.md) | <code>static</code> | Create a class decorator function |
|
|
31
|
-
| [mergeWithInherited(inheritedMetadata, target, member, descriptorOrIndex)](./metadata.classdecoratorfactory.mergewithinherited.md) |
|
|
32
|
-
| [mergeWithOwn(ownMetadata, target, member, descriptorOrIndex)](./metadata.classdecoratorfactory.mergewithown.md) |
|
|
31
|
+
| [mergeWithInherited(inheritedMetadata, target, member, descriptorOrIndex)](./metadata.classdecoratorfactory.mergewithinherited.md) | <code>protected</code> | |
|
|
32
|
+
| [mergeWithOwn(ownMetadata, target, member, descriptorOrIndex)](./metadata.classdecoratorfactory.mergewithown.md) | <code>protected</code> | |
|
|
33
33
|
|
|
34
34
|
|