@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
|
@@ -24,13 +24,13 @@ export interface ValidationOptions extends AjvOptions
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [ajvErrors?](./rest.validationoptions.ajverrors.md) | [AjvErrorOptions](./rest.ajverroroptions.md) | <i>(Optional)</i> Enable custom error messages in JSON-Schema for AJV validator from https://github.com/epoberezkin/ajv-errors - <code>true</code>: Enable <code>ajv-errors</code> - <code>AjvErrorOptions</code>: Enable <code>ajv-errors</code> with options |
|
|
30
|
-
| [ajvErrorTransformer?](./rest.validationoptions.ajverrortransformer.md) | (errors: ErrorObject\[\]) => ErrorObject\[\] | <i>(Optional)</i> A function that transform the <code>ErrorObject</code>s reported by AJV. This could be used for error messages customization, localization, etc. |
|
|
31
|
-
| [ajvFactory?](./rest.validationoptions.ajvfactory.md) | (options: AjvOptions) => Ajv | <i>(Optional)</i> A factory to create Ajv instance |
|
|
32
|
-
| [ajvKeywords?](./rest.validationoptions.ajvkeywords.md) | string\[\] | <i>(Optional)</i> Enable additional AJV keywords from https://github.com/epoberezkin/ajv-keywords - <code>string[]</code>: Add an array of keywords from <code>ajv-keywords</code> |
|
|
33
|
-
| [compiledSchemaCache?](./rest.validationoptions.compiledschemacache.md) | [SchemaValidatorCache](./rest.schemavalidatorcache.md) | <i>(Optional)</i> Custom cache for compiled schemas by AJV. This setting makes it possible to skip the default cache. |
|
|
34
|
-
| [prohibitedKeys?](./rest.validationoptions.prohibitedkeys.md) | string\[\] | <i>(Optional)</i> An array of keys to be rejected, such as <code>__proto__</code>. |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [ajvErrors?](./rest.validationoptions.ajverrors.md) | | [AjvErrorOptions](./rest.ajverroroptions.md) | <i>(Optional)</i> Enable custom error messages in JSON-Schema for AJV validator from https://github.com/epoberezkin/ajv-errors - <code>true</code>: Enable <code>ajv-errors</code> - <code>AjvErrorOptions</code>: Enable <code>ajv-errors</code> with options |
|
|
30
|
+
| [ajvErrorTransformer?](./rest.validationoptions.ajverrortransformer.md) | | (errors: ErrorObject\[\]) => ErrorObject\[\] | <i>(Optional)</i> A function that transform the <code>ErrorObject</code>s reported by AJV. This could be used for error messages customization, localization, etc. |
|
|
31
|
+
| [ajvFactory?](./rest.validationoptions.ajvfactory.md) | | (options: AjvOptions) => Ajv | <i>(Optional)</i> A factory to create Ajv instance |
|
|
32
|
+
| [ajvKeywords?](./rest.validationoptions.ajvkeywords.md) | | string\[\] | <i>(Optional)</i> Enable additional AJV keywords from https://github.com/epoberezkin/ajv-keywords - <code>string[]</code>: Add an array of keywords from <code>ajv-keywords</code> |
|
|
33
|
+
| [compiledSchemaCache?](./rest.validationoptions.compiledschemacache.md) | | [SchemaValidatorCache](./rest.schemavalidatorcache.md) | <i>(Optional)</i> Custom cache for compiled schemas by AJV. This setting makes it possible to skip the default cache. |
|
|
34
|
+
| [prohibitedKeys?](./rest.validationoptions.prohibitedkeys.md) | | string\[\] | <i>(Optional)</i> An array of keys to be rejected, such as <code>__proto__</code>. |
|
|
35
35
|
|
|
36
36
|
|
|
@@ -24,9 +24,9 @@ export interface ValueValidationOptions extends ValidationOptions
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [name?](./rest.valuevalidationoptions.name.md) | string | <i>(Optional)</i> Parameter name, as provided in <code>ParameterObject#name</code> property. |
|
|
30
|
-
| [source?](./rest.valuevalidationoptions.source.md) | string | <i>(Optional)</i> Where the data comes from. It can be 'body', 'path', 'header', 'query', 'cookie', etc... |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [name?](./rest.valuevalidationoptions.name.md) | | string | <i>(Optional)</i> Parameter name, as provided in <code>ParameterObject#name</code> property. |
|
|
30
|
+
| [source?](./rest.valuevalidationoptions.source.md) | | string | <i>(Optional)</i> Where the data comes from. It can be 'body', 'path', 'header', 'query', 'cookie', etc... |
|
|
31
31
|
|
|
32
32
|
|
|
@@ -26,10 +26,10 @@ export declare class DefaultSubject implements Subject
|
|
|
26
26
|
|
|
27
27
|
| Property | Modifiers | Type | Description |
|
|
28
28
|
| --- | --- | --- | --- |
|
|
29
|
-
| [authorities](./security.defaultsubject.authorities.md) |
|
|
30
|
-
| [credentials](./security.defaultsubject.credentials.md) |
|
|
31
|
-
| [principals](./security.defaultsubject.principals.md) |
|
|
32
|
-
| [user](./security.defaultsubject.user.md) |
|
|
29
|
+
| [authorities](./security.defaultsubject.authorities.md) | <code>readonly</code> | Set<[Permission](./security.permission.md)<!-- -->> | |
|
|
30
|
+
| [credentials](./security.defaultsubject.credentials.md) | <code>readonly</code> | Set<[Credential](./security.credential.md)<!-- -->> | |
|
|
31
|
+
| [principals](./security.defaultsubject.principals.md) | <code>readonly</code> | Set<[TypedPrincipal](./security.typedprincipal.md)<!-- -->> | |
|
|
32
|
+
| [user](./security.defaultsubject.user.md) | <code>readonly</code> | [UserProfile](./security.userprofile.md) \| undefined | |
|
|
33
33
|
|
|
34
34
|
## Methods
|
|
35
35
|
|
package/site/apidocs/security.md
CHANGED
|
@@ -24,7 +24,7 @@ Common types/interfaces for LoopBack 4 security including authentication and aut
|
|
|
24
24
|
| Class | Description |
|
|
25
25
|
| --- | --- |
|
|
26
26
|
| [DefaultSubject](./security.defaultsubject.md) | Default implementation of <code>Subject</code> |
|
|
27
|
-
| [Permission](./security.permission.md) | <code>Permission</code> defines an action/access against a protected resource. It's the <code>what</code> for security
|
|
27
|
+
| [Permission](./security.permission.md) | <p><code>Permission</code> defines an action/access against a protected resource. It's the <code>what</code> for security.</p><p>There are three levels of permissions</p><p>- Resource level (Order, User) - Instance level (Order-0001, User-1001) - Property level (User-0001.email)</p> |
|
|
28
28
|
| [TypedPrincipal](./security.typedprincipal.md) | |
|
|
29
29
|
|
|
30
30
|
## Interfaces
|
|
@@ -37,7 +37,7 @@ Common types/interfaces for LoopBack 4 security including authentication and aut
|
|
|
37
37
|
| [Principal](./security.principal.md) | Represent a user, an application, or a device |
|
|
38
38
|
| [Role](./security.role.md) | |
|
|
39
39
|
| [Scope](./security.scope.md) | oAuth 2.0 scope |
|
|
40
|
-
| [Subject](./security.subject.md) | <code>Subject</code> represents both security state and operations for a single request. It's the <code>who</code> for security
|
|
40
|
+
| [Subject](./security.subject.md) | <p><code>Subject</code> represents both security state and operations for a single request. It's the <code>who</code> for security.</p><p>Such operations include: - authentication (login) - authorization (access control) - session access - logout</p> |
|
|
41
41
|
| [Team](./security.team.md) | |
|
|
42
42
|
| [UserProfile](./security.userprofile.md) | The minimum set of attributes that describe a user. |
|
|
43
43
|
|
|
@@ -33,7 +33,7 @@ export declare class Permission
|
|
|
33
33
|
|
|
34
34
|
| Property | Modifiers | Type | Description |
|
|
35
35
|
| --- | --- | --- | --- |
|
|
36
|
-
| [\[securityId\]](./security.permission._securityid_.md) |
|
|
36
|
+
| [\[securityId\]](./security.permission._securityid_.md) | <code>readonly</code> | string | |
|
|
37
37
|
| [action](./security.permission.action.md) | | string | Action or access of a protected resources, such as <code>read</code>, <code>create</code>, <code>update</code>, or <code>delete</code> |
|
|
38
38
|
| [resourceId?](./security.permission.resourceid.md) | | string | <i>(Optional)</i> Identity of a protected resource instance, such as <code>order-0001</code> or <code>customer-101</code> |
|
|
39
39
|
| [resourceProperty?](./security.permission.resourceproperty.md) | | string | <i>(Optional)</i> Property of a protected resource type/instance, such as <code>email</code> |
|
|
@@ -23,8 +23,8 @@ export interface Principal
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [\[securityId\]](./security.principal._securityid_.md) | string | Name/id |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [\[securityId\]](./security.principal._securityid_.md) | | string | Name/id |
|
|
29
29
|
|
|
30
30
|
|
|
@@ -22,8 +22,8 @@ export interface Role extends Principal
|
|
|
22
22
|
|
|
23
23
|
## Properties
|
|
24
24
|
|
|
25
|
-
| Property | Type | Description |
|
|
26
|
-
| --- | --- | --- |
|
|
27
|
-
| [name](./security.role.name.md) | string | |
|
|
25
|
+
| Property | Modifiers | Type | Description |
|
|
26
|
+
| --- | --- | --- | --- |
|
|
27
|
+
| [name](./security.role.name.md) | | string | |
|
|
28
28
|
|
|
29
29
|
|
|
@@ -24,8 +24,8 @@ export interface Scope extends Permission
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [name](./security.scope.name.md) | string | |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [name](./security.scope.name.md) | | string | |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -25,10 +25,10 @@ export interface Subject
|
|
|
25
25
|
|
|
26
26
|
## Properties
|
|
27
27
|
|
|
28
|
-
| Property | Type | Description |
|
|
29
|
-
| --- | --- | --- |
|
|
30
|
-
| [authorities](./security.subject.authorities.md) | Set<[Permission](./security.permission.md)<!-- -->> | An array of authorities granted by the user to the client application. One example is {@<!-- -->link https://tools.ietf.org/html/rfc6749\#section-3.3 \| oAuth2 scopes). |
|
|
31
|
-
| [credentials](./security.subject.credentials.md) | Set<[Credential](./security.credential.md)<!-- -->> | An array of credentials, such as password, access token, or private/public keys. |
|
|
32
|
-
| [principals](./security.subject.principals.md) | Set<[TypedPrincipal](./security.typedprincipal.md)<!-- -->> | An array of principals. It can include information about the current user, the client application, and granted authorities
|
|
28
|
+
| Property | Modifiers | Type | Description |
|
|
29
|
+
| --- | --- | --- | --- |
|
|
30
|
+
| [authorities](./security.subject.authorities.md) | | Set<[Permission](./security.permission.md)<!-- -->> | An array of authorities granted by the user to the client application. One example is {@<!-- -->link https://tools.ietf.org/html/rfc6749\#section-3.3 \| oAuth2 scopes). |
|
|
31
|
+
| [credentials](./security.subject.credentials.md) | | Set<[Credential](./security.credential.md)<!-- -->> | An array of credentials, such as password, access token, or private/public keys. |
|
|
32
|
+
| [principals](./security.subject.principals.md) | | Set<[TypedPrincipal](./security.typedprincipal.md)<!-- -->> | <p>An array of principals. It can include information about the current user, the client application, and granted authorities.</p><p><code>Subject</code> represents both security state and operations for a single application user.</p><p>Such operations include: - authentication (login) - authorization (access control) - session access - logout</p> |
|
|
33
33
|
|
|
34
34
|
|
|
@@ -30,8 +30,8 @@ export declare class TypedPrincipal implements Principal
|
|
|
30
30
|
|
|
31
31
|
| Property | Modifiers | Type | Description |
|
|
32
32
|
| --- | --- | --- | --- |
|
|
33
|
-
| [\[securityId\]](./security.typedprincipal._securityid_.md) |
|
|
34
|
-
| [principal](./security.typedprincipal.principal.md) |
|
|
35
|
-
| [type](./security.typedprincipal.type.md) |
|
|
33
|
+
| [\[securityId\]](./security.typedprincipal._securityid_.md) | <code>readonly</code> | string | |
|
|
34
|
+
| [principal](./security.typedprincipal.principal.md) | <code>readonly</code> | [Principal](./security.principal.md) | |
|
|
35
|
+
| [type](./security.typedprincipal.type.md) | <code>readonly</code> | string | |
|
|
36
36
|
|
|
37
37
|
|
|
@@ -24,9 +24,9 @@ export interface UserProfile extends Principal
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [email?](./security.userprofile.email.md) | string | <i>(Optional)</i> |
|
|
30
|
-
| [name?](./security.userprofile.name.md) | string | <i>(Optional)</i> |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [email?](./security.userprofile.email.md) | | string | <i>(Optional)</i> |
|
|
30
|
+
| [name?](./security.userprofile.name.md) | | string | <i>(Optional)</i> |
|
|
31
31
|
|
|
32
32
|
|
|
@@ -19,7 +19,7 @@ A common set of interfaces for interacting with service oriented backends such a
|
|
|
19
19
|
|
|
20
20
|
| Class | Description |
|
|
21
21
|
| --- | --- |
|
|
22
|
-
| [ServiceMixinDoc](./service-proxy.servicemixindoc.md) | A dummy class created to generate the tsdoc for the members in service mixin. Please don't use it
|
|
22
|
+
| [ServiceMixinDoc](./service-proxy.servicemixindoc.md) | <p>A dummy class created to generate the tsdoc for the members in service mixin. Please don't use it.</p><p>The members are implemented in function <a href="#ServiceMixin">ServiceMixin</a></p> |
|
|
23
23
|
| [ServiceProxyMetadata](./service-proxy.serviceproxymetadata.md) | Metadata for a service proxy |
|
|
24
24
|
|
|
25
25
|
## Functions
|
|
@@ -20,58 +20,58 @@ A mixin class for Application that creates a .serviceProvider() function to regi
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare function ServiceMixin<T extends MixinTarget<Application>>(superClass: T): {
|
|
22
22
|
new (...args: any[]): {
|
|
23
|
-
serviceProvider<S>(provider: Constructor<Provider<S>>, nameOrOptions?: string | ServiceOptions
|
|
24
|
-
component<C extends Component = Component>(componentCtor: Constructor<C>, nameOrOptions?: string | BindingFromClassOptions
|
|
23
|
+
serviceProvider<S>(provider: Constructor<Provider<S>>, nameOrOptions?: string | ServiceOptions): Binding<S>;
|
|
24
|
+
component<C extends Component = Component>(componentCtor: Constructor<C>, nameOrOptions?: string | BindingFromClassOptions): Binding<C>;
|
|
25
25
|
mountComponentServices<C_1 extends Component = Component>(component: Constructor<C_1>, componentBindingKey?: BindingAddress<C_1> | undefined): void;
|
|
26
|
-
readonly options:
|
|
26
|
+
readonly options: import("@loopback/core").ApplicationConfig;
|
|
27
27
|
readonly state: string;
|
|
28
|
-
controller: <T_1>(controllerCtor:
|
|
29
|
-
server: <T_2 extends
|
|
30
|
-
servers: <T_3 extends
|
|
31
|
-
getServer: <T_4 extends
|
|
28
|
+
controller: <T_1>(controllerCtor: import("@loopback/core").ControllerClass<T_1>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_1>;
|
|
29
|
+
server: <T_2 extends import("@loopback/core").Server>(ctor: Constructor<T_2>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_2>;
|
|
30
|
+
servers: <T_3 extends import("@loopback/core").Server>(ctors: Constructor<T_3>[]) => Binding<any>[];
|
|
31
|
+
getServer: <T_4 extends import("@loopback/core").Server>(target: string | Constructor<T_4>) => Promise<T_4>;
|
|
32
32
|
init: () => Promise<void>;
|
|
33
|
-
onInit: (fn: () =>
|
|
33
|
+
onInit: (fn: () => import("@loopback/core").ValueOrPromise<void>) => Binding<import("@loopback/core").LifeCycleObserver>;
|
|
34
34
|
start: () => Promise<void>;
|
|
35
|
-
onStart: (fn: () =>
|
|
35
|
+
onStart: (fn: () => import("@loopback/core").ValueOrPromise<void>) => Binding<import("@loopback/core").LifeCycleObserver>;
|
|
36
36
|
stop: () => Promise<void>;
|
|
37
|
-
onStop: (fn: () =>
|
|
38
|
-
setMetadata: (metadata:
|
|
39
|
-
lifeCycleObserver: <T_5 extends
|
|
40
|
-
service: <S_1>(cls:
|
|
41
|
-
interceptor: (interceptor:
|
|
37
|
+
onStop: (fn: () => import("@loopback/core").ValueOrPromise<void>) => Binding<import("@loopback/core").LifeCycleObserver>;
|
|
38
|
+
setMetadata: (metadata: import("@loopback/core").ApplicationMetadata) => void;
|
|
39
|
+
lifeCycleObserver: <T_5 extends import("@loopback/core").LifeCycleObserver>(ctor: Constructor<T_5>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_5>;
|
|
40
|
+
service: <S_1>(cls: import("@loopback/core").ServiceOrProviderClass<S_1>, nameOrOptions?: string | ServiceOptions | undefined) => Binding<S_1>;
|
|
41
|
+
interceptor: (interceptor: import("@loopback/core").Interceptor | Constructor<Provider<import("@loopback/core").Interceptor>>, nameOrOptions?: string | import("@loopback/core").InterceptorBindingOptions | undefined) => Binding<import("@loopback/core").Interceptor>;
|
|
42
42
|
readonly name: string;
|
|
43
|
-
readonly subscriptionManager:
|
|
44
|
-
scope:
|
|
45
|
-
readonly parent:
|
|
46
|
-
emitEvent: <T_6 extends
|
|
43
|
+
readonly subscriptionManager: import("@loopback/core").ContextSubscriptionManager;
|
|
44
|
+
scope: import("@loopback/core").BindingScope;
|
|
45
|
+
readonly parent: import("@loopback/core").Context | undefined;
|
|
46
|
+
emitEvent: <T_6 extends import("@loopback/core").ContextEvent>(type: string, event: T_6) => void;
|
|
47
47
|
emitError: (err: unknown) => void;
|
|
48
48
|
bind: <ValueType = any>(key: BindingAddress<ValueType>) => Binding<ValueType>;
|
|
49
49
|
add: (binding: Binding<unknown>) => Application;
|
|
50
50
|
configure: <ConfigValueType = any>(key?: BindingAddress<unknown> | undefined) => Binding<ConfigValueType>;
|
|
51
|
-
getConfigAsValueOrPromise: <ConfigValueType_1>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?:
|
|
52
|
-
getConfig: <ConfigValueType_2>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?:
|
|
53
|
-
getConfigSync: <ConfigValueType_3>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?:
|
|
51
|
+
getConfigAsValueOrPromise: <ConfigValueType_1>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => import("@loopback/core").ValueOrPromise<ConfigValueType_1 | undefined>;
|
|
52
|
+
getConfig: <ConfigValueType_2>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => Promise<ConfigValueType_2 | undefined>;
|
|
53
|
+
getConfigSync: <ConfigValueType_3>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => ConfigValueType_3 | undefined;
|
|
54
54
|
unbind: (key: BindingAddress<unknown>) => boolean;
|
|
55
|
-
subscribe: (observer:
|
|
56
|
-
unsubscribe: (observer:
|
|
55
|
+
subscribe: (observer: import("@loopback/core").ContextEventObserver) => import("@loopback/core").Subscription;
|
|
56
|
+
unsubscribe: (observer: import("@loopback/core").ContextEventObserver) => boolean;
|
|
57
57
|
close: () => void;
|
|
58
|
-
isSubscribed: (observer:
|
|
59
|
-
createView: <T_7 = unknown>(filter:
|
|
58
|
+
isSubscribed: (observer: import("@loopback/core").ContextObserver) => boolean;
|
|
59
|
+
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>;
|
|
60
60
|
contains: (key: BindingAddress<unknown>) => boolean;
|
|
61
61
|
isBound: (key: BindingAddress<unknown>) => boolean;
|
|
62
|
-
getOwnerContext: (keyOrBinding: BindingAddress<unknown> | Readonly<Binding<unknown>>) =>
|
|
63
|
-
getScopedContext: (scope:
|
|
64
|
-
getResolutionContext: (binding: Readonly<Binding<unknown>>) =>
|
|
65
|
-
isVisibleTo: (ctx:
|
|
66
|
-
find: <ValueType_1 = any>(pattern?: string | RegExp |
|
|
67
|
-
findByTag: <ValueType_2 = any>(tagFilter: RegExp |
|
|
62
|
+
getOwnerContext: (keyOrBinding: BindingAddress<unknown> | Readonly<Binding<unknown>>) => import("@loopback/core").Context | undefined;
|
|
63
|
+
getScopedContext: (scope: import("@loopback/core").BindingScope.APPLICATION | import("@loopback/core").BindingScope.SERVER | import("@loopback/core").BindingScope.REQUEST) => import("@loopback/core").Context | undefined;
|
|
64
|
+
getResolutionContext: (binding: Readonly<Binding<unknown>>) => import("@loopback/core").Context | undefined;
|
|
65
|
+
isVisibleTo: (ctx: import("@loopback/core").Context) => boolean;
|
|
66
|
+
find: <ValueType_1 = any>(pattern?: string | RegExp | import("@loopback/core").BindingFilter | undefined) => Readonly<Binding<ValueType_1>>[];
|
|
67
|
+
findByTag: <ValueType_2 = any>(tagFilter: RegExp | import("@loopback/core").BindingTag) => Readonly<Binding<ValueType_2>>[];
|
|
68
68
|
get: {
|
|
69
|
-
<ValueType_3>(keyWithPath: BindingAddress<ValueType_3>, session?:
|
|
70
|
-
<ValueType_4>(keyWithPath: BindingAddress<ValueType_4>, options:
|
|
69
|
+
<ValueType_3>(keyWithPath: BindingAddress<ValueType_3>, session?: import("@loopback/core").ResolutionSession | undefined): Promise<ValueType_3>;
|
|
70
|
+
<ValueType_4>(keyWithPath: BindingAddress<ValueType_4>, options: import("@loopback/core").ResolutionOptions): Promise<ValueType_4 | undefined>;
|
|
71
71
|
};
|
|
72
72
|
getSync: {
|
|
73
|
-
<ValueType_5>(keyWithPath: BindingAddress<ValueType_5>, session?:
|
|
74
|
-
<ValueType_6>(keyWithPath: BindingAddress<ValueType_6>, options?:
|
|
73
|
+
<ValueType_5>(keyWithPath: BindingAddress<ValueType_5>, session?: import("@loopback/core").ResolutionSession | undefined): ValueType_5;
|
|
74
|
+
<ValueType_6>(keyWithPath: BindingAddress<ValueType_6>, options?: import("@loopback/core").ResolutionOptions | undefined): ValueType_6 | undefined;
|
|
75
75
|
};
|
|
76
76
|
getBinding: {
|
|
77
77
|
<ValueType_7 = any>(key: BindingAddress<ValueType_7>): Binding<ValueType_7>;
|
|
@@ -79,16 +79,16 @@ export declare function ServiceMixin<T extends MixinTarget<Application>>(superCl
|
|
|
79
79
|
optional?: boolean | undefined;
|
|
80
80
|
} | undefined): Binding<ValueType_8> | undefined;
|
|
81
81
|
};
|
|
82
|
-
findOrCreateBinding: <T_8>(key: BindingAddress<T_8>, policy?:
|
|
83
|
-
getValueOrPromise: <ValueType_9>(keyWithPath: BindingAddress<ValueType_9>, optionsOrSession?:
|
|
84
|
-
toJSON: () =>
|
|
85
|
-
inspect: (options?:
|
|
82
|
+
findOrCreateBinding: <T_8>(key: BindingAddress<T_8>, policy?: import("@loopback/core").BindingCreationPolicy | undefined) => Binding<T_8>;
|
|
83
|
+
getValueOrPromise: <ValueType_9>(keyWithPath: BindingAddress<ValueType_9>, optionsOrSession?: import("@loopback/core").ResolutionOptionsOrSession | undefined) => import("@loopback/core").ValueOrPromise<ValueType_9 | undefined>;
|
|
84
|
+
toJSON: () => import("@loopback/core").JSONObject;
|
|
85
|
+
inspect: (options?: import("@loopback/core").ContextInspectOptions | undefined) => import("@loopback/core").JSONObject;
|
|
86
86
|
on: {
|
|
87
|
-
(eventName: "bind" | "unbind", listener:
|
|
87
|
+
(eventName: "bind" | "unbind", listener: import("@loopback/core").ContextEventListener): Application;
|
|
88
88
|
(event: string | symbol, listener: (...args: any[]) => void): Application;
|
|
89
89
|
};
|
|
90
90
|
once: {
|
|
91
|
-
(eventName: "bind" | "unbind", listener:
|
|
91
|
+
(eventName: "bind" | "unbind", listener: import("@loopback/core").ContextEventListener): Application;
|
|
92
92
|
(event: string | symbol, listener: (...args: any[]) => void): Application;
|
|
93
93
|
};
|
|
94
94
|
addListener: (event: string | symbol, listener: (...args: any[]) => void) => Application;
|
|
@@ -100,7 +100,7 @@ export declare function ServiceMixin<T extends MixinTarget<Application>>(superCl
|
|
|
100
100
|
listeners: (event: string | symbol) => Function[];
|
|
101
101
|
rawListeners: (event: string | symbol) => Function[];
|
|
102
102
|
emit: (event: string | symbol, ...args: any[]) => boolean;
|
|
103
|
-
listenerCount: (
|
|
103
|
+
listenerCount: (event: string | symbol) => number;
|
|
104
104
|
prependListener: (event: string | symbol, listener: (...args: any[]) => void) => Application;
|
|
105
105
|
prependOnceListener: (event: string | symbol, listener: (...args: any[]) => void) => Application;
|
|
106
106
|
eventNames: () => (string | symbol)[];
|
|
@@ -116,7 +116,7 @@ export declare function ServiceMixin<T extends MixinTarget<Application>>(superCl
|
|
|
116
116
|
|
|
117
117
|
<b>Returns:</b>
|
|
118
118
|
|
|
119
|
-
{ new (...args: any\[\]): { serviceProvider<S>(provider: [Constructor](./context.constructor.md)<!-- --><[Provider](./context.provider.md)<!-- --><S>>, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><S>; 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>; mountComponentServices<C\_1 extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->>(component: [Constructor](./context.constructor.md)<!-- --><C\_1>, componentBindingKey?: [BindingAddress](./context.bindingaddress.md)<!-- --><C\_1> \| undefined): 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\_1>(cls: loopbackContext.[ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- --><S\_1>, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><S\_1>; interceptor: (interceptor: loopbackContext.[Interceptor](./context.interceptor.md) \| [Constructor](./context.constructor.md)<!-- --><[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: loopbackContext.[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: [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?: [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\_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: [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>>) => loopbackContext.[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)<!-- -->) => 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: [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\_8>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><T\_8>, policy?: loopbackContext.[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_8>; 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)<!-- -->): [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
|
|
119
|
+
{ new (...args: any\[\]): { serviceProvider<S>(provider: [Constructor](./context.constructor.md)<!-- --><[Provider](./context.provider.md)<!-- --><S>>, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md)<!-- -->): [Binding](./context.binding.md)<!-- --><S>; 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>; mountComponentServices<C\_1 extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->>(component: [Constructor](./context.constructor.md)<!-- --><C\_1>, componentBindingKey?: [BindingAddress](./context.bindingaddress.md)<!-- --><C\_1> \| undefined): 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\_1>(cls: import("@loopback/core").[ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- --><S\_1>, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><S\_1>; interceptor: (interceptor: import("@loopback/core").[Interceptor](./context.interceptor.md) \| [Constructor](./context.constructor.md)<!-- --><[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: import("@loopback/core").[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: [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?: [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\_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: [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>>) => import("@loopback/core").[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)<!-- -->) => 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: [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\_8>(key: [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: [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
|
|
120
120
|
|
|
121
121
|
A new class that extends the super class with service proxy related methods
|
|
122
122
|
|
|
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.service-proxy.serviceproxy.html
|
|
|
16
16
|
<b>Signature:</b>
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
|
-
export declare function serviceProxy(dataSource: string | juggler.DataSource): (target: object, key: string, parameterIndex?: number
|
|
19
|
+
export declare function serviceProxy(dataSource: string | juggler.DataSource): (target: object, key: string, parameterIndex?: number) => void;
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
## Parameters
|
|
@@ -27,6 +27,6 @@ export declare function serviceProxy(dataSource: string | juggler.DataSource): (
|
|
|
27
27
|
|
|
28
28
|
<b>Returns:</b>
|
|
29
29
|
|
|
30
|
-
(target: object, key: string, parameterIndex?: number
|
|
30
|
+
(target: object, key: string, parameterIndex?: number) => void
|
|
31
31
|
|
|
32
32
|
|
|
@@ -30,11 +30,11 @@ export declare class DefaultSocketIoSequence implements SocketIoSequence
|
|
|
30
30
|
|
|
31
31
|
| Property | Modifiers | Type | Description |
|
|
32
32
|
| --- | --- | --- | --- |
|
|
33
|
-
| [context](./socketio.defaultsocketiosequence.context.md) |
|
|
34
|
-
| [controller](./socketio.defaultsocketiosequence.controller.md) |
|
|
35
|
-
| [invoke](./socketio.defaultsocketiosequence.invoke.md) |
|
|
36
|
-
| [reject](./socketio.defaultsocketiosequence.reject.md) |
|
|
37
|
-
| [send](./socketio.defaultsocketiosequence.send.md) |
|
|
33
|
+
| [context](./socketio.defaultsocketiosequence.context.md) | <code>protected</code> | [Context](./context.context.md) | |
|
|
34
|
+
| [controller](./socketio.defaultsocketiosequence.controller.md) | <code>protected</code> | [ControllerClass](./core.controllerclass.md) | |
|
|
35
|
+
| [invoke](./socketio.defaultsocketiosequence.invoke.md) | <code>protected</code> | [SocketIoInvokeMethod](./socketio.socketioinvokemethod.md) | |
|
|
36
|
+
| [reject](./socketio.defaultsocketiosequence.reject.md) | <code>protected</code> | [SocketIoRejectMethod](./socketio.socketiorejectmethod.md) | |
|
|
37
|
+
| [send](./socketio.defaultsocketiosequence.send.md) | <code>protected</code> | [SocketIoSendMethod](./socketio.socketiosendmethod.md) | |
|
|
38
38
|
|
|
39
39
|
## Methods
|
|
40
40
|
|
|
@@ -23,12 +23,12 @@ export interface HttpServerResolvedOptions
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [basePath?](./socketio.httpserverresolvedoptions.basepath.md) | string | <i>(Optional)</i> |
|
|
29
|
-
| [cors](./socketio.httpserverresolvedoptions.cors.md) | cors.CorsOptions | |
|
|
30
|
-
| [host?](./socketio.httpserverresolvedoptions.host.md) | string | <i>(Optional)</i> |
|
|
31
|
-
| [path?](./socketio.httpserverresolvedoptions.path.md) | string | <i>(Optional)</i> |
|
|
32
|
-
| [port](./socketio.httpserverresolvedoptions.port.md) | number | |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [basePath?](./socketio.httpserverresolvedoptions.basepath.md) | | string | <i>(Optional)</i> |
|
|
29
|
+
| [cors](./socketio.httpserverresolvedoptions.cors.md) | | cors.CorsOptions | |
|
|
30
|
+
| [host?](./socketio.httpserverresolvedoptions.host.md) | | string | <i>(Optional)</i> |
|
|
31
|
+
| [path?](./socketio.httpserverresolvedoptions.path.md) | | string | <i>(Optional)</i> |
|
|
32
|
+
| [port](./socketio.httpserverresolvedoptions.port.md) | | number | |
|
|
33
33
|
|
|
34
34
|
|
|
@@ -28,7 +28,7 @@ export declare namespace socketio
|
|
|
28
28
|
| [io()](./socketio.socketio.io.md) | |
|
|
29
29
|
| [namespace(name)](./socketio.socketio.namespace.md) | |
|
|
30
30
|
| [socket()](./socketio.socketio.socket.md) | |
|
|
31
|
-
| [subscribe(messageTypes)](./socketio.socketio.subscribe.md) | Decorate a method to subscribe to socketio events. For example
|
|
31
|
+
| [subscribe(messageTypes)](./socketio.socketio.subscribe.md) | <p>Decorate a method to subscribe to socketio events. For example,</p>
|
|
32
32
|
```ts
|
|
33
33
|
@socketio.subscribe('chat message')
|
|
34
34
|
async function onChat(msg: string) {
|
|
@@ -30,7 +30,7 @@ export declare class SocketIoApplication extends Application
|
|
|
30
30
|
|
|
31
31
|
| Property | Modifiers | Type | Description |
|
|
32
32
|
| --- | --- | --- | --- |
|
|
33
|
-
| [socketServer](./socketio.socketioapplication.socketserver.md) |
|
|
33
|
+
| [socketServer](./socketio.socketioapplication.socketserver.md) | <code>readonly</code> | [SocketIoServer](./socketio.socketioserver.md) | The main Socket server instance providing Socket connections for this application. |
|
|
34
34
|
|
|
35
35
|
## Methods
|
|
36
36
|
|
|
@@ -40,7 +40,7 @@ Supported phases: `configure`<!-- -->, `discover`<!-- -->, `load`
|
|
|
40
40
|
| --- | --- | --- | --- |
|
|
41
41
|
| [app](./socketio.socketiobooter.app.md) | | [Application](./core.application.md) | |
|
|
42
42
|
| [socketioControllerConfig](./socketio.socketiobooter.socketiocontrollerconfig.md) | | [ArtifactOptions](./boot.artifactoptions.md) | |
|
|
43
|
-
| [socketioServer](./socketio.socketiobooter.socketioserver.md) |
|
|
43
|
+
| [socketioServer](./socketio.socketiobooter.socketioserver.md) | <code>protected</code> | [SocketIoServer](./socketio.socketioserver.md) | |
|
|
44
44
|
|
|
45
45
|
## Methods
|
|
46
46
|
|
|
@@ -32,6 +32,6 @@ export declare class SocketIoConnectionContext extends Context
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [socket](./socketio.socketioconnectioncontext.socket.md) |
|
|
35
|
+
| [socket](./socketio.socketioconnectioncontext.socket.md) | <code>readonly</code> | Socket | |
|
|
36
36
|
|
|
37
37
|
|
|
@@ -31,7 +31,7 @@ export declare class SocketIoControllerFactory
|
|
|
31
31
|
|
|
32
32
|
| Property | Modifiers | Type | Description |
|
|
33
33
|
| --- | --- | --- | --- |
|
|
34
|
-
| [connCtx](./socketio.socketiocontrollerfactory.connctx.md) |
|
|
34
|
+
| [connCtx](./socketio.socketiocontrollerfactory.connctx.md) | <code>readonly</code> | [SocketIoConnectionContext](./socketio.socketioconnectioncontext.md) | |
|
|
35
35
|
|
|
36
36
|
## Methods
|
|
37
37
|
|
|
@@ -39,12 +39,12 @@ export declare class SocketIoControllerFactory
|
|
|
39
39
|
| --- | --- | --- |
|
|
40
40
|
| [connect()](./socketio.socketiocontrollerfactory.connect.md) | | |
|
|
41
41
|
| [create()](./socketio.socketiocontrollerfactory.create.md) | | |
|
|
42
|
-
| [getAllMethodMetadataForKey(metadataAccessor)](./socketio.socketiocontrollerfactory.getallmethodmetadataforkey.md) |
|
|
42
|
+
| [getAllMethodMetadataForKey(metadataAccessor)](./socketio.socketiocontrollerfactory.getallmethodmetadataforkey.md) | <code>protected</code> | |
|
|
43
43
|
| [getCallback(methodName)](./socketio.socketiocontrollerfactory.getcallback.md) | | |
|
|
44
44
|
| [getDecoratedMethodsForConnect()](./socketio.socketiocontrollerfactory.getdecoratedmethodsforconnect.md) | | |
|
|
45
|
-
| [getDecorateSubscribeMethods()](./socketio.socketiocontrollerfactory.getdecoratesubscribemethods.md) |
|
|
45
|
+
| [getDecorateSubscribeMethods()](./socketio.socketiocontrollerfactory.getdecoratesubscribemethods.md) | <code>protected</code> | |
|
|
46
46
|
| [getDecorateSubscribeMethodsByEventName()](./socketio.socketiocontrollerfactory.getdecoratesubscribemethodsbyeventname.md) | | |
|
|
47
|
-
| [registerSubscribeMethods()](./socketio.socketiocontrollerfactory.registersubscribemethods.md) |
|
|
47
|
+
| [registerSubscribeMethods()](./socketio.socketiocontrollerfactory.registersubscribemethods.md) | <code>protected</code> | |
|
|
48
48
|
| [setup()](./socketio.socketiocontrollerfactory.setup.md) | | Set up the controller for the given socket |
|
|
49
49
|
|
|
50
50
|
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.socketio.socketioinvokemethodprovider.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class SocketIoInvokeMethodProvider implements Provider<SocketIoInvokeMethod>
|
|
20
20
|
```
|
|
21
|
-
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[SocketIoInvokeMethod](./socketio.socketioinvokemethod.md)
|
|
21
|
+
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[SocketIoInvokeMethod](./socketio.socketioinvokemethod.md)<!-- -->>
|
|
22
22
|
|
|
23
23
|
## Constructors
|
|
24
24
|
|
|
@@ -23,9 +23,9 @@ export interface SocketIoMetadata
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [name?](./socketio.socketiometadata.name.md) | string | <i>(Optional)</i> |
|
|
29
|
-
| [namespace?](./socketio.socketiometadata.namespace.md) | string \| RegExp | <i>(Optional)</i> |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [name?](./socketio.socketiometadata.name.md) | | string | <i>(Optional)</i> |
|
|
29
|
+
| [namespace?](./socketio.socketiometadata.namespace.md) | | string \| RegExp | <i>(Optional)</i> |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.socketio.socketiorejectprovider.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class SocketIoRejectProvider implements Provider<SocketIoRejectMethod>
|
|
20
20
|
```
|
|
21
|
-
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[SocketIoRejectMethod](./socketio.socketiorejectmethod.md)
|
|
21
|
+
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[SocketIoRejectMethod](./socketio.socketiorejectmethod.md)<!-- -->>
|
|
22
22
|
|
|
23
23
|
## Methods
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.socketio.socketiosendprovider.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class SocketIoSendProvider implements Provider<SocketIoSendMethod>
|
|
20
20
|
```
|
|
21
|
-
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[SocketIoSendMethod](./socketio.socketiosendmethod.md)
|
|
21
|
+
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[SocketIoSendMethod](./socketio.socketiosendmethod.md)<!-- -->>
|
|
22
22
|
|
|
23
23
|
## Methods
|
|
24
24
|
|
|
@@ -33,10 +33,10 @@ export declare class SocketIoServer extends Context
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
35
|
| [app](./socketio.socketioserver.app.md) | | [Application](./core.application.md) | |
|
|
36
|
-
| [config](./socketio.socketioserver.config.md) |
|
|
37
|
-
| [listening](./socketio.socketioserver.listening.md) |
|
|
38
|
-
| [options](./socketio.socketioserver.options.md) |
|
|
39
|
-
| [url](./socketio.socketioserver.url.md) |
|
|
36
|
+
| [config](./socketio.socketioserver.config.md) | <code>readonly</code> | [HttpServerResolvedOptions](./socketio.httpserverresolvedoptions.md) | |
|
|
37
|
+
| [listening](./socketio.socketioserver.listening.md) | <code>readonly</code> | boolean | |
|
|
38
|
+
| [options](./socketio.socketioserver.options.md) | <code>protected</code> | [SocketIoServerOptions](./socketio.socketioserveroptions.md) | |
|
|
39
|
+
| [url](./socketio.socketioserver.url.md) | <code>readonly</code> | string | |
|
|
40
40
|
|
|
41
41
|
## Methods
|
|
42
42
|
|