@loopback/docs 5.1.1 → 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 +8 -0
- 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.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.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.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.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.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.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.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.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.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.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.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.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 +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/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/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +8 -0
- package/site/changelogs/examples/access-control-migration/CHANGELOG.md +8 -0
- package/site/changelogs/examples/binding-resolution/CHANGELOG.md +8 -0
- package/site/changelogs/examples/context/CHANGELOG.md +8 -0
- package/site/changelogs/examples/express-composition/CHANGELOG.md +8 -0
- package/site/changelogs/examples/file-transfer/CHANGELOG.md +8 -0
- package/site/changelogs/examples/graphql/CHANGELOG.md +8 -0
- package/site/changelogs/examples/greeter-extension/CHANGELOG.md +8 -0
- package/site/changelogs/examples/greeting-app/CHANGELOG.md +8 -0
- package/site/changelogs/examples/hello-world/CHANGELOG.md +8 -0
- package/site/changelogs/examples/lb3-application/CHANGELOG.md +11 -0
- package/site/changelogs/examples/log-extension/CHANGELOG.md +11 -0
- package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +8 -0
- package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +11 -0
- package/site/changelogs/examples/passport-login/CHANGELOG.md +8 -0
- package/site/changelogs/examples/references-many/CHANGELOG.md +8 -0
- package/site/changelogs/examples/rest-crud/CHANGELOG.md +11 -0
- package/site/changelogs/examples/rpc-server/CHANGELOG.md +8 -0
- package/site/changelogs/examples/soap-calculator/CHANGELOG.md +8 -0
- package/site/changelogs/examples/socketio/CHANGELOG.md +8 -0
- package/site/changelogs/examples/todo/CHANGELOG.md +8 -0
- package/site/changelogs/examples/todo-jwt/CHANGELOG.md +11 -0
- package/site/changelogs/examples/todo-list/CHANGELOG.md +8 -0
- package/site/changelogs/examples/validation-app/CHANGELOG.md +8 -0
- package/site/changelogs/examples/webpack/CHANGELOG.md +8 -0
- package/site/changelogs/extensions/apiconnect/CHANGELOG.md +8 -0
- package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +8 -0
- package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +8 -0
- package/site/changelogs/extensions/context-explorer/CHANGELOG.md +8 -0
- package/site/changelogs/extensions/cron/CHANGELOG.md +8 -0
- package/site/changelogs/extensions/graphql/CHANGELOG.md +8 -0
- package/site/changelogs/extensions/health/CHANGELOG.md +8 -0
- package/site/changelogs/extensions/logging/CHANGELOG.md +8 -0
- package/site/changelogs/extensions/metrics/CHANGELOG.md +8 -0
- package/site/changelogs/extensions/pooling/CHANGELOG.md +8 -0
- package/site/changelogs/extensions/socketio/CHANGELOG.md +8 -0
- package/site/changelogs/extensions/typeorm/CHANGELOG.md +8 -0
- package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +8 -0
- package/site/changelogs/packages/authentication/CHANGELOG.md +8 -0
- package/site/changelogs/packages/authorization/CHANGELOG.md +8 -0
- package/site/changelogs/packages/boot/CHANGELOG.md +11 -0
- package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +8 -0
- package/site/changelogs/packages/build/CHANGELOG.md +8 -0
- package/site/changelogs/packages/cli/CHANGELOG.md +24 -0
- package/site/changelogs/packages/context/CHANGELOG.md +8 -0
- package/site/changelogs/packages/core/CHANGELOG.md +11 -0
- package/site/changelogs/packages/eslint-config/CHANGELOG.md +8 -0
- package/site/changelogs/packages/express/CHANGELOG.md +8 -0
- package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +8 -0
- package/site/changelogs/packages/http-server/CHANGELOG.md +8 -0
- package/site/changelogs/packages/metadata/CHANGELOG.md +8 -0
- package/site/changelogs/packages/model-api-builder/CHANGELOG.md +8 -0
- package/site/changelogs/packages/monorepo/CHANGELOG.md +8 -0
- package/site/changelogs/packages/openapi-v3/CHANGELOG.md +8 -0
- package/site/changelogs/packages/repository/CHANGELOG.md +12 -0
- package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +8 -0
- package/site/changelogs/packages/repository-tests/CHANGELOG.md +8 -0
- package/site/changelogs/packages/rest/CHANGELOG.md +8 -0
- package/site/changelogs/packages/rest-crud/CHANGELOG.md +11 -0
- package/site/changelogs/packages/rest-explorer/CHANGELOG.md +8 -0
- package/site/changelogs/packages/security/CHANGELOG.md +8 -0
- package/site/changelogs/packages/service-proxy/CHANGELOG.md +8 -0
- package/site/changelogs/packages/testlab/CHANGELOG.md +8 -0
- package/site/changelogs/packages/tsdocs/CHANGELOG.md +8 -0
|
@@ -24,9 +24,9 @@ export declare class BindingKey<ValueType>
|
|
|
24
24
|
| Property | Modifiers | Type | Description |
|
|
25
25
|
| --- | --- | --- | --- |
|
|
26
26
|
| [CONFIG\_NAMESPACE](./context.bindingkey.config_namespace.md) | <code>static</code> | string | Name space for configuration binding keys |
|
|
27
|
-
| [key](./context.bindingkey.key.md) |
|
|
28
|
-
| [PROPERTY\_SEPARATOR](./context.bindingkey.property_separator.md) | <code>static</code> | (not declared) | |
|
|
29
|
-
| [propertyPath?](./context.bindingkey.propertypath.md) |
|
|
27
|
+
| [key](./context.bindingkey.key.md) | <code>readonly</code> | string | |
|
|
28
|
+
| [PROPERTY\_SEPARATOR](./context.bindingkey.property_separator.md) | <p><code>readonly</code></p><p><code>static</code></p> | (not declared) | |
|
|
29
|
+
| [propertyPath?](./context.bindingkey.propertypath.md) | <code>readonly</code> | string \| undefined | <i>(Optional)</i> |
|
|
30
30
|
|
|
31
31
|
## Methods
|
|
32
32
|
|
|
@@ -35,7 +35,7 @@ export declare class BindingKey<ValueType>
|
|
|
35
35
|
| [buildKeyForConfig(key)](./context.bindingkey.buildkeyforconfig.md) | <code>static</code> | Build a binding key for the configuration of the given binding. The format is <code><key>:$config</code> |
|
|
36
36
|
| [create(key, propertyPath)](./context.bindingkey.create.md) | <code>static</code> | Create a new key for a binding bound to a value of type <code>ValueType</code>. |
|
|
37
37
|
| [deepProperty(propertyPath)](./context.bindingkey.deepproperty.md) | | Get a binding address for retrieving a deep property of the object bound to the current binding key. |
|
|
38
|
-
| [generate(namespace)](./context.bindingkey.generate.md) | <code>static</code> | Generate a universally unique binding key
|
|
38
|
+
| [generate(namespace)](./context.bindingkey.generate.md) | <code>static</code> | <p>Generate a universally unique binding key.</p><p>Please note the format of they generated key is not specified, you must not rely on any specific formatting (e.g. UUID style).</p> |
|
|
39
39
|
| [parseKeyWithPath(keyWithPath)](./context.bindingkey.parsekeywithpath.md) | <code>static</code> | Parse a string containing both the binding key and the path to the deeply nested property to retrieve. |
|
|
40
40
|
| [toString()](./context.bindingkey.tostring.md) | | |
|
|
41
41
|
| [validate(key)](./context.bindingkey.validate.md) | <code>static</code> | Validate the binding key format. Please note that <code>#</code> is reserved. Returns a string representation of the binding key. |
|
|
@@ -29,7 +29,7 @@ export declare enum BindingScope
|
|
|
29
29
|
| CONTEXT | <code>"Context"</code> | |
|
|
30
30
|
| REQUEST | <code>"Request"</code> | Request scope |
|
|
31
31
|
| SERVER | <code>"Server"</code> | Server scope |
|
|
32
|
-
| SINGLETON | <code>"Singleton"</code> | The binding provides a value as a singleton within the context hierarchy (the owning context and its descendants). The value is calculated only once for the owning context and cached for subsequential uses. Child contexts share the same value as their ancestors
|
|
33
|
-
| TRANSIENT | <code>"Transient"</code> | The binding provides a value that is calculated each time. This will be the default scope if not set
|
|
32
|
+
| SINGLETON | <code>"Singleton"</code> | <p>The binding provides a value as a singleton within the context hierarchy (the owning context and its descendants). The value is calculated only once for the owning context and cached for subsequential uses. Child contexts share the same value as their ancestors.</p><p>For example, with the following context hierarchy:</p><p>- <code>app</code> (with a binding <code>'b1'</code> that produces sequential values 0, 1, ...) - req1 - req2</p><p>1. <code>0</code> is the singleton for <code>app</code> afterward - app.get('b1') ==<!-- -->> 0 (always)</p><p>2. <code>'b1'</code> is resolved in <code>app</code>, reuse it for <code>req1</code> - req1.get('b1') ==<!-- -->> 0 (always)</p><p>3. <code>'b1'</code> is resolved in <code>app</code>, reuse it for <code>req2</code> - req2.get('b1') ==<!-- -->> 0 (always)</p> |
|
|
33
|
+
| TRANSIENT | <code>"Transient"</code> | <p>The binding provides a value that is calculated each time. This will be the default scope if not set.</p><p>For example, with the following context hierarchy:</p><p>- <code>app</code> (with a binding <code>'b1'</code> that produces sequential values 0, 1, ...) - req1 - req2</p><p>Now <code>'b1'</code> is resolved to a new value each time for <code>app</code> and its descendants <code>req1</code> and <code>req2</code>: - app.get('b1') ==<!-- -->> 0 - req1.get('b1') ==<!-- -->> 1 - req2.get('b1') ==<!-- -->> 2 - req2.get('b1') ==<!-- -->> 3 - app.get('b1') ==<!-- -->> 4</p> |
|
|
34
34
|
|
|
35
35
|
|
|
@@ -24,8 +24,8 @@ export interface BindingTagFilter extends BindingFilter
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [bindingTagPattern](./context.bindingtagfilter.bindingtagpattern.md) | [BindingTag](./context.bindingtag.md) \| RegExp | A special property on the filter function to provide access to the binding tag pattern which can be utilized to optimize the matching of bindings by tag in a context. |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [bindingTagPattern](./context.bindingtagfilter.bindingtagpattern.md) | | [BindingTag](./context.bindingtag.md) \| RegExp | A special property on the filter function to provide access to the binding tag pattern which can be utilized to optimize the matching of bindings by tag in a context. |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -24,9 +24,9 @@ export interface ConfigInjectionMetadata extends InjectionMetadata
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [fromBinding?](./context.configinjectionmetadata.frombinding.md) | [BindingAddress](./context.bindingaddress.md) | <i>(Optional)</i> Customize the target binding key from which the configuration is fetched. If not specified, the configuration of the current binding that contains the injection is used. |
|
|
30
|
-
| [propertyPath?](./context.configinjectionmetadata.propertypath.md) | string | <i>(Optional)</i> Property path to retrieve the configuration of the target binding, for example, <code>rest.host</code>. |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [fromBinding?](./context.configinjectionmetadata.frombinding.md) | | [BindingAddress](./context.bindingaddress.md) | <i>(Optional)</i> Customize the target binding key from which the configuration is fetched. If not specified, the configuration of the current binding that contains the injection is used. |
|
|
30
|
+
| [propertyPath?](./context.configinjectionmetadata.propertypath.md) | | string | <i>(Optional)</i> Property path to retrieve the configuration of the target binding, for example, <code>rest.host</code>. |
|
|
31
31
|
|
|
32
32
|
|
|
@@ -25,7 +25,7 @@ find<ValueType = BoundValue>(pattern?: string | RegExp | BindingFilter): Readonl
|
|
|
25
25
|
|
|
26
26
|
| Parameter | Type | Description |
|
|
27
27
|
| --- | --- | --- |
|
|
28
|
-
| pattern | string \| RegExp \| [BindingFilter](./context.bindingfilter.md) | <i>(Optional)</i> A filter function, a regexp or a wildcard pattern with optional <code>*</code> and <code>?</code>. Find returns such bindings where the key matches the provided pattern
|
|
28
|
+
| pattern | string \| RegExp \| [BindingFilter](./context.bindingfilter.md) | <p><i>(Optional)</i> A filter function, a regexp or a wildcard pattern with optional <code>*</code> and <code>?</code>. Find returns such bindings where the key matches the provided pattern.</p><p>For a wildcard: - <code>*</code> matches zero or more characters except <code>.</code> and <code>:</code> - <code>?</code> matches exactly one character except <code>.</code> and <code>:</code></p><p>For a filter function: - return <code>true</code> to include the binding in the results - return <code>false</code> to exclude it.</p> |
|
|
29
29
|
|
|
30
30
|
<b>Returns:</b>
|
|
31
31
|
|
|
@@ -32,28 +32,28 @@ export declare class Context extends EventEmitter
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [\_debug](./context.context._debug.md) |
|
|
36
|
-
| [\_parent?](./context.context._parent.md) |
|
|
37
|
-
| [configResolver](./context.context.configresolver.md) |
|
|
38
|
-
| [name](./context.context.name.md) |
|
|
39
|
-
| [registry](./context.context.registry.md) |
|
|
35
|
+
| [\_debug](./context.context._debug.md) | <code>protected</code> | Debugger | A debug function which can be overridden by subclasses. |
|
|
36
|
+
| [\_parent?](./context.context._parent.md) | <code>protected</code> | [Context](./context.context.md) | <i>(Optional)</i> Parent context |
|
|
37
|
+
| [configResolver](./context.context.configresolver.md) | <code>protected</code> | [ConfigurationResolver](./context.configurationresolver.md) | Configuration resolver |
|
|
38
|
+
| [name](./context.context.name.md) | <code>readonly</code> | string | Name of the context |
|
|
39
|
+
| [registry](./context.context.registry.md) | <p><code>protected</code></p><p><code>readonly</code></p> | Map<string, [Binding](./context.binding.md)<!-- -->> | Key to binding map as the internal registry |
|
|
40
40
|
| [scope](./context.context.scope.md) | | [BindingScope](./context.bindingscope.md) | Scope for binding resolution |
|
|
41
|
-
| [subscriptionManager](./context.context.subscriptionmanager.md) |
|
|
42
|
-
| [tagIndexer](./context.context.tagindexer.md) |
|
|
41
|
+
| [subscriptionManager](./context.context.subscriptionmanager.md) | <code>readonly</code> | [ContextSubscriptionManager](./context.contextsubscriptionmanager.md) | Manager for observer subscriptions |
|
|
42
|
+
| [tagIndexer](./context.context.tagindexer.md) | <p><code>protected</code></p><p><code>readonly</code></p> | ContextTagIndexer | Indexer for bindings by tag |
|
|
43
43
|
|
|
44
44
|
## Methods
|
|
45
45
|
|
|
46
46
|
| Method | Modifiers | Description |
|
|
47
47
|
| --- | --- | --- |
|
|
48
|
-
| [\_findByTagIndex(tag)](./context.context._findbytagindex.md) |
|
|
49
|
-
| [\_mergeWithParent(childList, parentList)](./context.context._mergewithparent.md) |
|
|
48
|
+
| [\_findByTagIndex(tag)](./context.context._findbytagindex.md) | <code>protected</code> | Find bindings by tag leveraging indexes |
|
|
49
|
+
| [\_mergeWithParent(childList, parentList)](./context.context._mergewithparent.md) | <code>protected</code> | |
|
|
50
50
|
| [add(binding)](./context.context.add.md) | | Add a binding to the context. If a locked binding already exists with the same key, an error will be thrown. |
|
|
51
51
|
| [bind(key)](./context.context.bind.md) | | Create a binding with the given key in the context. If a locked binding already exists with the same key, an error will be thrown. |
|
|
52
52
|
| [close()](./context.context.close.md) | | Close the context: clear observers, stop notifications, and remove event listeners from its parent context. |
|
|
53
|
-
| [configure(key)](./context.context.configure.md) | | Create a corresponding binding for configuration of the target bound by the given key in the context
|
|
53
|
+
| [configure(key)](./context.context.configure.md) | | <p>Create a corresponding binding for configuration of the target bound by the given key in the context.</p><p>For example, <code>ctx.configure('controllers.MyController').to({x: 1})</code> will create binding <code>controllers.MyController:$config</code> with value <code>{x: 1}</code>.</p> |
|
|
54
54
|
| [contains(key)](./context.context.contains.md) | | Check if a binding exists with the given key in the local context without delegating to the parent context |
|
|
55
55
|
| [createView(filter, comparator, options)](./context.context.createview.md) | | Create a view of the context chain with the given binding filter |
|
|
56
|
-
| [debug(args)](./context.context.debug.md) |
|
|
56
|
+
| [debug(args)](./context.context.debug.md) | <code>protected</code> | Wrap the debug statement so that it always print out the context name as the prefix |
|
|
57
57
|
| [emitError(err)](./context.context.emiterror.md) | | Emit an <code>error</code> event |
|
|
58
58
|
| [emitEvent(type, event)](./context.context.emitevent.md) | | A strongly-typed method to emit context events |
|
|
59
59
|
| [find(pattern)](./context.context.find.md) | | Find bindings using a key pattern or filter function |
|
|
@@ -66,12 +66,12 @@ export declare class Context extends EventEmitter
|
|
|
66
66
|
| [getConfig(key, propertyPath, resolutionOptions)](./context.context.getconfig.md) | | Resolve configuration for the binding by key |
|
|
67
67
|
| [getConfigAsValueOrPromise(key, propertyPath, resolutionOptions)](./context.context.getconfigasvalueorpromise.md) | | Get the value or promise of configuration for a given binding by key |
|
|
68
68
|
| [getConfigSync(key, propertyPath, resolutionOptions)](./context.context.getconfigsync.md) | | Resolve configuration synchronously for the binding by key |
|
|
69
|
-
| [getDebugNamespace()](./context.context.getdebugnamespace.md) |
|
|
69
|
+
| [getDebugNamespace()](./context.context.getdebugnamespace.md) | <code>protected</code> | Get the debug namespace for the context class. Subclasses can override this method to supply its own namespace. |
|
|
70
70
|
| [getOwnerContext(keyOrBinding)](./context.context.getownercontext.md) | | Get the owning context for a binding or its key |
|
|
71
71
|
| [getResolutionContext(binding)](./context.context.getresolutioncontext.md) | | Locate the resolution context for the given binding. Only bindings in the resolution context and its ancestors are visible as dependencies to resolve the given binding |
|
|
72
72
|
| [getScopedContext(scope)](./context.context.getscopedcontext.md) | | Get the context matching the scope |
|
|
73
|
-
| [getSync(keyWithPath, session)](./context.context.getsync.md) | | Get the synchronous value bound to the given key, optionally return a (deep) property of the bound value
|
|
74
|
-
| [getSync(keyWithPath, options)](./context.context.getsync_1.md) | | Get the synchronous value bound to the given key, optionally return a (deep) property of the bound value
|
|
73
|
+
| [getSync(keyWithPath, session)](./context.context.getsync.md) | | <p>Get the synchronous value bound to the given key, optionally return a (deep) property of the bound value.</p><p>This method throws an error if the bound value requires async computation (returns a promise). You should never rely on sync bindings in production code.</p> |
|
|
74
|
+
| [getSync(keyWithPath, options)](./context.context.getsync_1.md) | | <p>Get the synchronous value bound to the given key, optionally return a (deep) property of the bound value.</p><p>This method throws an error if the bound value requires async computation (returns a promise). You should never rely on sync bindings in production code.</p> |
|
|
75
75
|
| [inspect(options)](./context.context.inspect.md) | | Inspect the context and dump out a JSON object representing the context hierarchy |
|
|
76
76
|
| [isBound(key)](./context.context.isbound.md) | | Check if a key is bound in the context or its ancestors |
|
|
77
77
|
| [isSubscribed(observer)](./context.context.issubscribed.md) | | Check if an observer is subscribed to this context |
|
|
@@ -80,7 +80,7 @@ export declare class Context extends EventEmitter
|
|
|
80
80
|
| [on(event, listener)](./context.context.on_1.md) | | |
|
|
81
81
|
| [once(eventName, listener)](./context.context.once.md) | | The "bind" event is emitted when a new binding is added to the context. The "unbind" event is emitted when an existing binding is removed. |
|
|
82
82
|
| [once(event, listener)](./context.context.once_1.md) | | |
|
|
83
|
-
| [setupConfigurationResolverIfNeeded()](./context.context.setupconfigurationresolverifneeded.md) |
|
|
83
|
+
| [setupConfigurationResolverIfNeeded()](./context.context.setupconfigurationresolverifneeded.md) | <code>protected</code> | Set up the configuration resolver if needed |
|
|
84
84
|
| [subscribe(observer)](./context.context.subscribe.md) | | Add a context event observer to the context |
|
|
85
85
|
| [toJSON()](./context.context.tojson.md) | | Create a plain JSON object for the context |
|
|
86
86
|
| [unbind(key)](./context.context.unbind.md) | | Unbind a binding from the context. No parent contexts will be checked. |
|
|
@@ -24,8 +24,8 @@ export interface ContextInspectOptions extends BindingInspectOptions
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [includeParent?](./context.contextinspectoptions.includeparent.md) | boolean | <i>(Optional)</i> The flag to control if parent context should be inspected |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [includeParent?](./context.contextinspectoptions.includeparent.md) | | boolean | <i>(Optional)</i> The flag to control if parent context should be inspected |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -23,9 +23,9 @@ export interface ContextObserver
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [filter?](./context.contextobserver.filter.md) | [BindingFilter](./context.bindingfilter.md) | <i>(Optional)</i> An optional filter function to match bindings. If not present, the listener will be notified of all binding events. |
|
|
29
|
-
| [observe](./context.contextobserver.observe.md) | [ContextObserverFn](./context.contextobserverfn.md) | Listen on <code>bind</code>, <code>unbind</code>, or other events |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [filter?](./context.contextobserver.filter.md) | | [BindingFilter](./context.bindingfilter.md) | <i>(Optional)</i> An optional filter function to match bindings. If not present, the listener will be notified of all binding events. |
|
|
29
|
+
| [observe](./context.contextobserver.observe.md) | | [ContextObserverFn](./context.contextobserverfn.md) | Listen on <code>bind</code>, <code>unbind</code>, or other events |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -32,9 +32,9 @@ export declare class ContextSubscriptionManager extends EventEmitter
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [\_observers](./context.contextsubscriptionmanager._observers.md) |
|
|
36
|
-
| [\_parentContextEventListener?](./context.contextsubscriptionmanager._parentcontexteventlistener.md) |
|
|
37
|
-
| [context](./context.contextsubscriptionmanager.context.md) |
|
|
35
|
+
| [\_observers](./context.contextsubscriptionmanager._observers.md) | <code>protected</code> | Set<[ContextEventObserver](./context.contexteventobserver.md)<!-- -->> \| undefined | A list of registered context observers. The Set will be created when the first observer is added. |
|
|
36
|
+
| [\_parentContextEventListener?](./context.contextsubscriptionmanager._parentcontexteventlistener.md) | <code>protected</code> | [ContextEventListener](./context.contexteventlistener.md) | <i>(Optional)</i> A listener to watch parent context events |
|
|
37
|
+
| [context](./context.contextsubscriptionmanager.context.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [Context](./context.context.md) | |
|
|
38
38
|
|
|
39
39
|
## Methods
|
|
40
40
|
|
|
@@ -42,9 +42,9 @@ export declare class ContextSubscriptionManager extends EventEmitter
|
|
|
42
42
|
| --- | --- | --- |
|
|
43
43
|
| [close()](./context.contextsubscriptionmanager.close.md) | | Close the context: clear observers, stop notifications, and remove event listeners from its parent context. |
|
|
44
44
|
| [isSubscribed(observer)](./context.contextsubscriptionmanager.issubscribed.md) | | Check if an observer is subscribed to this context |
|
|
45
|
-
| [notifyObservers(event, observers)](./context.contextsubscriptionmanager.notifyobservers.md) |
|
|
45
|
+
| [notifyObservers(event, observers)](./context.contextsubscriptionmanager.notifyobservers.md) | <code>protected</code> | Publish an event to the registered observers. Please note the notification is queued and performed asynchronously so that we allow fluent APIs such as <code>ctx.bind('key').to(...).tag(...);</code> and give observers the fully populated binding. |
|
|
46
46
|
| [subscribe(observer)](./context.contextsubscriptionmanager.subscribe.md) | | Add a context event observer to the context |
|
|
47
47
|
| [unsubscribe(observer)](./context.contextsubscriptionmanager.unsubscribe.md) | | Remove the context event observer from the context |
|
|
48
|
-
| [waitUntilPendingNotificationsDone(timeout)](./context.contextsubscriptionmanager.waituntilpendingnotificationsdone.md) | | Wait until observers are notified for all of currently pending notification events
|
|
48
|
+
| [waitUntilPendingNotificationsDone(timeout)](./context.contextsubscriptionmanager.waituntilpendingnotificationsdone.md) | | <p>Wait until observers are notified for all of currently pending notification events.</p><p>This method is for test only to perform assertions after observers are notified for relevant events.</p> |
|
|
49
49
|
|
|
50
50
|
|
|
@@ -38,12 +38,12 @@ export declare class ContextView<T = unknown> extends EventEmitter implements Co
|
|
|
38
38
|
|
|
39
39
|
| Property | Modifiers | Type | Description |
|
|
40
40
|
| --- | --- | --- | --- |
|
|
41
|
-
| [\_cachedBindings](./context.contextview._cachedbindings.md) |
|
|
42
|
-
| [\_cachedValues](./context.contextview._cachedvalues.md) |
|
|
43
|
-
| [bindings](./context.contextview.bindings.md) |
|
|
44
|
-
| [comparator?](./context.contextview.comparator.md) |
|
|
45
|
-
| [context](./context.contextview.context.md) |
|
|
46
|
-
| [filter](./context.contextview.filter.md) |
|
|
41
|
+
| [\_cachedBindings](./context.contextview._cachedbindings.md) | <code>protected</code> | Readonly<[Binding](./context.binding.md)<!-- --><T>>\[\] \| undefined | An array of cached bindings that matches the binding filter |
|
|
42
|
+
| [\_cachedValues](./context.contextview._cachedvalues.md) | <code>protected</code> | Map<Readonly<[Binding](./context.binding.md)<!-- --><T>>, T> \| undefined | A map of cached values by binding |
|
|
43
|
+
| [bindings](./context.contextview.bindings.md) | <code>readonly</code> | Readonly<[Binding](./context.binding.md)<!-- --><T>>\[\] | Get the list of matched bindings. If they are not cached, it tries to find them from the context. |
|
|
44
|
+
| [comparator?](./context.contextview.comparator.md) | <code>readonly</code> | [BindingComparator](./context.bindingcomparator.md) \| undefined | <i>(Optional)</i> |
|
|
45
|
+
| [context](./context.contextview.context.md) | <code>readonly</code> | [Context](./context.context.md) | |
|
|
46
|
+
| [filter](./context.contextview.filter.md) | <code>readonly</code> | [BindingFilter](./context.bindingfilter.md) | |
|
|
47
47
|
|
|
48
48
|
## Methods
|
|
49
49
|
|
|
@@ -51,7 +51,7 @@ export declare class ContextView<T = unknown> extends EventEmitter implements Co
|
|
|
51
51
|
| --- | --- | --- |
|
|
52
52
|
| [asGetter(session)](./context.contextview.asgetter.md) | | As a <code>Getter</code> function |
|
|
53
53
|
| [close()](./context.contextview.close.md) | | Stop listening events from the context |
|
|
54
|
-
| [findBindings()](./context.contextview.findbindings.md) |
|
|
54
|
+
| [findBindings()](./context.contextview.findbindings.md) | <code>protected</code> | Find matching bindings and refresh the cache |
|
|
55
55
|
| [observe(event, binding, context)](./context.contextview.observe.md) | | Listen on <code>bind</code> or <code>unbind</code> and invalidate the cache |
|
|
56
56
|
| [on(eventName, listener)](./context.contextview.on.md) | | The "bind" event is emitted when a new binding is added to the view. |
|
|
57
57
|
| [on(eventName, listener)](./context.contextview.on_1.md) | | The "unbind" event is emitted a new binding is removed from the view. |
|
|
@@ -24,8 +24,8 @@ export interface ContextViewEvent<T> extends ContextEvent
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [cachedValue?](./context.contextviewevent.cachedvalue.md) | T | <i>(Optional)</i> Optional cached value for an <code>unbind</code> event |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [cachedValue?](./context.contextviewevent.cachedvalue.md) | | T | <i>(Optional)</i> Optional cached value for an <code>unbind</code> event |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -32,7 +32,7 @@ export declare class DefaultConfigurationResolver implements ConfigurationResolv
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [context](./context.defaultconfigurationresolver.context.md) |
|
|
35
|
+
| [context](./context.defaultconfigurationresolver.context.md) | <code>readonly</code> | [Context](./context.context.md) | |
|
|
36
36
|
|
|
37
37
|
## Methods
|
|
38
38
|
|
|
@@ -37,8 +37,8 @@ export class DynamicGreetingProvider {
|
|
|
37
37
|
|
|
38
38
|
## Properties
|
|
39
39
|
|
|
40
|
-
| Property | Type | Description |
|
|
41
|
-
| --- | --- | --- |
|
|
42
|
-
| [value](./context.dynamicvalueproviderclass.value.md) | (...args: [BoundValue](./context.boundvalue.md)<!-- -->\[\]) => [ValueOrPromise](./context.valueorpromise.md)<!-- --><T> | |
|
|
40
|
+
| Property | Modifiers | Type | Description |
|
|
41
|
+
| --- | --- | --- | --- |
|
|
42
|
+
| [value](./context.dynamicvalueproviderclass.value.md) | | (...args: [BoundValue](./context.boundvalue.md)<!-- -->\[\]) => [ValueOrPromise](./context.valueorpromise.md)<!-- --><T> | |
|
|
43
43
|
|
|
44
44
|
|
|
@@ -32,7 +32,7 @@ export declare class GenericInterceptorChain<C extends Context = Context>
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [getInterceptors](./context.genericinterceptorchain.getinterceptors.md) |
|
|
35
|
+
| [getInterceptors](./context.genericinterceptorchain.getinterceptors.md) | <code>protected</code> | () => [GenericInterceptorOrKey](./context.genericinterceptororkey.md)<!-- --><C>\[\] | A getter for an array of interceptor functions or binding keys |
|
|
36
36
|
|
|
37
37
|
## Methods
|
|
38
38
|
|
|
@@ -25,8 +25,8 @@ export declare namespace inject
|
|
|
25
25
|
| --- | --- |
|
|
26
26
|
| [binding](./context.inject.binding.md) | Inject the binding object for the given key. This is useful if a binding needs to be set up beyond just a constant value allowed by <code>@inject.setter</code>. The injected binding is found or created based on the <code>metadata.bindingCreation</code> option. See <code>BindingCreationPolicy</code> for more details. |
|
|
27
27
|
| [context](./context.inject.context.md) | Inject the context object. |
|
|
28
|
-
| [getter](./context.inject.getter.md) | Inject a function for getting the actual bound value
|
|
29
|
-
| [setter](./context.inject.setter.md) | Inject a function for setting (binding) the given key to a given value. (Only static/constant values are supported, it's not possible to bind a key to a class or a provider.)
|
|
28
|
+
| [getter](./context.inject.getter.md) | <p>Inject a function for getting the actual bound value.</p><p>This is useful when implementing Actions, where the action is instantiated for Sequence constructor, but some of action's dependencies become bound only after other actions have been executed by the sequence.</p><p>See also <code>Getter<T></code>.</p> |
|
|
29
|
+
| [setter](./context.inject.setter.md) | <p>Inject a function for setting (binding) the given key to a given value. (Only static/constant values are supported, it's not possible to bind a key to a class or a provider.)</p><p>This is useful e.g. when implementing Actions that are contributing new Elements.</p><p>See also <code>Setter<T></code>.</p> |
|
|
30
30
|
| [tag](./context.inject.tag.md) | Inject an array of values by a tag pattern string or regexp |
|
|
31
31
|
| [view](./context.inject.view.md) | Inject matching bound values by the filter function |
|
|
32
32
|
|
|
@@ -25,6 +25,6 @@ export declare namespace injectable
|
|
|
25
25
|
|
|
26
26
|
| Function | Description |
|
|
27
27
|
| --- | --- |
|
|
28
|
-
| [provider(specs)](./context.injectable.provider.md) | <code>@injectable.provider</code> to denote a provider class
|
|
28
|
+
| [provider(specs)](./context.injectable.provider.md) | <p><code>@injectable.provider</code> to denote a provider class</p><p>A list of binding scope/tags or template functions to configure the binding</p> |
|
|
29
29
|
|
|
30
30
|
|
|
@@ -24,8 +24,8 @@ export interface InjectBindingMetadata extends InjectionMetadata
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [bindingCreation?](./context.injectbindingmetadata.bindingcreation.md) | [BindingCreationPolicy](./context.bindingcreationpolicy.md) | <i>(Optional)</i> Controls how the underlying binding is resolved/created |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [bindingCreation?](./context.injectbindingmetadata.bindingcreation.md) | | [BindingCreationPolicy](./context.bindingcreationpolicy.md) | <i>(Optional)</i> Controls how the underlying binding is resolved/created |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -23,13 +23,13 @@ export interface Injection<ValueType = BoundValue>
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [bindingSelector](./context.injection.bindingselector.md) | [BindingSelector](./context.bindingselector.md)<!-- --><ValueType> | |
|
|
29
|
-
| [member?](./context.injection.member.md) | string | <i>(Optional)</i> |
|
|
30
|
-
| [metadata](./context.injection.metadata.md) | [InjectionMetadata](./context.injectionmetadata.md) | |
|
|
31
|
-
| [methodDescriptorOrParameterIndex?](./context.injection.methoddescriptororparameterindex.md) | TypedPropertyDescriptor<ValueType> \| number | <i>(Optional)</i> |
|
|
32
|
-
| [resolve?](./context.injection.resolve.md) | [ResolverFunction](./context.resolverfunction.md) | <i>(Optional)</i> |
|
|
33
|
-
| [target](./context.injection.target.md) | Object | |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [bindingSelector](./context.injection.bindingselector.md) | | [BindingSelector](./context.bindingselector.md)<!-- --><ValueType> | |
|
|
29
|
+
| [member?](./context.injection.member.md) | | string | <i>(Optional)</i> |
|
|
30
|
+
| [metadata](./context.injection.metadata.md) | | [InjectionMetadata](./context.injectionmetadata.md) | |
|
|
31
|
+
| [methodDescriptorOrParameterIndex?](./context.injection.methoddescriptororparameterindex.md) | | TypedPropertyDescriptor<ValueType> \| number | <i>(Optional)</i> |
|
|
32
|
+
| [resolve?](./context.injection.resolve.md) | | [ResolverFunction](./context.resolverfunction.md) | <i>(Optional)</i> |
|
|
33
|
+
| [target](./context.injection.target.md) | | Object | |
|
|
34
34
|
|
|
35
35
|
|
|
@@ -21,10 +21,10 @@ export interface InjectionDescriptor
|
|
|
21
21
|
|
|
22
22
|
## Properties
|
|
23
23
|
|
|
24
|
-
| Property | Type | Description |
|
|
25
|
-
| --- | --- | --- |
|
|
26
|
-
| [bindingSelector](./context.injectiondescriptor.bindingselector.md) | [BindingSelector](./context.bindingselector.md) | |
|
|
27
|
-
| [metadata](./context.injectiondescriptor.metadata.md) | [InjectionMetadata](./context.injectionmetadata.md) | |
|
|
28
|
-
| [targetName](./context.injectiondescriptor.targetname.md) | string | |
|
|
24
|
+
| Property | Modifiers | Type | Description |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
| [bindingSelector](./context.injectiondescriptor.bindingselector.md) | | [BindingSelector](./context.bindingselector.md) | |
|
|
27
|
+
| [metadata](./context.injectiondescriptor.metadata.md) | | [InjectionMetadata](./context.injectionmetadata.md) | |
|
|
28
|
+
| [targetName](./context.injectiondescriptor.targetname.md) | | string | |
|
|
29
29
|
|
|
30
30
|
|
|
@@ -23,9 +23,9 @@ export interface InjectionElement
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [type](./context.injectionelement.type.md) | 'injection' | |
|
|
29
|
-
| [value](./context.injectionelement.value.md) | Readonly<[Injection](./context.injection.md)<!-- -->> | |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [type](./context.injectionelement.type.md) | | 'injection' | |
|
|
29
|
+
| [value](./context.injectionelement.value.md) | | Readonly<[Injection](./context.injection.md)<!-- -->> | |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -20,13 +20,13 @@ An object to provide metadata for `@inject`
|
|
|
20
20
|
```typescript
|
|
21
21
|
export interface InjectionMetadata extends Omit<ResolutionOptions, 'session'>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> Omit<[ResolutionOptions](./context.resolutionoptions.md)
|
|
23
|
+
<b>Extends:</b> Omit<[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, 'session'>
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [bindingComparator?](./context.injectionmetadata.bindingcomparator.md) | [BindingComparator](./context.bindingcomparator.md) | <i>(Optional)</i> Optional comparator for matched bindings |
|
|
30
|
-
| [decorator?](./context.injectionmetadata.decorator.md) | string | <i>(Optional)</i> Name of the decorator function, such as <code>@inject</code> or <code>@inject.setter</code>. It's usually set by the decorator implementation. |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [bindingComparator?](./context.injectionmetadata.bindingcomparator.md) | | [BindingComparator](./context.bindingcomparator.md) | <i>(Optional)</i> Optional comparator for matched bindings |
|
|
30
|
+
| [decorator?](./context.injectionmetadata.decorator.md) | | string | <i>(Optional)</i> Name of the decorator function, such as <code>@inject</code> or <code>@inject.setter</code>. It's usually set by the decorator implementation. |
|
|
31
31
|
|
|
32
32
|
|
|
@@ -22,7 +22,7 @@ See https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global\_Objec
|
|
|
22
22
|
```typescript
|
|
23
23
|
export declare class InterceptionHandler<T extends object> implements ProxyHandler<T>
|
|
24
24
|
```
|
|
25
|
-
<b>Implements:</b> ProxyHandler
|
|
25
|
+
<b>Implements:</b> ProxyHandler<T>
|
|
26
26
|
|
|
27
27
|
## Constructors
|
|
28
28
|
|
|
@@ -20,6 +20,6 @@ Interceptor function to intercept method invocations
|
|
|
20
20
|
```typescript
|
|
21
21
|
export interface Interceptor extends GenericInterceptor<InvocationContext>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> [GenericInterceptor](./context.genericinterceptor.md)<!-- --><[InvocationContext](./context.invocationcontext.md)
|
|
23
|
+
<b>Extends:</b> [GenericInterceptor](./context.genericinterceptor.md)<!-- --><[InvocationContext](./context.invocationcontext.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
|
|
@@ -24,10 +24,10 @@ export interface InterceptorBindingOptions extends BindingFromClassOptions
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [global?](./context.interceptorbindingoptions.global.md) | boolean | <i>(Optional)</i> Global or local interceptor |
|
|
30
|
-
| [group?](./context.interceptorbindingoptions.group.md) | string | <i>(Optional)</i> Group name for a global interceptor |
|
|
31
|
-
| [source?](./context.interceptorbindingoptions.source.md) | string \| string\[\] | <i>(Optional)</i> Source filter for a global interceptor |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [global?](./context.interceptorbindingoptions.global.md) | | boolean | <i>(Optional)</i> Global or local interceptor |
|
|
30
|
+
| [group?](./context.interceptorbindingoptions.group.md) | | string | <i>(Optional)</i> Group name for a global interceptor |
|
|
31
|
+
| [source?](./context.interceptorbindingoptions.source.md) | | string \| string\[\] | <i>(Optional)</i> Source filter for a global interceptor |
|
|
32
32
|
|
|
33
33
|
|
|
@@ -32,13 +32,13 @@ export declare class InvocationContext extends Context
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [args](./context.invocationcontext.args.md) |
|
|
36
|
-
| [description](./context.invocationcontext.description.md) |
|
|
37
|
-
| [methodName](./context.invocationcontext.methodname.md) |
|
|
38
|
-
| [source?](./context.invocationcontext.source.md) |
|
|
39
|
-
| [target](./context.invocationcontext.target.md) |
|
|
40
|
-
| [targetClass](./context.invocationcontext.targetclass.md) |
|
|
41
|
-
| [targetName](./context.invocationcontext.targetname.md) |
|
|
35
|
+
| [args](./context.invocationcontext.args.md) | <code>readonly</code> | [InvocationArgs](./context.invocationargs.md) | |
|
|
36
|
+
| [description](./context.invocationcontext.description.md) | <code>readonly</code> | string | Description of the invocation |
|
|
37
|
+
| [methodName](./context.invocationcontext.methodname.md) | <code>readonly</code> | string | |
|
|
38
|
+
| [source?](./context.invocationcontext.source.md) | <code>readonly</code> | [InvocationSource](./context.invocationsource.md)<!-- --><unknown> \| undefined | <i>(Optional)</i> |
|
|
39
|
+
| [target](./context.invocationcontext.target.md) | <code>readonly</code> | object | |
|
|
40
|
+
| [targetClass](./context.invocationcontext.targetclass.md) | <code>readonly</code> | Function | The target class, such as <code>OrderController</code> |
|
|
41
|
+
| [targetName](./context.invocationcontext.targetname.md) | <code>readonly</code> | string | The target name, such as <code>OrderController.prototype.cancelOrder</code> |
|
|
42
42
|
|
|
43
43
|
## Methods
|
|
44
44
|
|
|
@@ -23,9 +23,9 @@ export interface InvocationSource<T = unknown>
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [type](./context.invocationsource.type.md) | string | Type of the invoker, such as <code>proxy</code> and <code>route</code> |
|
|
29
|
-
| [value](./context.invocationsource.value.md) | T | Metadata for the source, such as <code>ResolutionSession</code> |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [type](./context.invocationsource.type.md) | <code>readonly</code> | string | Type of the invoker, such as <code>proxy</code> and <code>route</code> |
|
|
29
|
+
| [value](./context.invocationsource.value.md) | <code>readonly</code> | T | Metadata for the source, such as <code>ResolutionSession</code> |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -20,6 +20,6 @@ JSON object
|
|
|
20
20
|
```typescript
|
|
21
21
|
export interface JSONObject extends Record<string, JSONValue>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> Record<string, [JSONValue](./context.jsonvalue.md)
|
|
23
|
+
<b>Extends:</b> Record<string, [JSONValue](./context.jsonvalue.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
|
package/site/apidocs/context.md
CHANGED
|
@@ -23,11 +23,11 @@ permalink: /doc/en/lb4/apidocs.context.html
|
|
|
23
23
|
| [BindingKey](./context.bindingkey.md) | |
|
|
24
24
|
| [Context](./context.context.md) | Context provides an implementation of Inversion of Control (IoC) container |
|
|
25
25
|
| [ContextSubscriptionManager](./context.contextsubscriptionmanager.md) | Manager for context observer subscriptions |
|
|
26
|
-
| [ContextView](./context.contextview.md) | <code>ContextView</code> provides a view for a given context chain to maintain a live list of matching bindings and their resolved values within the context hierarchy
|
|
26
|
+
| [ContextView](./context.contextview.md) | <p><code>ContextView</code> provides a view for a given context chain to maintain a live list of matching bindings and their resolved values within the context hierarchy.</p><p>This class is the key utility to implement dynamic extensions for extension points. For example, the RestServer can react to <code>controller</code> bindings even they are added/removed/updated after the application starts.</p><p><code>ContextView</code> is an event emitter that emits the following events: - 'bind': when a binding is added to the view - 'unbind': when a binding is removed from the view - 'close': when the view is closed (stopped observing context events) - 'refresh': when the view is refreshed as bindings are added/removed - 'resolve': when the cached values are resolved and updated</p> |
|
|
27
27
|
| [DefaultConfigurationResolver](./context.defaultconfigurationresolver.md) | Resolver for configurations of bindings |
|
|
28
28
|
| [GenericInterceptorChain](./context.genericinterceptorchain.md) | A chain of generic interceptors to be invoked for the given context |
|
|
29
29
|
| [InterceptedInvocationContext](./context.interceptedinvocationcontext.md) | A specialized InvocationContext for interceptors |
|
|
30
|
-
| [InterceptionHandler](./context.interceptionhandler.md) | A proxy handler that applies interceptors
|
|
30
|
+
| [InterceptionHandler](./context.interceptionhandler.md) | <p>A proxy handler that applies interceptors</p><p>See https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global\_Objects/Proxy</p> |
|
|
31
31
|
| [InvocationContext](./context.invocationcontext.md) | InvocationContext represents the context to invoke interceptors for a method. The context can be used to access metadata about the invocation as well as other dependencies. |
|
|
32
32
|
| [ProxySource](./context.proxysource.md) | Invocation source for injected proxies. It wraps a snapshot of the <code>ResolutionSession</code> that tracks the binding/injection stack. |
|
|
33
33
|
| [ResolutionError](./context.resolutionerror.md) | Error for context binding resolutions and dependency injections |
|
|
@@ -75,7 +75,7 @@ permalink: /doc/en/lb4/apidocs.context.html
|
|
|
75
75
|
| [injectable(specs)](./context.injectable.md) | Decorate a class with binding configuration |
|
|
76
76
|
| [inspectInjections(binding)](./context.inspectinjections.md) | Inspect injections for a binding created with <code>toClass</code> or <code>toProvider</code> |
|
|
77
77
|
| [inspectTargetType(injection)](./context.inspecttargettype.md) | Inspect the target type for the injection to find out the corresponding JavaScript type |
|
|
78
|
-
| [instantiateClass(ctor, ctx, session, nonInjectedArgs)](./context.instantiateclass.md) | Create an instance of a class which constructor has arguments decorated with <code>@inject</code
|
|
78
|
+
| [instantiateClass(ctor, ctx, session, nonInjectedArgs)](./context.instantiateclass.md) | <p>Create an instance of a class which constructor has arguments decorated with <code>@inject</code>.</p><p>The function returns a class when all dependencies were resolved synchronously, or a Promise otherwise.</p> |
|
|
79
79
|
| [intercept(interceptorOrKeys)](./context.intercept.md) | Decorator function <code>@intercept</code> for classes/methods to apply interceptors. It can be applied on a class and its public methods. Multiple occurrences of <code>@intercept</code> are allowed on the same target class or method. The decorator takes a list of <code>interceptor</code> functions or binding keys. |
|
|
80
80
|
| [invokeInterceptors(context, interceptors)](./context.invokeinterceptors.md) | Invoke a chain of interceptors with the context |
|
|
81
81
|
| [invokeMethod(target, method, ctx, nonInjectedArgs, options)](./context.invokemethod.md) | Invoke a method using dependency injection. Interceptors are invoked as part of the invocation. |
|
|
@@ -85,11 +85,11 @@ permalink: /doc/en/lb4/apidocs.context.html
|
|
|
85
85
|
| [isDynamicValueProviderClass(factory)](./context.isdynamicvalueproviderclass.md) | Check if the factory is a value factory provider class |
|
|
86
86
|
| [isPromiseLike(value)](./context.ispromiselike.md) | Check whether a value is a Promise-like instance. Recognizes both native promises and third-party promise libraries. |
|
|
87
87
|
| [isProviderClass(cls)](./context.isproviderclass.md) | Check if a class implements <code>Provider</code> interface |
|
|
88
|
-
| [mergeInterceptors(interceptorsFromSpec, existingInterceptors)](./context.mergeinterceptors.md) | Adding interceptors from the spec to the front of existing ones. Duplicate entries are eliminated from the spec side
|
|
88
|
+
| [mergeInterceptors(interceptorsFromSpec, existingInterceptors)](./context.mergeinterceptors.md) | <p>Adding interceptors from the spec to the front of existing ones. Duplicate entries are eliminated from the spec side.</p><p>For example:</p><p>- \[log\] + \[cache, log\] =<!-- -->> \[cache, log\] - \[log\] + \[log, cache\] =<!-- -->> \[log, cache\] - \[\] + \[cache, log\] =<!-- -->> \[cache, log\] - \[cache, log\] + \[\] =<!-- -->> \[cache, log\] - \[log\] + \[cache\] =<!-- -->> \[log, cache\]</p> |
|
|
89
89
|
| [registerInterceptor(ctx, interceptor, options)](./context.registerinterceptor.md) | Register an interceptor function or provider class to the given context |
|
|
90
90
|
| [removeNameAndKeyTags(binding)](./context.removenameandkeytags.md) | A binding template function to delete <code>name</code> and <code>key</code> tags |
|
|
91
|
-
| [resolveInjectedArguments(target, method, ctx, session, nonInjectedArgs)](./context.resolveinjectedarguments.md) | Given a function with arguments decorated with <code>@inject</code>, return the list of arguments resolved using the values bound in <code>ctx</code
|
|
92
|
-
| [resolveInjectedProperties(constructor, ctx, session)](./context.resolveinjectedproperties.md) | Given a class with properties decorated with <code>@inject</code>, return the map of properties resolved using the values bound in <code>ctx</code
|
|
91
|
+
| [resolveInjectedArguments(target, method, ctx, session, nonInjectedArgs)](./context.resolveinjectedarguments.md) | <p>Given a function with arguments decorated with <code>@inject</code>, return the list of arguments resolved using the values bound in <code>ctx</code>.</p><p>The function returns an argument array when all dependencies were resolved synchronously, or a Promise otherwise.</p> |
|
|
92
|
+
| [resolveInjectedProperties(constructor, ctx, session)](./context.resolveinjectedproperties.md) | <p>Given a class with properties decorated with <code>@inject</code>, return the map of properties resolved using the values bound in <code>ctx</code>.</p><p>The function returns an argument array when all dependencies were resolved synchronously, or a Promise otherwise.</p> |
|
|
93
93
|
| [resolveList(list, resolver)](./context.resolvelist.md) | Resolve entries of an array into a new array with the same indexes. If one or more entries of the source array are resolved to a promise by the <code>resolver</code> function, this method returns a promise which will be resolved to the new array with fully resolved entries. |
|
|
94
94
|
| [resolveMap(map, resolver)](./context.resolvemap.md) | Resolve entries of an object into a new object with the same keys. If one or more entries of the source object are resolved to a promise by the <code>resolver</code> function, this method returns a promise which will be resolved to the new object with fully resolved entries. |
|
|
95
95
|
| [resolveUntil(source, resolver, evaluator)](./context.resolveuntil.md) | Resolve an iterator of source values into a result until the evaluator returns <code>true</code> |
|
|
@@ -109,7 +109,7 @@ permalink: /doc/en/lb4/apidocs.context.html
|
|
|
109
109
|
| [BindingInspectOptions](./context.bindinginspectoptions.md) | Options for binding.inspect() |
|
|
110
110
|
| [BindingTagFilter](./context.bindingtagfilter.md) | Binding filter function that holds a binding tag pattern. <code>Context.find()</code> uses the <code>bindingTagPattern</code> to optimize the matching of bindings by tag to avoid expensive check for all bindings. |
|
|
111
111
|
| [ConfigInjectionMetadata](./context.configinjectionmetadata.md) | Injection metadata for <code>@config.*</code> |
|
|
112
|
-
| [ConfigurationResolver](./context.configurationresolver.md) | Resolver for configuration of bindings. It's responsible for finding corresponding configuration for a given binding key
|
|
112
|
+
| [ConfigurationResolver](./context.configurationresolver.md) | <p>Resolver for configuration of bindings. It's responsible for finding corresponding configuration for a given binding key.</p><p>By default, <code>undefined</code> is expected if no configuration is provided. The behavior can be overridden by setting <code>optional</code> to <code>false</code> in resolution options.</p> |
|
|
113
113
|
| [ContextInspectOptions](./context.contextinspectoptions.md) | Options for context.inspect() |
|
|
114
114
|
| [ContextObserver](./context.contextobserver.md) | Observers of context bind/unbind events |
|
|
115
115
|
| [ContextViewEvent](./context.contextviewevent.md) | An event emitted by a <code>ContextView</code> |
|
|
@@ -136,7 +136,7 @@ permalink: /doc/en/lb4/apidocs.context.html
|
|
|
136
136
|
|
|
137
137
|
| Namespace | Description |
|
|
138
138
|
| --- | --- |
|
|
139
|
-
| [bind](./context.bind.md) | Alias namespace <code>bind</code> to <code>injectable</code> for backward compatibility
|
|
139
|
+
| [bind](./context.bind.md) | <p>Alias namespace <code>bind</code> to <code>injectable</code> for backward compatibility</p><p>It should have the same members as <code>bind</code>.</p> |
|
|
140
140
|
| [config](./context.config.md) | |
|
|
141
141
|
| [ContextBindings](./context.contextbindings.md) | Namespace for context bindings |
|
|
142
142
|
| [ContextTags](./context.contexttags.md) | Namespace for context tags |
|
|
@@ -206,6 +206,6 @@ permalink: /doc/en/lb4/apidocs.context.html
|
|
|
206
206
|
| [TagMap](./context.tagmap.md) | |
|
|
207
207
|
| [TypeNamespaceMapping](./context.typenamespacemapping.md) | Mapping artifact types to binding key namespaces (prefixes). |
|
|
208
208
|
| [ValueFactory](./context.valuefactory.md) | A factory function for <code>toDynamicValue</code> |
|
|
209
|
-
| [ValueOrPromise](./context.valueorpromise.md) | Representing a value or promise. This type is used to represent results of synchronous/asynchronous resolution of values
|
|
209
|
+
| [ValueOrPromise](./context.valueorpromise.md) | <p>Representing a value or promise. This type is used to represent results of synchronous/asynchronous resolution of values.</p><p>Note that we are using PromiseLike instead of native Promise to describe the asynchronous variant. This allows producers of async values to use any Promise implementation (e.g. Bluebird) instead of native Promises provided by JavaScript runtime.</p> |
|
|
210
210
|
|
|
211
211
|
|