@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,8 +24,8 @@ export interface Notification extends ContextEvent
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [observers](./context.notification.observers.md) | Set<[ContextEventObserver](./context.contexteventobserver.md)<!-- -->> | A snapshot of observers when the original event is emitted |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [observers](./context.notification.observers.md) | | Set<[ContextEventObserver](./context.contexteventobserver.md)<!-- -->> | A snapshot of observers when the original event is emitted |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -20,7 +20,7 @@ Invocation source for injected proxies. It wraps a snapshot of the `ResolutionSe
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare class ProxySource implements InvocationSource<ResolutionSession>
|
|
22
22
|
```
|
|
23
|
-
<b>Implements:</b> [InvocationSource](./context.invocationsource.md)<!-- --><[ResolutionSession](./context.resolutionsession.md)
|
|
23
|
+
<b>Implements:</b> [InvocationSource](./context.invocationsource.md)<!-- --><[ResolutionSession](./context.resolutionsession.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
## Constructors
|
|
26
26
|
|
|
@@ -33,7 +33,7 @@ export declare class ProxySource implements InvocationSource<ResolutionSession>
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
35
|
| [type](./context.proxysource.type.md) | | string | |
|
|
36
|
-
| [value](./context.proxysource.value.md) |
|
|
36
|
+
| [value](./context.proxysource.value.md) | <code>readonly</code> | [ResolutionSession](./context.resolutionsession.md) | |
|
|
37
37
|
|
|
38
38
|
## Methods
|
|
39
39
|
|
|
@@ -23,10 +23,10 @@ export interface ResolutionContext<T = unknown>
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [binding](./context.resolutioncontext.binding.md) | Readonly<[Binding](./context.binding.md)<!-- --><T>> | The binding to be resolved |
|
|
29
|
-
| [context](./context.resolutioncontext.context.md) | [Context](./context.context.md) | The context for resolution |
|
|
30
|
-
| [options](./context.resolutioncontext.options.md) | [ResolutionOptions](./context.resolutionoptions.md) | The options used for resolution |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [binding](./context.resolutioncontext.binding.md) | <code>readonly</code> | Readonly<[Binding](./context.binding.md)<!-- --><T>> | The binding to be resolved |
|
|
29
|
+
| [context](./context.resolutioncontext.context.md) | <code>readonly</code> | [Context](./context.context.md) | The context for resolution |
|
|
30
|
+
| [options](./context.resolutioncontext.options.md) | <code>readonly</code> | [ResolutionOptions](./context.resolutionoptions.md) | The options used for resolution |
|
|
31
31
|
|
|
32
32
|
|
|
@@ -32,6 +32,6 @@ export declare class ResolutionError extends Error
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [resolutionCtx](./context.resolutionerror.resolutionctx.md) |
|
|
35
|
+
| [resolutionCtx](./context.resolutionerror.resolutionctx.md) | <code>readonly</code> | Partial<[ResolutionContext](./context.resolutioncontext.md)<!-- -->> | |
|
|
36
36
|
|
|
37
37
|
|
|
@@ -23,10 +23,10 @@ export interface ResolutionOptions
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [asProxyWithInterceptors?](./context.resolutionoptions.asproxywithinterceptors.md) | boolean | <i>(Optional)</i> A boolean flag to control if a proxy should be created to apply interceptors for the resolved value. It's only honored for bindings backed by a class. |
|
|
29
|
-
| [optional?](./context.resolutionoptions.optional.md) | boolean | <i>(Optional)</i> A boolean flag to indicate if the dependency is optional. If it's set to <code>true</code> and the binding is not bound in a context, the resolution will return <code>undefined</code> instead of throwing an error. |
|
|
30
|
-
| [session?](./context.resolutionoptions.session.md) | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> A session to track bindings and injections |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [asProxyWithInterceptors?](./context.resolutionoptions.asproxywithinterceptors.md) | | boolean | <i>(Optional)</i> A boolean flag to control if a proxy should be created to apply interceptors for the resolved value. It's only honored for bindings backed by a class. |
|
|
29
|
+
| [optional?](./context.resolutionoptions.optional.md) | | boolean | <i>(Optional)</i> A boolean flag to indicate if the dependency is optional. If it's set to <code>true</code> and the binding is not bound in a context, the resolution will return <code>undefined</code> instead of throwing an error. |
|
|
30
|
+
| [session?](./context.resolutionoptions.session.md) | | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> A session to track bindings and injections |
|
|
31
31
|
|
|
32
32
|
|
|
@@ -25,11 +25,11 @@ export declare class ResolutionSession
|
|
|
25
25
|
|
|
26
26
|
| Property | Modifiers | Type | Description |
|
|
27
27
|
| --- | --- | --- | --- |
|
|
28
|
-
| [bindingStack](./context.resolutionsession.bindingstack.md) |
|
|
29
|
-
| [currentBinding](./context.resolutionsession.currentbinding.md) |
|
|
30
|
-
| [currentInjection](./context.resolutionsession.currentinjection.md) |
|
|
31
|
-
| [injectionStack](./context.resolutionsession.injectionstack.md) |
|
|
32
|
-
| [stack](./context.resolutionsession.stack.md) |
|
|
28
|
+
| [bindingStack](./context.resolutionsession.bindingstack.md) | <code>readonly</code> | Readonly<[Binding](./context.binding.md)<!-- -->>\[\] | Getter for bindings on the stack |
|
|
29
|
+
| [currentBinding](./context.resolutionsession.currentbinding.md) | <code>readonly</code> | Readonly<[Binding](./context.binding.md)<!-- -->> \| undefined | Getter for the current binding |
|
|
30
|
+
| [currentInjection](./context.resolutionsession.currentinjection.md) | <code>readonly</code> | Readonly<[Injection](./context.injection.md)<!-- -->> \| undefined | Getter for the current injection |
|
|
31
|
+
| [injectionStack](./context.resolutionsession.injectionstack.md) | <code>readonly</code> | Readonly<[Injection](./context.injection.md)<!-- -->>\[\] | Getter for injections on the stack |
|
|
32
|
+
| [stack](./context.resolutionsession.stack.md) | <code>readonly</code> | [ResolutionElement](./context.resolutionelement.md)<!-- -->\[\] | A stack of bindings for the current resolution session. It's used to track the path of dependency resolution and detect circular dependencies. |
|
|
33
33
|
|
|
34
34
|
## Methods
|
|
35
35
|
|
|
@@ -23,9 +23,9 @@ export interface Subscription
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [closed](./context.subscription.closed.md) | boolean | Is the subscription closed? |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [closed](./context.subscription.closed.md) | | boolean | Is the subscription closed? |
|
|
29
29
|
|
|
30
30
|
## Methods
|
|
31
31
|
|
|
@@ -35,32 +35,32 @@ export declare class Application extends Context implements LifeCycleObserver
|
|
|
35
35
|
|
|
36
36
|
| Property | Modifiers | Type | Description |
|
|
37
37
|
| --- | --- | --- | --- |
|
|
38
|
-
| [options](./core.application.options.md) |
|
|
39
|
-
| [state](./core.application.state.md) |
|
|
38
|
+
| [options](./core.application.options.md) | <code>readonly</code> | [ApplicationConfig](./core.applicationconfig.md) | |
|
|
39
|
+
| [state](./core.application.state.md) | <code>readonly</code> | string | <p>Get the state of the application. The initial state is <code>created</code> and it can transition as follows by <code>start</code> and <code>stop</code>:</p><p>1. start - !started -<!-- -->> starting -<!-- -->> started - started -<!-- -->> started (no-op) 2. stop - (started \| initialized) -<!-- -->> stopping -<!-- -->> stopped - ! (started \|\| initialized) -<!-- -->> stopped (no-op)</p><p>Two types of states are expected: - stable, such as <code>started</code> and <code>stopped</code> - in process, such as <code>booting</code> and <code>starting</code></p><p>Operations such as <code>start</code> and <code>stop</code> can only be called at a stable state. The logic should immediately set the state to a new one indicating work in process, such as <code>starting</code> and <code>stopping</code>.</p> |
|
|
40
40
|
|
|
41
41
|
## Methods
|
|
42
42
|
|
|
43
43
|
| Method | Modifiers | Description |
|
|
44
44
|
| --- | --- | --- |
|
|
45
|
-
| [assertInStates(op, states)](./core.application.assertinstates.md) |
|
|
46
|
-
| [assertNotInProcess(op)](./core.application.assertnotinprocess.md) |
|
|
47
|
-
| [awaitState(state)](./core.application.awaitstate.md) |
|
|
45
|
+
| [assertInStates(op, states)](./core.application.assertinstates.md) | <code>protected</code> | Assert current state of the application to be one of the expected values |
|
|
46
|
+
| [assertNotInProcess(op)](./core.application.assertnotinprocess.md) | <code>protected</code> | Assert there is no other operation is in progress, i.e., the state is not <code>*ing</code>, such as <code>starting</code> or <code>stopping</code>. |
|
|
47
|
+
| [awaitState(state)](./core.application.awaitstate.md) | <code>protected</code> | |
|
|
48
48
|
| [component(componentCtor, nameOrOptions)](./core.application.component.md) | | Add a component to this application and register extensions such as controllers, providers, and servers from the component. |
|
|
49
49
|
| [controller(controllerCtor, nameOrOptions)](./core.application.controller.md) | | Register a controller class with this application. |
|
|
50
50
|
| [getServer(target)](./core.application.getserver.md) | | Retrieve the singleton instance for a bound server. |
|
|
51
|
-
| [init()](./core.application.init.md) | | Initialize the application, and all of its registered observers. The application state is checked to ensure the integrity of <code>initialize</code
|
|
51
|
+
| [init()](./core.application.init.md) | | <p>Initialize the application, and all of its registered observers. The application state is checked to ensure the integrity of <code>initialize</code>.</p><p>If the application is already initialized, no operation is performed.</p><p>This method is automatically invoked by <code>start()</code> if the application is not initialized.</p> |
|
|
52
52
|
| [interceptor(interceptor, nameOrOptions)](./core.application.interceptor.md) | | Register an interceptor |
|
|
53
53
|
| [lifeCycleObserver(ctor, nameOrOptions)](./core.application.lifecycleobserver.md) | | Register a life cycle observer class |
|
|
54
|
-
| [onInit(fn)](./core.application.oninit.md) | | Register a function to be called when the application initializes
|
|
55
|
-
| [onStart(fn)](./core.application.onstart.md) | | Register a function to be called when the application starts
|
|
56
|
-
| [onStop(fn)](./core.application.onstop.md) | | Register a function to be called when the application starts
|
|
54
|
+
| [onInit(fn)](./core.application.oninit.md) | | <p>Register a function to be called when the application initializes.</p><p>This is a shortcut for adding a binding for a LifeCycleObserver implementing a <code>init()</code> method.</p> |
|
|
55
|
+
| [onStart(fn)](./core.application.onstart.md) | | <p>Register a function to be called when the application starts.</p><p>This is a shortcut for adding a binding for a LifeCycleObserver implementing a <code>start()</code> method.</p> |
|
|
56
|
+
| [onStop(fn)](./core.application.onstop.md) | | <p>Register a function to be called when the application starts.</p><p>This is a shortcut for adding a binding for a LifeCycleObserver implementing a <code>start()</code> method.</p> |
|
|
57
57
|
| [server(ctor, nameOrOptions)](./core.application.server.md) | | Bind a Server constructor to the Application's master context. Each server constructor added in this way must provide a unique prefix to prevent binding overlap. |
|
|
58
58
|
| [servers(ctors)](./core.application.servers.md) | | Bind an array of Server constructors to the Application's master context. Each server added in this way will automatically be named based on the class constructor name with the "servers." prefix. |
|
|
59
59
|
| [service(cls, nameOrOptions)](./core.application.service.md) | | Add a service to this application. |
|
|
60
60
|
| [setMetadata(metadata)](./core.application.setmetadata.md) | | Set application metadata. <code>@loopback/boot</code> calls this method to populate the metadata from <code>package.json</code>. |
|
|
61
|
-
| [setState(state)](./core.application.setstate.md) |
|
|
62
|
-
| [setupShutdown()](./core.application.setupshutdown.md) |
|
|
63
|
-
| [start()](./core.application.start.md) | | Start the application, and all of its registered observers. The application state is checked to ensure the integrity of <code>start</code
|
|
64
|
-
| [stop()](./core.application.stop.md) | | Stop the application instance and all of its registered observers. The application state is checked to ensure the integrity of <code>stop</code
|
|
61
|
+
| [setState(state)](./core.application.setstate.md) | <code>protected</code> | Transition the application to a new state and emit an event |
|
|
62
|
+
| [setupShutdown()](./core.application.setupshutdown.md) | <code>protected</code> | Set up signals that are captured to shutdown the application |
|
|
63
|
+
| [start()](./core.application.start.md) | | <p>Start the application, and all of its registered observers. The application state is checked to ensure the integrity of <code>start</code>.</p><p>If the application is not initialized, it calls first <code>init()</code> to initialize the application. This only happens if <code>start()</code> is called for the first time.</p><p>If the application is already started, no operation is performed.</p> |
|
|
64
|
+
| [stop()](./core.application.stop.md) | | <p>Stop the application instance and all of its registered observers. The application state is checked to ensure the integrity of <code>stop</code>.</p><p>If the application is already stopped or not started, no operation is performed.</p> |
|
|
65
65
|
|
|
66
66
|
|
|
@@ -23,9 +23,9 @@ export interface ApplicationConfig
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [name?](./core.applicationconfig.name.md) | string | <i>(Optional)</i> Name of the application context |
|
|
29
|
-
| [shutdown?](./core.applicationconfig.shutdown.md) | [ShutdownOptions](./core.shutdownoptions.md) | <i>(Optional)</i> Configuration for signals that shut down the application |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [name?](./core.applicationconfig.name.md) | | string | <i>(Optional)</i> Name of the application context |
|
|
29
|
+
| [shutdown?](./core.applicationconfig.shutdown.md) | | [ShutdownOptions](./core.shutdownoptions.md) | <i>(Optional)</i> Configuration for signals that shut down the application |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -24,10 +24,10 @@ export interface ApplicationMetadata extends JSONObject
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [description](./core.applicationmetadata.description.md) | string | |
|
|
30
|
-
| [name](./core.applicationmetadata.name.md) | string | |
|
|
31
|
-
| [version](./core.applicationmetadata.version.md) | string | |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [description](./core.applicationmetadata.description.md) | | string | |
|
|
30
|
+
| [name](./core.applicationmetadata.name.md) | | string | |
|
|
31
|
+
| [version](./core.applicationmetadata.version.md) | | string | |
|
|
32
32
|
|
|
33
33
|
|
|
@@ -23,14 +23,14 @@ export interface Component
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [bindings?](./core.component.bindings.md) | [Binding](./context.binding.md)<!-- -->\[\] | <i>(Optional)</i> An array of bindings to be aded to the application context. |
|
|
29
|
-
| [classes?](./core.component.classes.md) | [ClassMap](./core.classmap.md) | <i>(Optional)</i> A map of classes to be bound to the application context. |
|
|
30
|
-
| [controllers?](./core.component.controllers.md) | [ControllerClass](./core.controllerclass.md)<!-- -->\[\] | <i>(Optional)</i> An array of controller classes |
|
|
31
|
-
| [lifeCycleObservers?](./core.component.lifecycleobservers.md) | [Constructor](./context.constructor.md)<!-- --><[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>\[\] | <i>(Optional)</i> |
|
|
32
|
-
| [providers?](./core.component.providers.md) | [ProviderMap](./core.providermap.md) | <i>(Optional)</i> A map of providers to be bound to the application context |
|
|
33
|
-
| [servers?](./core.component.servers.md) | { \[name: string\]: [Constructor](./context.constructor.md)<!-- --><[Server](./core.server.md)<!-- -->>; } | <i>(Optional)</i> A map of name/class pairs for servers |
|
|
34
|
-
| [services?](./core.component.services.md) | [ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- -->\[\] | <i>(Optional)</i> An array of service or provider classes |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [bindings?](./core.component.bindings.md) | | [Binding](./context.binding.md)<!-- -->\[\] | <i>(Optional)</i> An array of bindings to be aded to the application context. |
|
|
29
|
+
| [classes?](./core.component.classes.md) | | [ClassMap](./core.classmap.md) | <i>(Optional)</i> A map of classes to be bound to the application context. |
|
|
30
|
+
| [controllers?](./core.component.controllers.md) | | [ControllerClass](./core.controllerclass.md)<!-- -->\[\] | <i>(Optional)</i> An array of controller classes |
|
|
31
|
+
| [lifeCycleObservers?](./core.component.lifecycleobservers.md) | | [Constructor](./context.constructor.md)<!-- --><[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>\[\] | <i>(Optional)</i> |
|
|
32
|
+
| [providers?](./core.component.providers.md) | | [ProviderMap](./core.providermap.md) | <i>(Optional)</i> A map of providers to be bound to the application context |
|
|
33
|
+
| [servers?](./core.component.servers.md) | | { \[name: string\]: [Constructor](./context.constructor.md)<!-- --><[Server](./core.server.md)<!-- -->>; } | <i>(Optional)</i> A map of name/class pairs for servers |
|
|
34
|
+
| [services?](./core.component.services.md) | | [ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- -->\[\] | <i>(Optional)</i> An array of service or provider classes |
|
|
35
35
|
|
|
36
36
|
|
|
@@ -32,22 +32,22 @@ export declare class LifeCycleObserverRegistry implements LifeCycleObserver
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [context](./core.lifecycleobserverregistry.context.md) |
|
|
36
|
-
| [observersView](./core.lifecycleobserverregistry.observersview.md) |
|
|
37
|
-
| [options](./core.lifecycleobserverregistry.options.md) |
|
|
35
|
+
| [context](./core.lifecycleobserverregistry.context.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [Context](./context.context.md) | |
|
|
36
|
+
| [observersView](./core.lifecycleobserverregistry.observersview.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [ContextView](./context.contextview.md)<!-- --><[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->> | |
|
|
37
|
+
| [options](./core.lifecycleobserverregistry.options.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [LifeCycleObserverOptions](./core.lifecycleobserveroptions.md) | |
|
|
38
38
|
|
|
39
39
|
## Methods
|
|
40
40
|
|
|
41
41
|
| Method | Modifiers | Description |
|
|
42
42
|
| --- | --- | --- |
|
|
43
|
-
| [getObserverGroup(binding)](./core.lifecycleobserverregistry.getobservergroup.md) |
|
|
43
|
+
| [getObserverGroup(binding)](./core.lifecycleobserverregistry.getobservergroup.md) | <code>protected</code> | Get the group for a given life cycle observer binding |
|
|
44
44
|
| [getObserverGroupsByOrder()](./core.lifecycleobserverregistry.getobservergroupsbyorder.md) | | Get observer groups ordered by the group |
|
|
45
45
|
| [init()](./core.lifecycleobserverregistry.init.md) | | Notify all life cycle observers by group of <code>init</code> |
|
|
46
|
-
| [invokeObserver(observer, event)](./core.lifecycleobserverregistry.invokeobserver.md) |
|
|
47
|
-
| [notifyGroups(events, groups, reverse)](./core.lifecycleobserverregistry.notifygroups.md) |
|
|
48
|
-
| [notifyObservers(observers, bindings, event)](./core.lifecycleobserverregistry.notifyobservers.md) |
|
|
46
|
+
| [invokeObserver(observer, event)](./core.lifecycleobserverregistry.invokeobserver.md) | <code>protected</code> | Invoke an observer for the given event |
|
|
47
|
+
| [notifyGroups(events, groups, reverse)](./core.lifecycleobserverregistry.notifygroups.md) | <code>protected</code> | Emit events to the observer groups |
|
|
48
|
+
| [notifyObservers(observers, bindings, event)](./core.lifecycleobserverregistry.notifyobservers.md) | <code>protected</code> | Notify an observer group of the given event |
|
|
49
49
|
| [setOrderedGroups(groups)](./core.lifecycleobserverregistry.setorderedgroups.md) | | |
|
|
50
|
-
| [sortObserverBindingsByGroup(bindings)](./core.lifecycleobserverregistry.sortobserverbindingsbygroup.md) |
|
|
50
|
+
| [sortObserverBindingsByGroup(bindings)](./core.lifecycleobserverregistry.sortobserverbindingsbygroup.md) | <code>protected</code> | Sort the life cycle observer bindings so that we can start/stop them in the right order. By default, we can start other observers before servers and stop them in the reverse order |
|
|
51
51
|
| [start()](./core.lifecycleobserverregistry.start.md) | | Notify all life cycle observers by group of <code>start</code> |
|
|
52
52
|
| [stop()](./core.lifecycleobserverregistry.stop.md) | | Notify all life cycle observers by group of <code>stop</code> |
|
|
53
53
|
|
|
@@ -24,8 +24,8 @@ export interface Server extends LifeCycleObserver
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [listening](./core.server.listening.md) | boolean | Tells whether the server is listening for connections or not |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [listening](./core.server.listening.md) | <code>readonly</code> | boolean | Tells whether the server is listening for connections or not |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -25,7 +25,7 @@ export declare function service(serviceInterface?: ServiceInterface, metadata?:
|
|
|
25
25
|
|
|
26
26
|
| Parameter | Type | Description |
|
|
27
27
|
| --- | --- | --- |
|
|
28
|
-
| serviceInterface | [ServiceInterface](./core.serviceinterface.md) | <i>(Optional)</i> Interface for the service. It can be in one of the following forms
|
|
28
|
+
| serviceInterface | [ServiceInterface](./core.serviceinterface.md) | <p><i>(Optional)</i> Interface for the service. It can be in one of the following forms:</p><p>- A class, such as MyService - A string that identifies the interface, such as <code>'MyService'</code> - A symbol that identifies the interface, such as <code>Symbol('MyService')</code></p><p>If not provided, the value is inferred from the design:type of the parameter or property</p> |
|
|
29
29
|
| metadata | [InjectionMetadata](./context.injectionmetadata.md) | <i>(Optional)</i> |
|
|
30
30
|
|
|
31
31
|
<b>Returns:</b>
|
|
@@ -24,8 +24,8 @@ export interface ServiceOptions extends BindingFromClassOptions
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [interface?](./core.serviceoptions.interface.md) | [ServiceInterface](./core.serviceinterface.md) | <i>(Optional)</i> |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [interface?](./core.serviceoptions.interface.md) | | [ServiceInterface](./core.serviceinterface.md) | <i>(Optional)</i> |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -32,7 +32,7 @@ export declare class CronComponent implements Component, LifeCycleObserver
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [getJobs](./cron.croncomponent.getjobs.md) |
|
|
35
|
+
| [getJobs](./cron.croncomponent.getjobs.md) | <code>readonly</code> | [Getter](./context.getter.md)<!-- --><[CronJob](./cron.cronjob.md)<!-- -->\[\]> | |
|
|
36
36
|
|
|
37
37
|
## Methods
|
|
38
38
|
|
package/site/apidocs/cron.md
CHANGED
|
@@ -46,6 +46,6 @@ permalink: /doc/en/lb4/apidocs.cron.html
|
|
|
46
46
|
| Type Alias | Description |
|
|
47
47
|
| --- | --- |
|
|
48
48
|
| [CronJobConfig](./cron.cronjobconfig.md) | Configuration for a cron job. |
|
|
49
|
-
| [CronJobOptions](./cron.cronjoboptions.md) | Options for a cron job. It adds an optional <code>name</code> to cron parameters
|
|
49
|
+
| [CronJobOptions](./cron.cronjoboptions.md) | <p>Options for a cron job. It adds an optional <code>name</code> to cron parameters.</p><p>[cron configuration](https://github.com/kelektiv/node-cron#api)</p> |
|
|
50
50
|
|
|
51
51
|
|
|
@@ -24,9 +24,9 @@ export interface BaseMiddlewareBindingOptions<CTX extends Context> extends Middl
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [group?](./express.basemiddlewarebindingoptions.group.md) | string | <i>(Optional)</i> An optional <code>group</code> name to be used for order of executions |
|
|
30
|
-
| [key?](./express.basemiddlewarebindingoptions.key.md) | [BindingAddress](./context.bindingaddress.md)<!-- --><[GenericInterceptor](./context.genericinterceptor.md)<!-- --><CTX>> | <i>(Optional)</i> Binding key for the middleware. |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [group?](./express.basemiddlewarebindingoptions.group.md) | | string | <i>(Optional)</i> An optional <code>group</code> name to be used for order of executions |
|
|
30
|
+
| [key?](./express.basemiddlewarebindingoptions.key.md) | | [BindingAddress](./context.bindingaddress.md)<!-- --><[GenericInterceptor](./context.genericinterceptor.md)<!-- --><CTX>> | <i>(Optional)</i> Binding key for the middleware. |
|
|
31
31
|
|
|
32
32
|
|
|
@@ -32,7 +32,7 @@ export declare class ExpressApplication extends Application
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [config?](./express.expressapplication.config.md) |
|
|
36
|
-
| [expressServer](./express.expressapplication.expressserver.md) |
|
|
35
|
+
| [config?](./express.expressapplication.config.md) | <code>readonly</code> | [ApplicationConfig](./core.applicationconfig.md) \| undefined | <i>(Optional)</i> |
|
|
36
|
+
| [expressServer](./express.expressapplication.expressserver.md) | <code>readonly</code> | [ExpressServer](./express.expressserver.md) | Embedded Express Server |
|
|
37
37
|
|
|
38
38
|
|
|
@@ -20,7 +20,7 @@ Base class for MiddlewareInterceptor provider classes
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare abstract class ExpressMiddlewareInterceptorProvider<CFG, CTX extends Context = InvocationContext> implements Provider<GenericInterceptor<CTX>>
|
|
22
22
|
```
|
|
23
|
-
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[GenericInterceptor](./context.genericinterceptor.md)
|
|
23
|
+
<b>Implements:</b> [Provider](./context.provider.md)<!-- --><[GenericInterceptor](./context.genericinterceptor.md)<!-- --><CTX>>
|
|
24
24
|
|
|
25
25
|
## Example
|
|
26
26
|
|
|
@@ -57,9 +57,9 @@ class SpyInterceptorProvider extends ExpressMiddlewareInterceptorProvider<
|
|
|
57
57
|
|
|
58
58
|
| Property | Modifiers | Type | Description |
|
|
59
59
|
| --- | --- | --- | --- |
|
|
60
|
-
| [middlewareConfig?](./express.expressmiddlewareinterceptorprovider.middlewareconfig.md) |
|
|
61
|
-
| [middlewareConfigView?](./express.expressmiddlewareinterceptorprovider.middlewareconfigview.md) |
|
|
62
|
-
| [middlewareFactory](./express.expressmiddlewareinterceptorprovider.middlewarefactory.md) |
|
|
60
|
+
| [middlewareConfig?](./express.expressmiddlewareinterceptorprovider.middlewareconfig.md) | <code>protected</code> | CFG | <i>(Optional)</i> |
|
|
61
|
+
| [middlewareConfigView?](./express.expressmiddlewareinterceptorprovider.middlewareconfigview.md) | <code>protected</code> | [ContextView](./context.contextview.md)<!-- --><CFG> | <i>(Optional)</i> |
|
|
62
|
+
| [middlewareFactory](./express.expressmiddlewareinterceptorprovider.middlewarefactory.md) | <code>protected</code> | [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- --><CFG> | |
|
|
63
63
|
|
|
64
64
|
## Methods
|
|
65
65
|
|
|
@@ -34,13 +34,13 @@ export declare class ExpressServer extends BaseMiddlewareRegistry implements Ser
|
|
|
34
34
|
|
|
35
35
|
| Property | Modifiers | Type | Description |
|
|
36
36
|
| --- | --- | --- | --- |
|
|
37
|
-
| [basePath](./express.expressserver.basepath.md) |
|
|
38
|
-
| [config?](./express.expressserver.config.md) |
|
|
39
|
-
| [expressApp](./express.expressserver.expressapp.md) |
|
|
40
|
-
| [httpServer](./express.expressserver.httpserver.md) |
|
|
41
|
-
| [listening](./express.expressserver.listening.md) |
|
|
42
|
-
| [rootUrl](./express.expressserver.rooturl.md) |
|
|
43
|
-
| [url](./express.expressserver.url.md) |
|
|
37
|
+
| [basePath](./express.expressserver.basepath.md) | <code>readonly</code> | string | Base path to mount middleware |
|
|
38
|
+
| [config?](./express.expressserver.config.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [ExpressServerConfig](./express.expressserverconfig.md) \| undefined | <i>(Optional)</i> |
|
|
39
|
+
| [expressApp](./express.expressserver.expressapp.md) | <code>readonly</code> | express.Application | Embedded Express application |
|
|
40
|
+
| [httpServer](./express.expressserver.httpserver.md) | <code>protected</code> | [HttpServer](./http-server.httpserver.md) | HTTP/HTTPS server |
|
|
41
|
+
| [listening](./express.expressserver.listening.md) | <code>readonly</code> | boolean | Some of the methods below are copied from RestServer TODO(rfeng): We might want to refactor some methods from RestServer into the base ExpressServer. |
|
|
42
|
+
| [rootUrl](./express.expressserver.rooturl.md) | <code>readonly</code> | string \| undefined | The root url for the server without the basePath. For example, the value will be 'http://localhost:3000' regardless of the <code>basePath</code>. |
|
|
43
|
+
| [url](./express.expressserver.url.md) | <code>readonly</code> | string \| undefined | The base url for the server, including the basePath if set. For example, the value will be 'http://localhost:3000/api' if <code>basePath</code> is set to '/api'. |
|
|
44
44
|
|
|
45
45
|
## Methods
|
|
46
46
|
|
|
@@ -23,9 +23,9 @@ export interface HandlerContext
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [request](./express.handlercontext.request.md) | Request | |
|
|
29
|
-
| [response](./express.handlercontext.response.md) | Response | |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [request](./express.handlercontext.request.md) | <code>readonly</code> | Request | |
|
|
29
|
+
| [response](./express.handlercontext.response.md) | <code>readonly</code> | Response | |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -23,12 +23,12 @@ export interface InvokeMiddlewareOptions
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [chain?](./express.invokemiddlewareoptions.chain.md) | string | <i>(Optional)</i> Name of the extension point. Default to the <code>extensionPoint</code> tag value from the binding |
|
|
29
|
-
| [middlewareList?](./express.invokemiddlewareoptions.middlewarelist.md) | [MiddlewareOrKey](./express.middlewareorkey.md)<!-- -->\[\] | <i>(Optional)</i> Pre-built middleware list. If set, the list will be used to create the middleware chain without discovering again within the context. |
|
|
30
|
-
| [next?](./express.invokemiddlewareoptions.next.md) | [Next](./context.next.md) | <i>(Optional)</i> Optional next handler |
|
|
31
|
-
| [orderedGroups?](./express.invokemiddlewareoptions.orderedgroups.md) | string\[\] | <i>(Optional)</i> An array of group names to denote the order of execution, such as <code>['cors', 'caching', 'rate-limiting']</code>. |
|
|
32
|
-
| [validate?](./express.invokemiddlewareoptions.validate.md) | (groups: string\[\]) => void | <i>(Optional)</i> An optional function to validate the sorted groups before invoking the middleware chain |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [chain?](./express.invokemiddlewareoptions.chain.md) | | string | <i>(Optional)</i> Name of the extension point. Default to the <code>extensionPoint</code> tag value from the binding |
|
|
29
|
+
| [middlewareList?](./express.invokemiddlewareoptions.middlewarelist.md) | | [MiddlewareOrKey](./express.middlewareorkey.md)<!-- -->\[\] | <i>(Optional)</i> Pre-built middleware list. If set, the list will be used to create the middleware chain without discovering again within the context. |
|
|
30
|
+
| [next?](./express.invokemiddlewareoptions.next.md) | | [Next](./context.next.md) | <i>(Optional)</i> Optional next handler |
|
|
31
|
+
| [orderedGroups?](./express.invokemiddlewareoptions.orderedgroups.md) | | string\[\] | <i>(Optional)</i> An array of group names to denote the order of execution, such as <code>['cors', 'caching', 'rate-limiting']</code>. |
|
|
32
|
+
| [validate?](./express.invokemiddlewareoptions.validate.md) | | (groups: string\[\]) => void | <i>(Optional)</i> An optional function to validate the sorted groups before invoking the middleware chain |
|
|
33
33
|
|
|
34
34
|
|
|
@@ -20,7 +20,7 @@ Interface LoopBack 4 middleware to be executed within sequence of actions. A mid
|
|
|
20
20
|
```typescript
|
|
21
21
|
export interface Middleware extends GenericInterceptor<MiddlewareContext>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> [GenericInterceptor](./context.genericinterceptor.md)<!-- --><[MiddlewareContext](./express.middlewarecontext.md)
|
|
23
|
+
<b>Extends:</b> [GenericInterceptor](./context.genericinterceptor.md)<!-- --><[MiddlewareContext](./express.middlewarecontext.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
## Remarks
|
|
26
26
|
|
|
@@ -20,14 +20,14 @@ Options to bind middleware as a request context based interceptor within an `Inv
|
|
|
20
20
|
```typescript
|
|
21
21
|
export interface MiddlewareBindingOptions extends BaseMiddlewareBindingOptions<MiddlewareContext>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> [BaseMiddlewareBindingOptions](./express.basemiddlewarebindingoptions.md)<!-- --><[MiddlewareContext](./express.middlewarecontext.md)
|
|
23
|
+
<b>Extends:</b> [BaseMiddlewareBindingOptions](./express.basemiddlewarebindingoptions.md)<!-- --><[MiddlewareContext](./express.middlewarecontext.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [chain?](./express.middlewarebindingoptions.chain.md) | string | <i>(Optional)</i> Name of the middleware extension point. Default to <code>DEFAULT_MIDDLEWARE_CHAIN</code>. |
|
|
30
|
-
| [downstreamGroups?](./express.middlewarebindingoptions.downstreamgroups.md) | string \| string\[\] | <i>(Optional)</i> An array of group names for downstream middleware in the cascading order
|
|
31
|
-
| [upstreamGroups?](./express.middlewarebindingoptions.upstreamgroups.md) | string \| string\[\] | <i>(Optional)</i> An array of group names for upstream middleware in the cascading order
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [chain?](./express.middlewarebindingoptions.chain.md) | | string | <i>(Optional)</i> Name of the middleware extension point. Default to <code>DEFAULT_MIDDLEWARE_CHAIN</code>. |
|
|
30
|
+
| [downstreamGroups?](./express.middlewarebindingoptions.downstreamgroups.md) | | string \| string\[\] | <p><i>(Optional)</i> An array of group names for downstream middleware in the cascading order.</p><p>For example, the <code>sendResponse</code> depends on <code>invokeMethod</code> for response processing. The <code>downstreamGroups</code> for <code>sendResponse</code> should be <code>['invokeMethod']</code>. The order of groups in the array does not matter.</p> |
|
|
31
|
+
| [upstreamGroups?](./express.middlewarebindingoptions.upstreamgroups.md) | | string \| string\[\] | <p><i>(Optional)</i> An array of group names for upstream middleware in the cascading order.</p><p>For example, the <code>invokeMethod</code> depends on <code>parseParams</code> for request processing. The <code>upstreamGroups</code> for <code>invokeMethod</code> should be <code>['parseParams']</code>. The order of groups in the array does not matter.</p> |
|
|
32
32
|
|
|
33
33
|
|
|
@@ -20,6 +20,6 @@ An interceptor chain of middleware. This represents a list of cascading middlewa
|
|
|
20
20
|
```typescript
|
|
21
21
|
export declare class MiddlewareChain extends GenericInterceptorChain<MiddlewareContext>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> [GenericInterceptorChain](./context.genericinterceptorchain.md)<!-- --><[MiddlewareContext](./express.middlewarecontext.md)
|
|
23
|
+
<b>Extends:</b> [GenericInterceptorChain](./context.genericinterceptorchain.md)<!-- --><[MiddlewareContext](./express.middlewarecontext.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
|
|
@@ -34,14 +34,14 @@ export declare class MiddlewareContext extends Context implements HandlerContext
|
|
|
34
34
|
|
|
35
35
|
| Property | Modifiers | Type | Description |
|
|
36
36
|
| --- | --- | --- | --- |
|
|
37
|
-
| [request](./express.middlewarecontext.request.md) |
|
|
38
|
-
| [response](./express.middlewarecontext.response.md) |
|
|
37
|
+
| [request](./express.middlewarecontext.request.md) | <code>readonly</code> | Request | |
|
|
38
|
+
| [response](./express.middlewarecontext.response.md) | <code>readonly</code> | Response | |
|
|
39
39
|
| [responseFinished](./express.middlewarecontext.responsefinished.md) | | boolean | A flag to tell if the response is finished. |
|
|
40
40
|
|
|
41
41
|
## Methods
|
|
42
42
|
|
|
43
43
|
| Method | Modifiers | Description |
|
|
44
44
|
| --- | --- | --- |
|
|
45
|
-
| [setupBindings()](./express.middlewarecontext.setupbindings.md) |
|
|
45
|
+
| [setupBindings()](./express.middlewarecontext.setupbindings.md) | <code>protected</code> | |
|
|
46
46
|
|
|
47
47
|
|
|
@@ -23,9 +23,9 @@ export interface MiddlewareCreationOptions
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [injectConfiguration?](./express.middlewarecreationoptions.injectconfiguration.md) | boolean \| 'watch' | <i>(Optional)</i> A flag to control if configuration for the middleware can be injected lazily
|
|
29
|
-
| [providerClassName?](./express.middlewarecreationoptions.providerclassname.md) | string | <i>(Optional)</i> Class name for the created provider class. It's only used if <code>injectConfiguration</code> is not set to <code>false</code>. |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [injectConfiguration?](./express.middlewarecreationoptions.injectconfiguration.md) | | boolean \| 'watch' | <p><i>(Optional)</i> A flag to control if configuration for the middleware can be injected lazily.</p><p>- <code>true</code> (default): creates a provider class with <code>@config</code> - <code>false</code>: No configuration injection is supported - 'watch': creates a provider class with <code>@config.view</code></p> |
|
|
29
|
+
| [providerClassName?](./express.middlewarecreationoptions.providerclassname.md) | | string | <i>(Optional)</i> Class name for the created provider class. It's only used if <code>injectConfiguration</code> is not set to <code>false</code>. |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -20,12 +20,12 @@ Options to bind a middleware as an interceptor to the context
|
|
|
20
20
|
```typescript
|
|
21
21
|
export interface MiddlewareInterceptorBindingOptions extends BaseMiddlewareBindingOptions<InvocationContext>
|
|
22
22
|
```
|
|
23
|
-
<b>Extends:</b> [BaseMiddlewareBindingOptions](./express.basemiddlewarebindingoptions.md)<!-- --><[InvocationContext](./context.invocationcontext.md)
|
|
23
|
+
<b>Extends:</b> [BaseMiddlewareBindingOptions](./express.basemiddlewarebindingoptions.md)<!-- --><[InvocationContext](./context.invocationcontext.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
| Property | Type | Description |
|
|
28
|
-
| --- | --- | --- |
|
|
29
|
-
| [global?](./express.middlewareinterceptorbindingoptions.global.md) | boolean | <i>(Optional)</i> A flag to control if the interceptor should be global. Default to <code>true</code>. |
|
|
27
|
+
| Property | Modifiers | Type | Description |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| [global?](./express.middlewareinterceptorbindingoptions.global.md) | | boolean | <i>(Optional)</i> A flag to control if the interceptor should be global. Default to <code>true</code>. |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -32,7 +32,7 @@ export declare class MiddlewareView extends ContextView
|
|
|
32
32
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
|
-
| [middlewareBindingKeys](./express.middlewareview.middlewarebindingkeys.md) |
|
|
35
|
+
| [middlewareBindingKeys](./express.middlewareview.middlewarebindingkeys.md) | <code>readonly</code> | string\[\] | A list of binding keys sorted by group for registered middleware |
|
|
36
36
|
|
|
37
37
|
## Methods
|
|
38
38
|
|
|
@@ -32,8 +32,8 @@ export interface AndClause<MT extends object>
|
|
|
32
32
|
|
|
33
33
|
## Properties
|
|
34
34
|
|
|
35
|
-
| Property | Type | Description |
|
|
36
|
-
| --- | --- | --- |
|
|
37
|
-
| [and](./filter.andclause.and.md) | [Where](./filter.where.md)<!-- --><MT>\[\] | |
|
|
35
|
+
| Property | Modifiers | Type | Description |
|
|
36
|
+
| --- | --- | --- | --- |
|
|
37
|
+
| [and](./filter.andclause.and.md) | | [Where](./filter.where.md)<!-- --><MT>\[\] | |
|
|
38
38
|
|
|
39
39
|
|
|
@@ -23,14 +23,14 @@ export interface Filter<MT extends object = AnyObject>
|
|
|
23
23
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
|
-
| Property | Type | Description |
|
|
27
|
-
| --- | --- | --- |
|
|
28
|
-
| [fields?](./filter.filter.fields.md) | [Fields](./filter.fields.md)<!-- --><MT> | <i>(Optional)</i> To include/exclude fields |
|
|
29
|
-
| [include?](./filter.filter.include.md) | [InclusionFilter](./filter.inclusionfilter.md)<!-- -->\[\] | <i>(Optional)</i> To include related objects |
|
|
30
|
-
| [limit?](./filter.filter.limit.md) | number | <i>(Optional)</i> Maximum number of entities |
|
|
31
|
-
| [offset?](./filter.filter.offset.md) | number | <i>(Optional)</i> Offset N number of entities. An alias for <code>skip</code> |
|
|
32
|
-
| [order?](./filter.filter.order.md) | string\[\] | <i>(Optional)</i> Sorting order for matched entities. Each item should be formatted as <code>fieldName ASC</code> or <code>fieldName DESC</code>. For example: <code>['f1 ASC', 'f2 DESC', 'f3 ASC']</code
|
|
33
|
-
| [skip?](./filter.filter.skip.md) | number | <i>(Optional)</i> Skip N number of entities |
|
|
34
|
-
| [where?](./filter.filter.where.md) | [Where](./filter.where.md)<!-- --><MT> | <i>(Optional)</i> The matching criteria |
|
|
26
|
+
| Property | Modifiers | Type | Description |
|
|
27
|
+
| --- | --- | --- | --- |
|
|
28
|
+
| [fields?](./filter.filter.fields.md) | | [Fields](./filter.fields.md)<!-- --><MT> | <i>(Optional)</i> To include/exclude fields |
|
|
29
|
+
| [include?](./filter.filter.include.md) | | [InclusionFilter](./filter.inclusionfilter.md)<!-- -->\[\] | <i>(Optional)</i> To include related objects |
|
|
30
|
+
| [limit?](./filter.filter.limit.md) | | number | <i>(Optional)</i> Maximum number of entities |
|
|
31
|
+
| [offset?](./filter.filter.offset.md) | | number | <i>(Optional)</i> Offset N number of entities. An alias for <code>skip</code> |
|
|
32
|
+
| [order?](./filter.filter.order.md) | | string\[\] | <p><i>(Optional)</i> Sorting order for matched entities. Each item should be formatted as <code>fieldName ASC</code> or <code>fieldName DESC</code>. For example: <code>['f1 ASC', 'f2 DESC', 'f3 ASC']</code>.</p><p>We might want to use <code>Order</code> in the future. Keep it as <code>string[]</code> for now for compatibility with LoopBack 3.x.</p> |
|
|
33
|
+
| [skip?](./filter.filter.skip.md) | | number | <i>(Optional)</i> Skip N number of entities |
|
|
34
|
+
| [where?](./filter.filter.where.md) | | [Where](./filter.where.md)<!-- --><MT> | <i>(Optional)</i> The matching criteria |
|
|
35
35
|
|
|
36
36
|
|