@loopback/docs 5.1.1 → 5.1.3
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 +1292 -1563
- package/package.json +3 -3
- 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._constructor_.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._constructor_.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._constructor_.md +1 -1
- 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.instancewithbooters.md +3 -3
- package/site/apidocs/boot.md +10 -10
- package/site/apidocs/boot.modelapibooter._constructor_.md +1 -1
- package/site/apidocs/boot.modelapibooter.md +1 -1
- 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.binding.toclass.md +2 -2
- 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.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.asgetter.md +1 -1
- package/site/apidocs/context.contextview.md +7 -7
- package/site/apidocs/context.contextviewevent.md +3 -3
- package/site/apidocs/context.createviewgetter.md +1 -1
- package/site/apidocs/context.createviewgetter_1.md +1 -1
- 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.md +2 -2
- 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.instantiateclass.md +1 -1
- 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._constructor_.md +1 -1
- 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.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._constructor_.md +2 -2
- 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.md +9 -9
- package/site/apidocs/openapi-v3.oasenhancer.md +3 -3
- package/site/apidocs/openapi-v3.oasenhancerservice._constructor_.md +1 -1
- package/site/apidocs/openapi-v3.oasenhancerservice.md +1 -1
- 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.tagsdecoratormetadata.md +3 -3
- 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.buildlookupmap.md +1 -1
- package/site/apidocs/repository.connector.md +5 -5
- package/site/apidocs/repository.count.md +3 -3
- package/site/apidocs/repository.createbelongstoaccessor.md +1 -1
- package/site/apidocs/repository.createbelongstoinclusionresolver.md +1 -1
- package/site/apidocs/repository.createhasmanyinclusionresolver.md +1 -1
- package/site/apidocs/repository.createhasmanyrepositoryfactory.md +1 -1
- package/site/apidocs/repository.createhasmanythroughrepositoryfactory.md +2 -2
- package/site/apidocs/repository.createhasonerepositoryfactory.md +1 -1
- package/site/apidocs/repository.createreferencesmanyaccessor.md +1 -1
- package/site/apidocs/repository.createreferencesmanyinclusionresolver.md +1 -1
- 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._constructor_.md +1 -1
- package/site/apidocs/repository.defaultbelongstorepository.md +3 -3
- package/site/apidocs/repository.defaultcrudrepository._createbelongstoaccessorfor.md +1 -1
- package/site/apidocs/repository.defaultcrudrepository._createhasmanyrepositoryfactoryfor.md +1 -1
- package/site/apidocs/repository.defaultcrudrepository._createhasonerepositoryfactoryfor.md +1 -1
- package/site/apidocs/repository.defaultcrudrepository._createreferencesmanyaccessorfor.md +1 -1
- package/site/apidocs/repository.defaultcrudrepository.createbelongstoaccessorfor.md +1 -1
- package/site/apidocs/repository.defaultcrudrepository.createhasmanyrepositoryfactoryfor.md +1 -1
- package/site/apidocs/repository.defaultcrudrepository.createhasmanythroughrepositoryfactoryfor.md +2 -2
- package/site/apidocs/repository.defaultcrudrepository.createhasonerepositoryfactoryfor.md +1 -1
- package/site/apidocs/repository.defaultcrudrepository.createreferencesmanyaccessorfor.md +1 -1
- package/site/apidocs/repository.defaultcrudrepository.md +21 -21
- package/site/apidocs/repository.defaulthasmanyrepository._constructor_.md +1 -1
- package/site/apidocs/repository.defaulthasmanyrepository.md +2 -2
- package/site/apidocs/repository.defaulthasmanythroughrepository._constructor_.md +2 -2
- package/site/apidocs/repository.defaulthasmanythroughrepository.md +4 -4
- package/site/apidocs/repository.defaulthasonerepository._constructor_.md +1 -1
- package/site/apidocs/repository.defaulthasonerepository.md +3 -3
- package/site/apidocs/repository.defaultkeyvaluerepository.md +2 -2
- package/site/apidocs/repository.defaultreferencesmanyrepository._constructor_.md +1 -1
- package/site/apidocs/repository.defaultreferencesmanyrepository.md +2 -2
- 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.repositorymixindoc.md +1 -1
- package/site/apidocs/repository.resolvetype.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.md +3 -3
- package/site/apidocs/rest-crud.crudrestcontrolleroptions.md +4 -4
- package/site/apidocs/rest-crud.modelcrudrestapiconfig.md +4 -4
- 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 +5 -5
- package/site/apidocs/rest.createcontrollerfactoryforbinding.md +1 -1
- package/site/apidocs/rest.createcontrollerfactoryforclass.md +1 -1
- package/site/apidocs/rest.createcontrollerfactoryforinstance.md +1 -1
- package/site/apidocs/rest.createroutesforcontroller.md +1 -1
- 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.httphandler.registercontroller.md +1 -1
- 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.restapplication.route.md +1 -1
- package/site/apidocs/rest.restbindings.https_options.md +1 -1
- 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.restserver.route.md +1 -1
- 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.routingtable.registercontroller.md +1 -1
- 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/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._constructor_.md +2 -2
- 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.createstubinstance.md +1 -1
- 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/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +16 -0
- package/site/changelogs/examples/access-control-migration/CHANGELOG.md +16 -0
- package/site/changelogs/examples/binding-resolution/CHANGELOG.md +16 -0
- package/site/changelogs/examples/context/CHANGELOG.md +16 -0
- package/site/changelogs/examples/express-composition/CHANGELOG.md +16 -0
- package/site/changelogs/examples/file-transfer/CHANGELOG.md +16 -0
- package/site/changelogs/examples/graphql/CHANGELOG.md +16 -0
- package/site/changelogs/examples/greeter-extension/CHANGELOG.md +16 -0
- package/site/changelogs/examples/greeting-app/CHANGELOG.md +16 -0
- package/site/changelogs/examples/hello-world/CHANGELOG.md +16 -0
- package/site/changelogs/examples/lb3-application/CHANGELOG.md +19 -0
- package/site/changelogs/examples/log-extension/CHANGELOG.md +19 -0
- package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +16 -0
- package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +19 -0
- package/site/changelogs/examples/passport-login/CHANGELOG.md +16 -0
- package/site/changelogs/examples/references-many/CHANGELOG.md +16 -0
- package/site/changelogs/examples/rest-crud/CHANGELOG.md +19 -0
- package/site/changelogs/examples/rpc-server/CHANGELOG.md +16 -0
- package/site/changelogs/examples/soap-calculator/CHANGELOG.md +16 -0
- package/site/changelogs/examples/socketio/CHANGELOG.md +16 -0
- package/site/changelogs/examples/todo/CHANGELOG.md +16 -0
- package/site/changelogs/examples/todo-jwt/CHANGELOG.md +19 -0
- package/site/changelogs/examples/todo-list/CHANGELOG.md +16 -0
- package/site/changelogs/examples/validation-app/CHANGELOG.md +16 -0
- package/site/changelogs/examples/webpack/CHANGELOG.md +16 -0
- package/site/changelogs/extensions/apiconnect/CHANGELOG.md +16 -0
- package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +16 -0
- package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +16 -0
- package/site/changelogs/extensions/context-explorer/CHANGELOG.md +16 -0
- package/site/changelogs/extensions/cron/CHANGELOG.md +16 -0
- package/site/changelogs/extensions/graphql/CHANGELOG.md +16 -0
- package/site/changelogs/extensions/health/CHANGELOG.md +16 -0
- package/site/changelogs/extensions/logging/CHANGELOG.md +16 -0
- package/site/changelogs/extensions/metrics/CHANGELOG.md +16 -0
- package/site/changelogs/extensions/pooling/CHANGELOG.md +16 -0
- package/site/changelogs/extensions/socketio/CHANGELOG.md +16 -0
- package/site/changelogs/extensions/typeorm/CHANGELOG.md +16 -0
- package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +16 -0
- package/site/changelogs/packages/authentication/CHANGELOG.md +16 -0
- package/site/changelogs/packages/authorization/CHANGELOG.md +16 -0
- package/site/changelogs/packages/boot/CHANGELOG.md +19 -0
- package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +16 -0
- package/site/changelogs/packages/build/CHANGELOG.md +16 -0
- package/site/changelogs/packages/cli/CHANGELOG.md +32 -0
- package/site/changelogs/packages/context/CHANGELOG.md +16 -0
- package/site/changelogs/packages/core/CHANGELOG.md +19 -0
- package/site/changelogs/packages/eslint-config/CHANGELOG.md +16 -0
- package/site/changelogs/packages/express/CHANGELOG.md +16 -0
- package/site/changelogs/packages/filter/CHANGELOG.md +8 -0
- package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +16 -0
- package/site/changelogs/packages/http-server/CHANGELOG.md +16 -0
- package/site/changelogs/packages/metadata/CHANGELOG.md +16 -0
- package/site/changelogs/packages/model-api-builder/CHANGELOG.md +16 -0
- package/site/changelogs/packages/monorepo/CHANGELOG.md +16 -0
- package/site/changelogs/packages/openapi-spec-builder/CHANGELOG.md +8 -0
- package/site/changelogs/packages/openapi-v3/CHANGELOG.md +16 -0
- package/site/changelogs/packages/repository/CHANGELOG.md +20 -0
- package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +16 -0
- package/site/changelogs/packages/repository-tests/CHANGELOG.md +16 -0
- package/site/changelogs/packages/rest/CHANGELOG.md +16 -0
- package/site/changelogs/packages/rest-crud/CHANGELOG.md +19 -0
- package/site/changelogs/packages/rest-explorer/CHANGELOG.md +16 -0
- package/site/changelogs/packages/security/CHANGELOG.md +16 -0
- package/site/changelogs/packages/service-proxy/CHANGELOG.md +16 -0
- package/site/changelogs/packages/testlab/CHANGELOG.md +19 -0
- package/site/changelogs/packages/tsdocs/CHANGELOG.md +16 -0
- package/site/readmes/loopback-next/extensions/typeorm/README.md +14 -0
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@loopback/docs",
|
|
3
3
|
"description": "Documentation files rendered at [https://loopback.io](https://loopback.io)",
|
|
4
|
-
"version": "5.1.
|
|
4
|
+
"version": "5.1.3",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"LoopBack",
|
|
7
7
|
"docs"
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"tslib": "^2.4.0"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
|
-
"@loopback/build": "^9.0.
|
|
39
|
+
"@loopback/build": "^9.0.4"
|
|
40
40
|
},
|
|
41
|
-
"gitHead": "
|
|
41
|
+
"gitHead": "947500110c84ba77b2197b759b559c195cfce260"
|
|
42
42
|
}
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.myuserservice.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class MyUserService implements UserService<User, Credentials>
|
|
20
20
|
```
|
|
21
|
-
<b>Implements:</b> [UserService](./authentication.userservice.md)<!-- --><[User](./authentication-jwt.user.md)<!-- -->, [Credentials](./authentication-jwt.credentials.md)
|
|
21
|
+
<b>Implements:</b> [UserService](./authentication.userservice.md)<!-- --><[User](./authentication-jwt.user.md)<!-- -->, [Credentials](./authentication-jwt.credentials.md)<!-- -->>
|
|
22
22
|
|
|
23
23
|
## Constructors
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.refreshtokenrepository.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class RefreshTokenRepository extends DefaultCrudRepository<RefreshToken, typeof RefreshToken.prototype.id, RefreshTokenRelations>
|
|
20
20
|
```
|
|
21
|
-
<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- --><[RefreshToken](./authentication-jwt.refreshtoken.md)<!-- -->, typeof [RefreshToken.prototype.id](./authentication-jwt.refreshtoken.id.md)<!-- -->, [RefreshTokenRelations](./authentication-jwt.refreshtokenrelations.md)
|
|
21
|
+
<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- --><[RefreshToken](./authentication-jwt.refreshtoken.md)<!-- -->, typeof [RefreshToken.prototype.id](./authentication-jwt.refreshtoken.id.md)<!-- -->, [RefreshTokenRelations](./authentication-jwt.refreshtokenrelations.md)<!-- -->>
|
|
22
22
|
|
|
23
23
|
## Constructors
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.usercredentialsrepository.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class UserCredentialsRepository extends DefaultCrudRepository<UserCredentials, typeof UserCredentials.prototype.id, UserCredentialsRelations>
|
|
20
20
|
```
|
|
21
|
-
<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- --><[UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->, typeof [UserCredentials.prototype.id](./authentication-jwt.usercredentials.id.md)<!-- -->, [UserCredentialsRelations](./authentication-jwt.usercredentialsrelations.md)
|
|
21
|
+
<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- --><[UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->, typeof [UserCredentials.prototype.id](./authentication-jwt.usercredentials.id.md)<!-- -->, [UserCredentialsRelations](./authentication-jwt.usercredentialsrelations.md)<!-- -->>
|
|
22
22
|
|
|
23
23
|
## Constructors
|
|
24
24
|
|
|
@@ -26,6 +26,6 @@ constructor(dataSource: juggler.DataSource, userCredentialsRepositoryGetter: Get
|
|
|
26
26
|
| Parameter | Type | Description |
|
|
27
27
|
| --- | --- | --- |
|
|
28
28
|
| dataSource | juggler.DataSource | |
|
|
29
|
-
| userCredentialsRepositoryGetter |
|
|
29
|
+
| userCredentialsRepositoryGetter | Getter<[UserCredentialsRepository](./authentication-jwt.usercredentialsrepository.md)<!-- -->> | |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.userrepository.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class UserRepository extends DefaultCrudRepository<User, typeof User.prototype.id, UserRelations>
|
|
20
20
|
```
|
|
21
|
-
<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- --><[User](./authentication-jwt.user.md)<!-- -->, typeof [User.prototype.id](./authentication-jwt.user.id.md)<!-- -->, [UserRelations](./authentication-jwt.userrelations.md)
|
|
21
|
+
<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- --><[User](./authentication-jwt.user.md)<!-- -->, typeof [User.prototype.id](./authentication-jwt.user.id.md)<!-- -->, [UserRelations](./authentication-jwt.userrelations.md)<!-- -->>
|
|
22
22
|
|
|
23
23
|
## Constructors
|
|
24
24
|
|
|
@@ -30,8 +30,8 @@ export declare class UserRepository extends DefaultCrudRepository<User, typeof U
|
|
|
30
30
|
|
|
31
31
|
| Property | Modifiers | Type | Description |
|
|
32
32
|
| --- | --- | --- | --- |
|
|
33
|
-
| [userCredentials](./authentication-jwt.userrepository.usercredentials.md) |
|
|
34
|
-
| [userCredentialsRepositoryGetter](./authentication-jwt.userrepository.usercredentialsrepositorygetter.md) |
|
|
33
|
+
| [userCredentials](./authentication-jwt.userrepository.usercredentials.md) | <code>readonly</code> | [HasOneRepositoryFactory](./repository.hasonerepositoryfactory.md)<!-- --><[UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->, typeof [User.prototype.id](./authentication-jwt.user.id.md)<!-- -->> | |
|
|
34
|
+
| [userCredentialsRepositoryGetter](./authentication-jwt.userrepository.usercredentialsrepositorygetter.md) | <code>protected</code> | Getter<[UserCredentialsRepository](./authentication-jwt.usercredentialsrepository.md)<!-- -->> | |
|
|
35
35
|
|
|
36
36
|
## Methods
|
|
37
37
|
|
|
@@ -32,7 +32,7 @@ export declare class StrategyAdapter<U> implements AuthenticationStrategy
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [name](./authentication-passport.strategyadapter.name.md) |
|
|
35
|
+
| [name](./authentication-passport.strategyadapter.name.md) | <code>readonly</code> | string | |
|
|
36
36
|
|
|
37
37
|
## Methods
|
|
38
38
|
|
|
@@ -25,7 +25,7 @@ constructor(getStrategies: Getter<AuthenticationStrategy | AuthenticationStrateg
|
|
|
25
25
|
|
|
26
26
|
| Parameter | Type | Description |
|
|
27
27
|
| --- | --- | --- |
|
|
28
|
-
| getStrategies |
|
|
28
|
+
| getStrategies | Getter<[AuthenticationStrategy](./authentication.authenticationstrategy.md) \| [AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\] \| undefined> | |
|
|
29
29
|
| setCurrentUser | [Setter](./context.setter.md)<!-- --><[UserProfile](./security.userprofile.md)<!-- -->> | |
|
|
30
30
|
| setRedirectUrl | [Setter](./context.setter.md)<!-- --><string> | |
|
|
31
31
|
| setRedirectStatus | [Setter](./context.setter.md)<!-- --><number> | |
|
|
@@ -20,7 +20,7 @@ Provides the authentication action for a sequence
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare class AuthenticateActionProvider implements Provider<AuthenticateFn>
|
|
22
22
|
```
|
|
23
|
-
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[AuthenticateFn](./authentication.authenticatefn.md)
|
|
23
|
+
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[AuthenticateFn](./authentication.authenticatefn.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
## Example
|
|
26
26
|
|
|
@@ -39,10 +39,10 @@ context.bind('authentication.actions.authenticate').toProvider(AuthenticateActio
|
|
|
39
39
|
|
|
40
40
|
| Property | Modifiers | Type | Description |
|
|
41
41
|
| --- | --- | --- | --- |
|
|
42
|
-
| [getStrategies](./authentication.authenticateactionprovider.getstrategies.md) |
|
|
43
|
-
| [setCurrentUser](./authentication.authenticateactionprovider.setcurrentuser.md) |
|
|
44
|
-
| [setRedirectStatus](./authentication.authenticateactionprovider.setredirectstatus.md) |
|
|
45
|
-
| [setRedirectUrl](./authentication.authenticateactionprovider.setredirecturl.md) |
|
|
42
|
+
| [getStrategies](./authentication.authenticateactionprovider.getstrategies.md) | <code>readonly</code> | Getter<[AuthenticationStrategy](./authentication.authenticationstrategy.md) \| [AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\] \| undefined> | |
|
|
43
|
+
| [setCurrentUser](./authentication.authenticateactionprovider.setcurrentuser.md) | <code>readonly</code> | [Setter](./context.setter.md)<!-- --><[UserProfile](./security.userprofile.md)<!-- -->> | |
|
|
44
|
+
| [setRedirectStatus](./authentication.authenticateactionprovider.setredirectstatus.md) | <code>readonly</code> | [Setter](./context.setter.md)<!-- --><number> | |
|
|
45
|
+
| [setRedirectUrl](./authentication.authenticateactionprovider.setredirecturl.md) | <code>readonly</code> | [Setter](./context.setter.md)<!-- --><string> | |
|
|
46
46
|
|
|
47
47
|
## Methods
|
|
48
48
|
|
|
@@ -23,10 +23,10 @@ export interface AuthenticationMetadata
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [options?](./authentication.authenticationmetadata.options.md) | { \[name: string\]: any; } | <i>(Optional)</i> Options for the authentication strategy |
|
|
29
|
-
| [skip?](./authentication.authenticationmetadata.skip.md) | boolean | <i>(Optional)</i> A flag to skip authentication |
|
|
30
|
-
| [strategy](./authentication.authenticationmetadata.strategy.md) | string | Name of the authentication strategy |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [options?](./authentication.authenticationmetadata.options.md) | | { \[name: string\]: any; } | <i>(Optional)</i> Options for the authentication strategy |
|
|
29
|
+
| [skip?](./authentication.authenticationmetadata.skip.md) | | boolean | <i>(Optional)</i> A flag to skip authentication |
|
|
30
|
+
| [strategy](./authentication.authenticationmetadata.strategy.md) | | string | Name of the authentication strategy |
|
|
31
31
|
|
|
32
32
|
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication.authenticationmiddlewareprovider.h
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class AuthenticationMiddlewareProvider implements Provider<Middleware>
|
|
20
20
|
```
|
|
21
|
-
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[Middleware](./express.middleware.md)
|
|
21
|
+
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[Middleware](./express.middleware.md)<!-- -->>
|
|
22
22
|
|
|
23
23
|
## Constructors
|
|
24
24
|
|
|
@@ -23,9 +23,9 @@ export interface AuthenticationOptions
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [defaultMetadata?](./authentication.authenticationoptions.defaultmetadata.md) | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] | <i>(Optional)</i> Default authentication metadata if a method or class is not decorated with <code>@authenticate</code>. If not set, no default authentication will be enforced for those methods without authentication metadata. |
|
|
29
|
-
| [failOnError?](./authentication.authenticationoptions.failonerror.md) | boolean | <i>(Optional)</i> This flag allows an authentication strategy to abort the authentication by throwing an error if <code>failOnError</code> is set to <code>true</code>. By default, the authentication process continues to the next one even when a strategy throws an error. If one of other strategies succeed, the error will be discarded. |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [defaultMetadata?](./authentication.authenticationoptions.defaultmetadata.md) | | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] | <i>(Optional)</i> Default authentication metadata if a method or class is not decorated with <code>@authenticate</code>. If not set, no default authentication will be enforced for those methods without authentication metadata. |
|
|
29
|
+
| [failOnError?](./authentication.authenticationoptions.failonerror.md) | | boolean | <i>(Optional)</i> This flag allows an authentication strategy to abort the authentication by throwing an error if <code>failOnError</code> is set to <code>true</code>. By default, the authentication process continues to the next one even when a strategy throws an error. If one of other strategies succeed, the error will be discarded. |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -25,9 +25,9 @@ export interface AuthenticationStrategy
|
|
|
25
25
|
|
|
26
26
|
## Properties
|
|
27
27
|
|
|
28
|
-
| Property | Type | Description |
|
|
29
|
-
| --- | --- | --- |
|
|
30
|
-
| [name](./authentication.authenticationstrategy.name.md) | string | The 'name' property is a unique identifier for the authentication strategy ( for example : 'basic', 'jwt', etc) |
|
|
28
|
+
| Property | Modifiers | Type | Description |
|
|
29
|
+
| --- | --- | --- | --- |
|
|
30
|
+
| [name](./authentication.authenticationstrategy.name.md) | | string | The 'name' property is a unique identifier for the authentication strategy ( for example : 'basic', 'jwt', etc) |
|
|
31
31
|
|
|
32
32
|
## Methods
|
|
33
33
|
|
|
@@ -25,7 +25,7 @@ constructor(authenticationStrategies: Getter<AuthenticationStrategy[]>, metadata
|
|
|
25
25
|
|
|
26
26
|
| Parameter | Type | Description |
|
|
27
27
|
| --- | --- | --- |
|
|
28
|
-
| authenticationStrategies |
|
|
28
|
+
| authenticationStrategies | Getter<[AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\]> | |
|
|
29
29
|
| metadata | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined | <i>(Optional)</i> |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -22,7 +22,7 @@ It declares an extension point to which all authentication strategy implementati
|
|
|
22
22
|
```typescript
|
|
23
23
|
export declare class AuthenticationStrategyProvider implements Provider<AuthenticationStrategy[] | undefined>
|
|
24
24
|
```
|
|
25
|
-
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[AuthenticationStrategy](./authentication.authenticationstrategy.md)
|
|
25
|
+
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\] \| undefined>
|
|
26
26
|
|
|
27
27
|
## Example
|
|
28
28
|
|
|
@@ -38,8 +38,8 @@ export declare class AuthenticationStrategyProvider implements Provider<Authenti
|
|
|
38
38
|
|
|
39
39
|
| Property | Modifiers | Type | Description |
|
|
40
40
|
| --- | --- | --- | --- |
|
|
41
|
-
| [authenticationStrategies](./authentication.authenticationstrategyprovider.authenticationstrategies.md) |
|
|
42
|
-
| [metadata?](./authentication.authenticationstrategyprovider.metadata.md) |
|
|
41
|
+
| [authenticationStrategies](./authentication.authenticationstrategyprovider.authenticationstrategies.md) | <code>protected</code> | Getter<[AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\]> | |
|
|
42
|
+
| [metadata?](./authentication.authenticationstrategyprovider.metadata.md) | <code>protected</code> | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined | <i>(Optional)</i> |
|
|
43
43
|
|
|
44
44
|
## Methods
|
|
45
45
|
|
|
@@ -20,7 +20,7 @@ Provides authentication metadata of a controller method
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare class AuthMetadataProvider implements Provider<AuthenticationMetadata[] | undefined>
|
|
22
22
|
```
|
|
23
|
-
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[AuthenticationMetadata](./authentication.authenticationmetadata.md)
|
|
23
|
+
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined>
|
|
24
24
|
|
|
25
25
|
## Example
|
|
26
26
|
|
|
@@ -30,7 +30,7 @@ It contains:
|
|
|
30
30
|
| [AuthenticateActionProvider](./authentication.authenticateactionprovider.md) | Provides the authentication action for a sequence |
|
|
31
31
|
| [AuthenticationComponent](./authentication.authenticationcomponent.md) | |
|
|
32
32
|
| [AuthenticationMiddlewareProvider](./authentication.authenticationmiddlewareprovider.md) | |
|
|
33
|
-
| [AuthenticationStrategyProvider](./authentication.authenticationstrategyprovider.md) | An authentication strategy provider responsible for resolving an authentication strategy by name
|
|
33
|
+
| [AuthenticationStrategyProvider](./authentication.authenticationstrategyprovider.md) | <p>An authentication strategy provider responsible for resolving an authentication strategy by name.</p><p>It declares an extension point to which all authentication strategy implementations must register themselves as extensions.</p> |
|
|
34
34
|
| [AuthMetadataProvider](./authentication.authmetadataprovider.md) | Provides authentication metadata of a controller method |
|
|
35
35
|
|
|
36
36
|
## Functions
|
|
@@ -49,11 +49,11 @@ It contains:
|
|
|
49
49
|
| [AuthenticateFn](./authentication.authenticatefn.md) | interface definition of a function which accepts a request and returns an authenticated user |
|
|
50
50
|
| [AuthenticationMetadata](./authentication.authenticationmetadata.md) | Authentication metadata stored via Reflection API |
|
|
51
51
|
| [AuthenticationOptions](./authentication.authenticationoptions.md) | Options for authentication component |
|
|
52
|
-
| [AuthenticationStrategy](./authentication.authenticationstrategy.md) | An interface that describes the common authentication strategy
|
|
52
|
+
| [AuthenticationStrategy](./authentication.authenticationstrategy.md) | <p>An interface that describes the common authentication strategy.</p><p>An authentication strategy is a class with an 'authenticate' method that verifies a user's credentials and returns the corresponding user profile.</p> |
|
|
53
53
|
| [TokenService](./authentication.tokenservice.md) | An interface for generating and verifying a token |
|
|
54
54
|
| [UserIdentityService](./authentication.useridentityservice.md) | The User Identity service links a user to profiles from an external source (eg: ldap, oauth2 provider, saml) which can identify the user. The profile typically has the following information: name, email-id, uuid, roles, authorizations, scope of accessible resources, expiration time for given access |
|
|
55
55
|
| [UserProfileFactory](./authentication.userprofilefactory.md) | interface definition of a factory function which accepts a user definition and returns the user profile |
|
|
56
|
-
| [UserService](./authentication.userservice.md) | A service for performing the login action in an authentication strategy
|
|
56
|
+
| [UserService](./authentication.userservice.md) | <p>A service for performing the login action in an authentication strategy.</p><p>Usually a client user uses basic credentials to login, or is redirected to a third-party application that grants limited access.</p><p>Note: The creation of user is handled in the user controller by calling user repository APIs. For Basic auth, the user has to register first using some endpoint like <code>/register</code>. For 3rd-party auth, the user will be created if login is successful and the user doesn't exist in database yet.</p><p>Type <code>C</code> stands for the type of your credential object.</p><p>- For local strategy:</p><p>A typical credential would be: { username: username, password: password }</p><p>- For oauth strategy:</p><p>A typical credential would be: { clientId: string; clientSecret: string; callbackURL: string; }</p><p>It could be read from a local configuration file in the app</p><p>- For saml strategy:</p><p>A typical credential would be:</p><p>{ path: string; issuer: string; entryPoint: string; }</p><p>It could be read from a local configuration file in the app.</p> |
|
|
57
57
|
|
|
58
58
|
## Namespaces
|
|
59
59
|
|
|
@@ -23,12 +23,12 @@ export interface AuthorizationContext
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [invocationContext](./authorization.authorizationcontext.invocationcontext.md) | [InvocationContext](./context.invocationcontext.md) | Context for the invocation |
|
|
29
|
-
| [principals](./authorization.authorizationcontext.principals.md) | [Principal](./security.principal.md)<!-- -->\[\] | An array of principals identified for the request - it should come from authentication |
|
|
30
|
-
| [resource](./authorization.authorizationcontext.resource.md) | string | An name for the target resource to be accessed, such as <code>OrderController.prototype.cancelOrder</code> |
|
|
31
|
-
| [roles](./authorization.authorizationcontext.roles.md) | [Role](./security.role.md)<!-- -->\[\] | An array of roles for principals |
|
|
32
|
-
| [scopes](./authorization.authorizationcontext.scopes.md) | string\[\] | An array of scopes representing granted permissions - usually come from access tokens |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [invocationContext](./authorization.authorizationcontext.invocationcontext.md) | | [InvocationContext](./context.invocationcontext.md) | Context for the invocation |
|
|
29
|
+
| [principals](./authorization.authorizationcontext.principals.md) | | [Principal](./security.principal.md)<!-- -->\[\] | An array of principals identified for the request - it should come from authentication |
|
|
30
|
+
| [resource](./authorization.authorizationcontext.resource.md) | | string | An name for the target resource to be accessed, such as <code>OrderController.prototype.cancelOrder</code> |
|
|
31
|
+
| [roles](./authorization.authorizationcontext.roles.md) | | [Role](./security.role.md)<!-- -->\[\] | An array of roles for principals |
|
|
32
|
+
| [scopes](./authorization.authorizationcontext.scopes.md) | | string\[\] | An array of scopes representing granted permissions - usually come from access tokens |
|
|
33
33
|
|
|
34
34
|
|
|
@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authorization.authorizationinterceptor.html
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class AuthorizationInterceptor implements Provider<Interceptor>
|
|
20
20
|
```
|
|
21
|
-
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[Interceptor](./context.interceptor.md)
|
|
21
|
+
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[Interceptor](./context.interceptor.md)<!-- -->>
|
|
22
22
|
|
|
23
23
|
## Constructors
|
|
24
24
|
|
|
@@ -23,13 +23,13 @@ export interface AuthorizationMetadata
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [allowedRoles?](./authorization.authorizationmetadata.allowedroles.md) | string\[\] | <i>(Optional)</i> Roles that are allowed access |
|
|
29
|
-
| [deniedRoles?](./authorization.authorizationmetadata.deniedroles.md) | string\[\] | <i>(Optional)</i> Roles that are denied access |
|
|
30
|
-
| [resource?](./authorization.authorizationmetadata.resource.md) | string | <i>(Optional)</i> Name of the resource, default to the method name |
|
|
31
|
-
| [scopes?](./authorization.authorizationmetadata.scopes.md) | string\[\] | <i>(Optional)</i> Define the access scopes |
|
|
32
|
-
| [skip?](./authorization.authorizationmetadata.skip.md) | boolean | <i>(Optional)</i> A flag to skip authorization |
|
|
33
|
-
| [voters?](./authorization.authorizationmetadata.voters.md) | ([Authorizer](./authorization.authorizer.md) \| [BindingAddress](./context.bindingaddress.md)<!-- --><[Authorizer](./authorization.authorizer.md)<!-- -->>)\[\] | <i>(Optional)</i> Voters that help make the authorization decision |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [allowedRoles?](./authorization.authorizationmetadata.allowedroles.md) | | string\[\] | <i>(Optional)</i> Roles that are allowed access |
|
|
29
|
+
| [deniedRoles?](./authorization.authorizationmetadata.deniedroles.md) | | string\[\] | <i>(Optional)</i> Roles that are denied access |
|
|
30
|
+
| [resource?](./authorization.authorizationmetadata.resource.md) | | string | <i>(Optional)</i> Name of the resource, default to the method name |
|
|
31
|
+
| [scopes?](./authorization.authorizationmetadata.scopes.md) | | string\[\] | <i>(Optional)</i> Define the access scopes |
|
|
32
|
+
| [skip?](./authorization.authorizationmetadata.skip.md) | | boolean | <i>(Optional)</i> A flag to skip authorization |
|
|
33
|
+
| [voters?](./authorization.authorizationmetadata.voters.md) | | ([Authorizer](./authorization.authorizer.md) \| [BindingAddress](./context.bindingaddress.md)<!-- --><[Authorizer](./authorization.authorizer.md)<!-- -->>)\[\] | <i>(Optional)</i> Voters that help make the authorization decision |
|
|
34
34
|
|
|
35
35
|
|
|
@@ -21,11 +21,11 @@ export interface AuthorizationOptions
|
|
|
21
21
|
|
|
22
22
|
## Properties
|
|
23
23
|
|
|
24
|
-
| Property | Type | Description |
|
|
25
|
-
| --- | --- | --- |
|
|
26
|
-
| [defaultDecision?](./authorization.authorizationoptions.defaultdecision.md) | [AuthorizationDecision.DENY](./authorization.authorizationdecision.md) \| [AuthorizationDecision.ALLOW](./authorization.authorizationdecision.md) | <i>(Optional)</i> Default decision if all authorizers vote for ABSTAIN If not set, default to <code>AuthorizationDecision.DENY</code> |
|
|
27
|
-
| [defaultMetadata?](./authorization.authorizationoptions.defaultmetadata.md) | [AuthorizationMetadata](./authorization.authorizationmetadata.md) | <i>(Optional)</i> Default authorization metadata if a method is not decorated with <code>@authorize</code>. If not set, no authorization will be enforced for those methods that are not associated with authorization metadata. |
|
|
28
|
-
| [defaultStatusCodeForDeny?](./authorization.authorizationoptions.defaultstatuscodefordeny.md) | number | <i>(Optional)</i> Default HTTP status code when the final decision is <code>AuthorizationDecision.DENY</code>. If not set, default to 403 |
|
|
29
|
-
| [precedence?](./authorization.authorizationoptions.precedence.md) | [AuthorizationDecision.DENY](./authorization.authorizationdecision.md) \| [AuthorizationDecision.ALLOW](./authorization.authorizationdecision.md) | <i>(Optional)</i> Controls if Allow/Deny vote takes precedence and override other votes. If not set, default to <code>AuthorizationDecision.DENY</code
|
|
24
|
+
| Property | Modifiers | Type | Description |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
| [defaultDecision?](./authorization.authorizationoptions.defaultdecision.md) | | [AuthorizationDecision.DENY](./authorization.authorizationdecision.md) \| [AuthorizationDecision.ALLOW](./authorization.authorizationdecision.md) | <i>(Optional)</i> Default decision if all authorizers vote for ABSTAIN If not set, default to <code>AuthorizationDecision.DENY</code> |
|
|
27
|
+
| [defaultMetadata?](./authorization.authorizationoptions.defaultmetadata.md) | | [AuthorizationMetadata](./authorization.authorizationmetadata.md) | <i>(Optional)</i> Default authorization metadata if a method is not decorated with <code>@authorize</code>. If not set, no authorization will be enforced for those methods that are not associated with authorization metadata. |
|
|
28
|
+
| [defaultStatusCodeForDeny?](./authorization.authorizationoptions.defaultstatuscodefordeny.md) | | number | <i>(Optional)</i> Default HTTP status code when the final decision is <code>AuthorizationDecision.DENY</code>. If not set, default to 403 |
|
|
29
|
+
| [precedence?](./authorization.authorizationoptions.precedence.md) | | [AuthorizationDecision.DENY](./authorization.authorizationdecision.md) \| [AuthorizationDecision.ALLOW](./authorization.authorizationdecision.md) | <p><i>(Optional)</i> Controls if Allow/Deny vote takes precedence and override other votes. If not set, default to <code>AuthorizationDecision.DENY</code>.</p><p>Once a vote matches the <code>precedence</code>, it becomes the final decision. The rest of votes will be skipped.</p> |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -23,11 +23,11 @@ export interface AuthorizationRequest
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [action](./authorization.authorizationrequest.action.md) | string | The operation that the requestor performs on the resource. |
|
|
29
|
-
| [domain?](./authorization.authorizationrequest.domain.md) | string | <i>(Optional)</i> The domain (realm/tenant) |
|
|
30
|
-
| [object](./authorization.authorizationrequest.object.md) | string | The resource that is going to be accessed. |
|
|
31
|
-
| [subject](./authorization.authorizationrequest.subject.md) | string | The requestor that wants to access a resource. |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [action](./authorization.authorizationrequest.action.md) | | string | The operation that the requestor performs on the resource. |
|
|
29
|
+
| [domain?](./authorization.authorizationrequest.domain.md) | | string | <i>(Optional)</i> The domain (realm/tenant) |
|
|
30
|
+
| [object](./authorization.authorizationrequest.object.md) | | string | The resource that is going to be accessed. |
|
|
31
|
+
| [subject](./authorization.authorizationrequest.subject.md) | | string | The requestor that wants to access a resource. |
|
|
32
32
|
|
|
33
33
|
|
|
@@ -18,12 +18,12 @@ permalink: /doc/en/lb4/apidocs.authorization.authorizemethoddecoratorfactory.htm
|
|
|
18
18
|
```typescript
|
|
19
19
|
export declare class AuthorizeMethodDecoratorFactory extends MethodDecoratorFactory<AuthorizationMetadata>
|
|
20
20
|
```
|
|
21
|
-
<b>Extends:</b> [MethodDecoratorFactory](./metadata.methoddecoratorfactory.md)<!-- --><[AuthorizationMetadata](./authorization.authorizationmetadata.md)
|
|
21
|
+
<b>Extends:</b> [MethodDecoratorFactory](./metadata.methoddecoratorfactory.md)<!-- --><[AuthorizationMetadata](./authorization.authorizationmetadata.md)<!-- -->>
|
|
22
22
|
|
|
23
23
|
## Methods
|
|
24
24
|
|
|
25
25
|
| Method | Modifiers | Description |
|
|
26
26
|
| --- | --- | --- |
|
|
27
|
-
| [mergeWithOwn(ownMetadata, target, methodName, methodDescriptor)](./authorization.authorizemethoddecoratorfactory.mergewithown.md) |
|
|
27
|
+
| [mergeWithOwn(ownMetadata, target, methodName, methodDescriptor)](./authorization.authorizemethoddecoratorfactory.mergewithown.md) | <code>protected</code> | |
|
|
28
28
|
|
|
29
29
|
|
|
@@ -38,21 +38,21 @@ export declare class BaseArtifactBooter implements Booter
|
|
|
38
38
|
|
|
39
39
|
| Property | Modifiers | Type | Description |
|
|
40
40
|
| --- | --- | --- | --- |
|
|
41
|
-
| [artifactName](./boot.baseartifactbooter.artifactname.md) |
|
|
41
|
+
| [artifactName](./boot.baseartifactbooter.artifactname.md) | <code>readonly</code> | string | Get the name of the artifact loaded by this booter, e.g. "Controller". Subclasses can override the default logic based on the class name. |
|
|
42
42
|
| [classes](./boot.baseartifactbooter.classes.md) | | [Constructor](./context.constructor.md)<!-- --><{}>\[\] | List of exported classes discovered in the files |
|
|
43
43
|
| [dirs](./boot.baseartifactbooter.dirs.md) | | string\[\] | Relative paths of directories to be searched |
|
|
44
44
|
| [discovered](./boot.baseartifactbooter.discovered.md) | | string\[\] | List of files discovered by the Booter that matched artifact requirements |
|
|
45
45
|
| [extensions](./boot.baseartifactbooter.extensions.md) | | string\[\] | File extensions to be searched |
|
|
46
46
|
| [glob](./boot.baseartifactbooter.glob.md) | | string | <code>glob</code> pattern to match artifact paths |
|
|
47
|
-
| [options](./boot.baseartifactbooter.options.md) |
|
|
48
|
-
| [projectRoot](./boot.baseartifactbooter.projectroot.md) |
|
|
47
|
+
| [options](./boot.baseartifactbooter.options.md) | <code>readonly</code> | [ArtifactOptions](./boot.artifactoptions.md) | Options being used by the Booter. |
|
|
48
|
+
| [projectRoot](./boot.baseartifactbooter.projectroot.md) | <code>readonly</code> | string | Project root relative to which all other paths are resolved |
|
|
49
49
|
|
|
50
50
|
## Methods
|
|
51
51
|
|
|
52
52
|
| Method | Modifiers | Description |
|
|
53
53
|
| --- | --- | --- |
|
|
54
|
-
| [configure()](./boot.baseartifactbooter.configure.md) | | Configure the Booter by initializing the 'dirs', 'extensions' and 'glob' properties
|
|
54
|
+
| [configure()](./boot.baseartifactbooter.configure.md) | | <p>Configure the Booter by initializing the 'dirs', 'extensions' and 'glob' properties.</p><p>NOTE: All properties are configured even if all aren't used.</p> |
|
|
55
55
|
| [discover()](./boot.baseartifactbooter.discover.md) | | Discover files based on the 'glob' property relative to the 'projectRoot'. Discovered artifact files matching the pattern are saved to the 'discovered' property. |
|
|
56
|
-
| [load()](./boot.baseartifactbooter.load.md) | | Filters the exports of 'discovered' files to only be Classes (in case function / types are exported) as an artifact is a Class. The filtered artifact Classes are saved in the 'classes' property
|
|
56
|
+
| [load()](./boot.baseartifactbooter.load.md) | | <p>Filters the exports of 'discovered' files to only be Classes (in case function / types are exported) as an artifact is a Class. The filtered artifact Classes are saved in the 'classes' property.</p><p>NOTE: Booters extending this class should call this method (await super.load()) and then process the artifact classes as appropriate.</p> |
|
|
57
57
|
|
|
58
58
|
|
|
@@ -23,10 +23,10 @@ export interface Bootable
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [bootOptions?](./boot.bootable.bootoptions.md) | [BootOptions](./boot.bootoptions.md) | <i>(Optional)</i> Options for boot |
|
|
29
|
-
| [projectRoot](./boot.bootable.projectroot.md) | string | Root directory for the project to be booted |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [bootOptions?](./boot.bootable.bootoptions.md) | | [BootOptions](./boot.bootoptions.md) | <i>(Optional)</i> Options for boot |
|
|
29
|
+
| [projectRoot](./boot.bootable.projectroot.md) | | string | Root directory for the project to be booted |
|
|
30
30
|
|
|
31
31
|
## Methods
|
|
32
32
|
|
|
@@ -23,8 +23,8 @@ export interface InstanceWithBooters
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [booters?](./boot.instancewithbooters.booters.md) | [Constructor](./context.constructor.md)<!-- --><[Booter](./boot.booter.md)<!-- -->>\[\] | <i>(Optional)</i> |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [booters?](./boot.instancewithbooters.booters.md) | | [Constructor](./context.constructor.md)<!-- --><[Booter](./boot.booter.md)<!-- -->>\[\] | <i>(Optional)</i> |
|
|
29
29
|
|
|
30
30
|
|
package/site/apidocs/boot.md
CHANGED
|
@@ -28,17 +28,17 @@ A Bootstrapper is needed to manage the Booters and execute them. This is provide
|
|
|
28
28
|
| Class | Description |
|
|
29
29
|
| --- | --- |
|
|
30
30
|
| [ApplicationMetadataBooter](./boot.applicationmetadatabooter.md) | Configure the application with metadata from <code>package.json</code> |
|
|
31
|
-
| [BaseArtifactBooter](./boot.baseartifactbooter.md) | This class serves as a base class for Booters which follow a pattern of configure, discover files in a folder(s) using explicit folder / extensions or a glob pattern and lastly identifying exported classes from such files and performing an action on such files such as binding them
|
|
31
|
+
| [BaseArtifactBooter](./boot.baseartifactbooter.md) | <p>This class serves as a base class for Booters which follow a pattern of configure, discover files in a folder(s) using explicit folder / extensions or a glob pattern and lastly identifying exported classes from such files and performing an action on such files such as binding them.</p><p>Any Booter extending this base class is expected to</p><p>1. Set the 'options' property to a object of ArtifactOptions type. (Each extending class should provide defaults for the ArtifactOptions and use Object.assign to merge the properties with user provided Options). 2. Provide it's own logic for 'load' after calling 'await super.load()' to actually boot the Artifact classes.</p><p>Currently supports the following boot phases: configure, discover, load.</p> |
|
|
32
32
|
| [BootComponent](./boot.bootcomponent.md) | BootComponent is used to export the default list of Booter's made available by this module as well as bind the BootStrapper to the app so it can be used to run the Booters. |
|
|
33
|
-
| [Bootstrapper](./boot.bootstrapper.md) | The Bootstrapper class provides the <code>boot</code> function that is responsible for finding and executing the Booters in an application based on given options
|
|
34
|
-
| [ControllerBooter](./boot.controllerbooter.md) | A class that extends BaseArtifactBooter to boot the 'Controller' artifact type. Discovered controllers are bound using <code>app.controller()</code
|
|
35
|
-
| [DataSourceBooter](./boot.datasourcebooter.md) | A class that extends BaseArtifactBooter to boot the 'DataSource' artifact type. Discovered DataSources are bound using <code>app.dataSource()</code
|
|
36
|
-
| [InterceptorProviderBooter](./boot.interceptorproviderbooter.md) | A class that extends BaseArtifactBooter to boot the 'InterceptorProvider' artifact type
|
|
37
|
-
| [LifeCycleObserverBooter](./boot.lifecycleobserverbooter.md) | A class that extends BaseArtifactBooter to boot the 'LifeCycleObserver' artifact type
|
|
33
|
+
| [Bootstrapper](./boot.bootstrapper.md) | <p>The Bootstrapper class provides the <code>boot</code> function that is responsible for finding and executing the Booters in an application based on given options.</p><p>NOTE: Bootstrapper should be bound as a SINGLETON so it can be cached as it does not maintain any state of it's own.</p> |
|
|
34
|
+
| [ControllerBooter](./boot.controllerbooter.md) | <p>A class that extends BaseArtifactBooter to boot the 'Controller' artifact type. Discovered controllers are bound using <code>app.controller()</code>.</p><p>Supported phases: configure, discover, load</p> |
|
|
35
|
+
| [DataSourceBooter](./boot.datasourcebooter.md) | <p>A class that extends BaseArtifactBooter to boot the 'DataSource' artifact type. Discovered DataSources are bound using <code>app.dataSource()</code>.</p><p>Supported phases: configure, discover, load</p> |
|
|
36
|
+
| [InterceptorProviderBooter](./boot.interceptorproviderbooter.md) | <p>A class that extends BaseArtifactBooter to boot the 'InterceptorProvider' artifact type.</p><p>Supported phases: configure, discover, load</p> |
|
|
37
|
+
| [LifeCycleObserverBooter](./boot.lifecycleobserverbooter.md) | <p>A class that extends BaseArtifactBooter to boot the 'LifeCycleObserver' artifact type.</p><p>Supported phases: configure, discover, load</p> |
|
|
38
38
|
| [ModelApiBooter](./boot.modelapibooter.md) | |
|
|
39
|
-
| [ModelBooter](./boot.modelbooter.md) | A class that extends BaseArtifactBooter to boot the 'Model' artifact type
|
|
40
|
-
| [RepositoryBooter](./boot.repositorybooter.md) | A class that extends BaseArtifactBooter to boot the 'Repository' artifact type. Discovered repositories are bound using <code>app.repository()</code> which must be added to an Application using the <code>RepositoryMixin</code> from <code>@loopback/repository</code
|
|
41
|
-
| [ServiceBooter](./boot.servicebooter.md) | A class that extends BaseArtifactBooter to boot the 'Service' artifact type. Discovered services are bound using <code>app.service()</code
|
|
39
|
+
| [ModelBooter](./boot.modelbooter.md) | <p>A class that extends BaseArtifactBooter to boot the 'Model' artifact type.</p><p>Supported phases: configure, discover, load</p> |
|
|
40
|
+
| [RepositoryBooter](./boot.repositorybooter.md) | <p>A class that extends BaseArtifactBooter to boot the 'Repository' artifact type. Discovered repositories are bound using <code>app.repository()</code> which must be added to an Application using the <code>RepositoryMixin</code> from <code>@loopback/repository</code>.</p><p>Supported phases: configure, discover, load</p> |
|
|
41
|
+
| [ServiceBooter](./boot.servicebooter.md) | <p>A class that extends BaseArtifactBooter to boot the 'Service' artifact type. Discovered services are bound using <code>app.service()</code>.</p><p>Supported phases: configure, discover, load</p> |
|
|
42
42
|
|
|
43
43
|
## Functions
|
|
44
44
|
|
|
@@ -58,7 +58,7 @@ A Bootstrapper is needed to manage the Booters and execute them. This is provide
|
|
|
58
58
|
| Interface | Description |
|
|
59
59
|
| --- | --- |
|
|
60
60
|
| [Bootable](./boot.bootable.md) | Interface to describe the additions made available to an Application that uses BootMixin. |
|
|
61
|
-
| [Booter](./boot.booter.md) | Defines the requirements to implement a Booter for LoopBack applications: - configure() - discover() - load()
|
|
61
|
+
| [Booter](./boot.booter.md) | <p>Defines the requirements to implement a Booter for LoopBack applications: - configure() - discover() - load()</p><p>A Booter will run through the above methods in order.</p> |
|
|
62
62
|
| [InstanceWithBooters](./boot.instancewithbooters.md) | Interface to describe an object that may have an array of <code>booters</code>. |
|
|
63
63
|
|
|
64
64
|
## Namespaces
|
|
@@ -27,7 +27,7 @@ constructor(app: ApplicationWithRepositories, projectRoot: string, getModelApiBu
|
|
|
27
27
|
| --- | --- | --- |
|
|
28
28
|
| app | [ApplicationWithRepositories](./repository.applicationwithrepositories.md) | |
|
|
29
29
|
| projectRoot | string | |
|
|
30
|
-
| getModelApiBuilders |
|
|
30
|
+
| getModelApiBuilders | Getter<[ModelApiBuilder](./model-api-builder.modelapibuilder.md)<!-- -->\[\]> | |
|
|
31
31
|
| booterConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
|
|
32
32
|
|
|
33
33
|
|
|
@@ -32,7 +32,7 @@ export declare class ModelApiBooter extends BaseArtifactBooter
|
|
|
32
32
|
| --- | --- | --- | --- |
|
|
33
33
|
| [app](./boot.modelapibooter.app.md) | | [ApplicationWithRepositories](./repository.applicationwithrepositories.md) | |
|
|
34
34
|
| [booterConfig](./boot.modelapibooter.booterconfig.md) | | [ArtifactOptions](./boot.artifactoptions.md) | |
|
|
35
|
-
| [getModelApiBuilders](./boot.modelapibooter.getmodelapibuilders.md) | |
|
|
35
|
+
| [getModelApiBuilders](./boot.modelapibooter.getmodelapibuilders.md) | | Getter<[ModelApiBuilder](./model-api-builder.modelapibuilder.md)<!-- -->\[\]> | |
|
|
36
36
|
|
|
37
37
|
## Methods
|
|
38
38
|
|
|
@@ -31,9 +31,9 @@ export declare class ContextBinding
|
|
|
31
31
|
|
|
32
32
|
| Property | Modifiers | Type | Description |
|
|
33
33
|
| --- | --- | --- | --- |
|
|
34
|
-
| [binding](./context-explorer.contextbinding.binding.md) |
|
|
35
|
-
| [context](./context-explorer.contextbinding.context.md) |
|
|
36
|
-
| [id](./context-explorer.contextbinding.id.md) |
|
|
37
|
-
| [level](./context-explorer.contextbinding.level.md) |
|
|
34
|
+
| [binding](./context-explorer.contextbinding.binding.md) | <code>readonly</code> | [JSONObject](./context.jsonobject.md) | |
|
|
35
|
+
| [context](./context-explorer.contextbinding.context.md) | <code>readonly</code> | [JSONObject](./context.jsonobject.md) | |
|
|
36
|
+
| [id](./context-explorer.contextbinding.id.md) | <code>readonly</code> | string | |
|
|
37
|
+
| [level](./context-explorer.contextbinding.level.md) | <code>readonly</code> | number | |
|
|
38
38
|
|
|
39
39
|
|
|
@@ -33,7 +33,7 @@ export declare class ContextGraph
|
|
|
33
33
|
| --- | --- | --- |
|
|
34
34
|
| [build()](./context-explorer.contextgraph.build.md) | | Build a direct graph |
|
|
35
35
|
| [render()](./context-explorer.contextgraph.render.md) | | Render the context graph in graphviz dot format |
|
|
36
|
-
| [renderBinding(parent, { binding, id })](./context-explorer.contextgraph.renderbinding.md) |
|
|
37
|
-
| [renderConfig(parent, { binding, level, id })](./context-explorer.contextgraph.renderconfig.md) |
|
|
36
|
+
| [renderBinding(parent, { binding, id })](./context-explorer.contextgraph.renderbinding.md) | <code>protected</code> | Render a binding object |
|
|
37
|
+
| [renderConfig(parent, { binding, level, id })](./context-explorer.contextgraph.renderconfig.md) | <code>protected</code> | Create an edge for a binding to its configuration |
|
|
38
38
|
|
|
39
39
|
|
|
@@ -33,14 +33,14 @@ export declare class Binding<T = BoundValue> extends EventEmitter
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
35
|
| [isLocked](./context.binding.islocked.md) | | boolean | |
|
|
36
|
-
| [key](./context.binding.key.md) |
|
|
37
|
-
| [providerConstructor](./context.binding.providerconstructor.md) |
|
|
38
|
-
| [scope](./context.binding.scope.md) |
|
|
39
|
-
| [source](./context.binding.source.md) |
|
|
40
|
-
| [tagMap](./context.binding.tagmap.md) |
|
|
41
|
-
| [tagNames](./context.binding.tagnames.md) |
|
|
42
|
-
| [type](./context.binding.type.md) |
|
|
43
|
-
| [valueConstructor](./context.binding.valueconstructor.md) |
|
|
36
|
+
| [key](./context.binding.key.md) | <code>readonly</code> | string | Key of the binding |
|
|
37
|
+
| [providerConstructor](./context.binding.providerconstructor.md) | <code>readonly</code> | [Constructor](./context.constructor.md)<!-- --><[Provider](./context.provider.md)<!-- --><T>> \| undefined | For bindings bound via <code>toProvider()</code>, this property contains the constructor function of the provider class |
|
|
38
|
+
| [scope](./context.binding.scope.md) | <code>readonly</code> | [BindingScope](./context.bindingscope.md) | Scope of the binding to control how the value is cached/shared |
|
|
39
|
+
| [source](./context.binding.source.md) | <code>readonly</code> | [BindingSource](./context.bindingsource.md)<!-- --><T> \| undefined | |
|
|
40
|
+
| [tagMap](./context.binding.tagmap.md) | <code>readonly</code> | [TagMap](./context.tagmap.md) | Map for tag name/value pairs |
|
|
41
|
+
| [tagNames](./context.binding.tagnames.md) | <code>readonly</code> | string\[\] | Get an array of tag names |
|
|
42
|
+
| [type](./context.binding.type.md) | <code>readonly</code> | [BindingType](./context.bindingtype.md) \| undefined | Type of the binding value getter |
|
|
43
|
+
| [valueConstructor](./context.binding.valueconstructor.md) | <code>readonly</code> | [Constructor](./context.constructor.md)<!-- --><T> \| undefined | For bindings bound via <code>toClass()</code>, this property contains the constructor function of the class |
|
|
44
44
|
|
|
45
45
|
## Methods
|
|
46
46
|
|
|
@@ -50,7 +50,7 @@ export declare class Binding<T = BoundValue> extends EventEmitter
|
|
|
50
50
|
| [applyDefaultScope(scope)](./context.binding.applydefaultscope.md) | | Apply default scope to the binding. It only changes the scope if it's not set yet |
|
|
51
51
|
| [bind(key)](./context.binding.bind.md) | <code>static</code> | A static method to create a binding so that we can do <code>Binding.bind('foo').to('bar');</code> as <code>new Binding('foo').to('bar')</code> is not easy to read. |
|
|
52
52
|
| [configure(key)](./context.binding.configure.md) | <code>static</code> | Create a configuration binding for the given key |
|
|
53
|
-
| [getValue(ctx, session)](./context.binding.getvalue.md) | | This is an internal function optimized for performance. Users should use <code>@inject(key)</code> or <code>ctx.get(key)</code> instead
|
|
53
|
+
| [getValue(ctx, session)](./context.binding.getvalue.md) | | <p>This is an internal function optimized for performance. Users should use <code>@inject(key)</code> or <code>ctx.get(key)</code> instead.</p><p>Get the value bound to this key. Depending on <code>isSync</code>, this function returns either: - the bound value - a promise of the bound value</p><p>Consumers wishing to consume sync values directly should use <code>isPromiseLike</code> to check the type of the returned value to decide how to handle it.</p> |
|
|
54
54
|
| [getValue(ctx, options)](./context.binding.getvalue_1.md) | | Returns a value or promise for this binding in the given context. The resolved value can be <code>undefined</code> if <code>optional</code> is set to <code>true</code> in <code>options</code>. |
|
|
55
55
|
| [inScope(scope)](./context.binding.inscope.md) | | Set the binding scope |
|
|
56
56
|
| [inspect(options)](./context.binding.inspect.md) | | Inspect the binding to return a json representation of the binding information |
|
|
@@ -65,9 +65,9 @@ export declare class Binding<T = BoundValue> extends EventEmitter
|
|
|
65
65
|
| [toAlias(keyWithPath)](./context.binding.toalias.md) | | Bind the key to an alias of another binding |
|
|
66
66
|
| [toClass(ctor)](./context.binding.toclass.md) | | Bind the key to an instance of the given class. |
|
|
67
67
|
| [toDynamicValue(factory)](./context.binding.todynamicvalue.md) | | Bind the key to a computed (dynamic) value. |
|
|
68
|
-
| [toInjectable(ctor)](./context.binding.toinjectable.md) | | Bind to a class optionally decorated with <code>@injectable</code>. Based on the introspection of the class, it calls <code>toClass/toProvider/toDynamicValue</code> internally. The current binding key will be preserved (not being overridden by the key inferred from the class or options)
|
|
68
|
+
| [toInjectable(ctor)](./context.binding.toinjectable.md) | | <p>Bind to a class optionally decorated with <code>@injectable</code>. Based on the introspection of the class, it calls <code>toClass/toProvider/toDynamicValue</code> internally. The current binding key will be preserved (not being overridden by the key inferred from the class or options).</p><p>This is similar to [createBindingFromClass()](./context.createbindingfromclass.md) but applies to an existing binding.</p> |
|
|
69
69
|
| [toJSON()](./context.binding.tojson.md) | | Convert to a plain JSON object |
|
|
70
|
-
| [toProvider(providerClass)](./context.binding.toprovider.md) | | Bind the key to a value computed by a Provider
|
|
70
|
+
| [toProvider(providerClass)](./context.binding.toprovider.md) | | <p>Bind the key to a value computed by a Provider.</p><p>\*</p> |
|
|
71
71
|
| [unlock()](./context.binding.unlock.md) | | Unlock the binding |
|
|
72
72
|
|
|
73
73
|
|