@loopback/docs 5.1.4 → 5.1.5
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 +9 -0
- package/package.json +3 -3
- package/site/apidocs/apiconnect.apiconnectspecoptions.md +1 -1
- package/site/apidocs/authentication-jwt.credentials.md +1 -1
- package/site/apidocs/authentication-jwt.refereshtokenwithrelations.md +1 -1
- package/site/apidocs/authentication-jwt.securityschemeobjects.md +1 -1
- package/site/apidocs/authentication-jwt.tokenobject.md +1 -1
- package/site/apidocs/authentication-jwt.usercredentialswithrelations.md +1 -1
- package/site/apidocs/authentication-jwt.userwithrelations.md +1 -1
- package/site/apidocs/authorization.authorizer.md +1 -1
- package/site/apidocs/boot.artifactoptions.md +1 -1
- package/site/apidocs/boot.bootexecutionoptions.md +1 -1
- package/site/apidocs/boot.bootoptions.md +1 -1
- package/site/apidocs/context-explorer.bindingnodefilter.md +1 -1
- package/site/apidocs/context-explorer.contextexplorerconfig.md +1 -1
- package/site/apidocs/context-explorer.contextgraphoptions.md +1 -1
- package/site/apidocs/context.aliasbindingsource.md +1 -1
- package/site/apidocs/context.asinterceptedfunction.md +1 -1
- package/site/apidocs/context.asvalueorpromise.md +1 -1
- package/site/apidocs/context.asyncproxy.md +1 -1
- package/site/apidocs/context.bindingaddress.md +1 -1
- package/site/apidocs/context.bindingevent.md +1 -1
- package/site/apidocs/context.bindingeventlistener.md +1 -1
- package/site/apidocs/context.bindingfromclassoptions.md +1 -1
- package/site/apidocs/context.bindingmetadata.md +1 -1
- package/site/apidocs/context.bindingscopeandtags.md +1 -1
- package/site/apidocs/context.bindingselector.md +1 -1
- package/site/apidocs/context.bindingsource.md +1 -1
- package/site/apidocs/context.bindingspec.md +1 -1
- package/site/apidocs/context.bindingtag.md +1 -1
- package/site/apidocs/context.bindingtemplate.md +1 -1
- package/site/apidocs/context.boundvalue.md +1 -1
- package/site/apidocs/context.classbindingsource.md +1 -1
- package/site/apidocs/context.constantbindingsource.md +1 -1
- package/site/apidocs/context.constructor.md +1 -1
- package/site/apidocs/context.contextevent.md +1 -1
- package/site/apidocs/context.contexteventlistener.md +1 -1
- package/site/apidocs/context.contexteventobserver.md +1 -1
- package/site/apidocs/context.contexteventtype.md +1 -1
- package/site/apidocs/context.contextobserverfn.md +1 -1
- package/site/apidocs/context.dynamicvaluebindingsource.md +1 -1
- package/site/apidocs/context.genericinterceptor.md +1 -1
- package/site/apidocs/context.genericinterceptororkey.md +1 -1
- package/site/apidocs/context.getter.md +1 -1
- package/site/apidocs/context.interceptororkey.md +1 -1
- package/site/apidocs/context.invocationargs.md +1 -1
- package/site/apidocs/context.invocationoptions.md +1 -1
- package/site/apidocs/context.invocationresult.md +1 -1
- package/site/apidocs/context.jsonprimitive.md +1 -1
- package/site/apidocs/context.jsonvalue.md +1 -1
- package/site/apidocs/context.mapobject.md +1 -1
- package/site/apidocs/context.next.md +1 -1
- package/site/apidocs/context.nonvoid.md +1 -1
- package/site/apidocs/context.providerbindingsource.md +1 -1
- package/site/apidocs/context.resolutionaction.md +1 -1
- package/site/apidocs/context.resolutionelement.md +1 -1
- package/site/apidocs/context.resolutionoptionsorsession.md +1 -1
- package/site/apidocs/context.setter.md +1 -1
- package/site/apidocs/context.tagmap.md +1 -1
- package/site/apidocs/context.typenamespacemapping.md +1 -1
- package/site/apidocs/context.valuefactory.md +1 -1
- package/site/apidocs/context.valueorpromise.md +1 -1
- package/site/apidocs/core.controllerclass.md +1 -1
- package/site/apidocs/core.lifecycleobservergroup.md +1 -1
- package/site/apidocs/core.lifecycleobserveroptions.md +1 -1
- package/site/apidocs/core.mixintarget.md +1 -1
- package/site/apidocs/core.serviceinterface.md +1 -1
- package/site/apidocs/core.serviceorproviderclass.md +1 -1
- package/site/apidocs/core.shutdownoptions.md +1 -1
- package/site/apidocs/cron.cronjobconfig.md +1 -1
- package/site/apidocs/cron.cronjoboptions.md +1 -1
- package/site/apidocs/express.expressrequesthandler.md +1 -1
- package/site/apidocs/express.expressserverconfig.md +1 -1
- package/site/apidocs/express.middlewareorkey.md +1 -1
- package/site/apidocs/filter.condition.md +1 -1
- package/site/apidocs/filter.direction.md +1 -1
- package/site/apidocs/filter.fields.md +1 -1
- package/site/apidocs/filter.filterexcludingwhere.md +1 -1
- package/site/apidocs/filter.inclusionfilter.md +1 -1
- package/site/apidocs/filter.keyof.md +1 -1
- package/site/apidocs/filter.operators.md +1 -1
- package/site/apidocs/filter.order.md +1 -1
- package/site/apidocs/filter.predicatecomparison.md +1 -1
- package/site/apidocs/filter.shorthandequaltype.md +1 -1
- package/site/apidocs/filter.where.md +1 -1
- package/site/apidocs/graphql.graphqlserver.exportgraphqlschema.md +5 -2
- package/site/apidocs/health.healthconfig.md +1 -1
- package/site/apidocs/health.healthoptions.md +1 -1
- package/site/apidocs/health.livecheck.md +1 -1
- package/site/apidocs/health.readycheck.md +1 -1
- package/site/apidocs/http-server.httpprotocol.md +1 -1
- package/site/apidocs/http-server.httpserveroptions.md +1 -1
- package/site/apidocs/http-server.httpserverproperties.md +1 -1
- package/site/apidocs/http-server.requestlistener.md +1 -1
- package/site/apidocs/logging.loggingcomponentconfig.md +1 -1
- package/site/apidocs/metadata.decoratortype.md +1 -1
- package/site/apidocs/metadata.metadatakey.md +1 -1
- package/site/apidocs/metrics.metricsconfig.md +1 -1
- package/site/apidocs/model-api-builder.modelapiconfig.md +1 -1
- package/site/apidocs/openapi-v3.openapispec.md +1 -1
- package/site/apidocs/openapi-v3.responsedecoratormetadata.md +1 -1
- package/site/apidocs/openapi-v3.responsemodelorspec.md +1 -1
- package/site/apidocs/openapi-v3.schemaref.md +1 -1
- package/site/apidocs/repository-json-schema.optional.md +1 -1
- package/site/apidocs/repository-tests.crudrepositoryctor.md +1 -1
- package/site/apidocs/repository-tests.datasourceoptions.md +1 -1
- package/site/apidocs/repository-tests.transactionalrepositoryctor.md +1 -1
- package/site/apidocs/repository.callback.md +1 -1
- package/site/apidocs/repository.command.md +1 -1
- package/site/apidocs/repository.constructor.md +1 -1
- package/site/apidocs/repository.dataobject.md +1 -1
- package/site/apidocs/repository.deeppartial.md +1 -1
- package/site/apidocs/repository.dynamicmodelctor.md +1 -1
- package/site/apidocs/repository.entitydata.md +1 -1
- package/site/apidocs/repository.entityresolver.md +1 -1
- package/site/apidocs/repository.hasmanythroughrepositoryfactory.md +1 -1
- package/site/apidocs/repository.inclusionresolver.md +1 -1
- package/site/apidocs/repository.keyvaluefilter.md +1 -1
- package/site/apidocs/repository.md +1 -0
- package/site/apidocs/repository.namedparameters.md +1 -1
- package/site/apidocs/repository.nonfunction.md +21 -0
- package/site/apidocs/repository.options.md +1 -1
- package/site/apidocs/repository.positionalparameters.md +1 -1
- package/site/apidocs/repository.propertymap.md +1 -1
- package/site/apidocs/repository.propertytype.md +1 -1
- package/site/apidocs/repository.prototypeof.md +1 -1
- package/site/apidocs/repository.relationdefinitionmap.md +1 -1
- package/site/apidocs/repository.relationmetadata.md +1 -1
- package/site/apidocs/repository.repositorydecorator.md +1 -1
- package/site/apidocs/repository.resolvetype.md +2 -2
- package/site/apidocs/repository.resolvetype_1.md +2 -2
- package/site/apidocs/repository.stringkeyof.md +1 -1
- package/site/apidocs/repository.transactionalentityrepository.md +1 -1
- package/site/apidocs/repository.typeresolver.md +1 -1
- package/site/apidocs/rest-explorer.restexplorerconfig.md +1 -1
- package/site/apidocs/rest.ajverroroptions.md +1 -1
- package/site/apidocs/rest.ajvfactory.md +1 -1
- package/site/apidocs/rest.ajvformat.md +1 -1
- package/site/apidocs/rest.ajvkeyword.md +1 -1
- package/site/apidocs/rest.bodyparserfunction.md +1 -1
- package/site/apidocs/rest.bodyparsermiddleware.md +1 -1
- package/site/apidocs/rest.controllerclass.md +1 -1
- package/site/apidocs/rest.controllerfactory.md +1 -1
- package/site/apidocs/rest.controllerinstance.md +1 -1
- package/site/apidocs/rest.findroute.md +1 -1
- package/site/apidocs/rest.httprequestlistener.md +1 -1
- package/site/apidocs/rest.invokemethod.md +1 -1
- package/site/apidocs/rest.logerror.md +1 -1
- package/site/apidocs/rest.nodewithvalue.md +1 -1
- package/site/apidocs/rest.operationargs.md +1 -1
- package/site/apidocs/rest.operationretval.md +1 -1
- package/site/apidocs/rest.parseparams.md +1 -1
- package/site/apidocs/rest.pathparametervalues.md +1 -1
- package/site/apidocs/rest.reject.md +1 -1
- package/site/apidocs/rest.requestbody.md +1 -1
- package/site/apidocs/rest.requestbodyvalidationoptions.md +1 -1
- package/site/apidocs/rest.restcomponentconfig.md +1 -1
- package/site/apidocs/rest.restrouteroptions.md +1 -1
- package/site/apidocs/rest.restserverconfig.md +1 -1
- package/site/apidocs/rest.restserveroptions.md +1 -1
- package/site/apidocs/rest.restserverresolvedconfig.md +1 -1
- package/site/apidocs/rest.routerspec.md +1 -1
- package/site/apidocs/rest.schemavalidatorcache.md +1 -1
- package/site/apidocs/rest.send.md +1 -1
- package/site/apidocs/rest.sequencefunction.md +1 -1
- package/site/apidocs/service-proxy.serviceproxydecorator.md +1 -1
- package/site/apidocs/socketio.socketiodonefunction.md +1 -1
- package/site/apidocs/socketio.socketioinvokemethod.md +1 -1
- package/site/apidocs/socketio.socketiooptions.md +1 -1
- package/site/apidocs/socketio.socketiorejectmethod.md +1 -1
- package/site/apidocs/socketio.socketiosendmethod.md +1 -1
- package/site/apidocs/socketio.sockiomiddleware.md +1 -1
- package/site/apidocs/testlab.client.md +1 -1
- package/site/apidocs/testlab.observedresponse.md +1 -1
- package/site/apidocs/testlab.shotcallback.md +1 -1
- package/site/apidocs/testlab.shotresponsector.md +1 -1
- package/site/apidocs/testlab.stubbedinstancewithsinonaccessor.md +1 -1
- package/site/apidocs/testlab.testdefinition.md +1 -1
- package/site/apidocs/typeorm.propertytype.md +1 -1
- package/site/apidocs/typeorm.stringifiedtypeoptions.md +1 -1
- package/site/apidocs/typeorm.typeormcomponentoptions.md +1 -1
- package/site/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +9 -0
- package/site/changelogs/examples/access-control-migration/CHANGELOG.md +4 -0
- package/site/changelogs/examples/binding-resolution/CHANGELOG.md +9 -0
- package/site/changelogs/examples/context/CHANGELOG.md +4 -0
- package/site/changelogs/examples/express-composition/CHANGELOG.md +4 -0
- package/site/changelogs/examples/file-transfer/CHANGELOG.md +4 -0
- package/site/changelogs/examples/graphql/CHANGELOG.md +9 -0
- package/site/changelogs/examples/greeter-extension/CHANGELOG.md +4 -0
- package/site/changelogs/examples/greeting-app/CHANGELOG.md +4 -0
- package/site/changelogs/examples/hello-world/CHANGELOG.md +4 -0
- package/site/changelogs/examples/lb3-application/CHANGELOG.md +4 -0
- package/site/changelogs/examples/log-extension/CHANGELOG.md +4 -0
- package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +4 -0
- package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +4 -0
- package/site/changelogs/examples/passport-login/CHANGELOG.md +4 -0
- package/site/changelogs/examples/references-many/CHANGELOG.md +4 -0
- package/site/changelogs/examples/rest-crud/CHANGELOG.md +4 -0
- package/site/changelogs/examples/rpc-server/CHANGELOG.md +4 -0
- package/site/changelogs/examples/soap-calculator/CHANGELOG.md +4 -0
- package/site/changelogs/examples/socketio/CHANGELOG.md +4 -0
- package/site/changelogs/examples/todo/CHANGELOG.md +4 -0
- package/site/changelogs/examples/todo-jwt/CHANGELOG.md +4 -0
- package/site/changelogs/examples/todo-list/CHANGELOG.md +4 -0
- package/site/changelogs/examples/validation-app/CHANGELOG.md +4 -0
- package/site/changelogs/examples/webpack/CHANGELOG.md +9 -0
- package/site/changelogs/extensions/apiconnect/CHANGELOG.md +9 -0
- package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +9 -0
- package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +9 -0
- package/site/changelogs/extensions/context-explorer/CHANGELOG.md +9 -0
- package/site/changelogs/extensions/cron/CHANGELOG.md +9 -0
- package/site/changelogs/extensions/graphql/CHANGELOG.md +9 -0
- package/site/changelogs/extensions/health/CHANGELOG.md +9 -0
- package/site/changelogs/extensions/logging/CHANGELOG.md +9 -0
- package/site/changelogs/extensions/metrics/CHANGELOG.md +9 -0
- package/site/changelogs/extensions/pooling/CHANGELOG.md +9 -0
- package/site/changelogs/extensions/socketio/CHANGELOG.md +9 -0
- package/site/changelogs/extensions/typeorm/CHANGELOG.md +9 -0
- package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +9 -0
- package/site/changelogs/packages/authentication/CHANGELOG.md +9 -0
- package/site/changelogs/packages/authorization/CHANGELOG.md +9 -0
- package/site/changelogs/packages/boot/CHANGELOG.md +9 -0
- package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +9 -0
- package/site/changelogs/packages/build/CHANGELOG.md +10 -1
- package/site/changelogs/packages/cli/CHANGELOG.md +14 -0
- package/site/changelogs/packages/context/CHANGELOG.md +9 -0
- package/site/changelogs/packages/core/CHANGELOG.md +9 -0
- package/site/changelogs/packages/eslint-config/CHANGELOG.md +10 -1
- package/site/changelogs/packages/express/CHANGELOG.md +9 -0
- package/site/changelogs/packages/filter/CHANGELOG.md +9 -0
- package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +9 -0
- package/site/changelogs/packages/http-server/CHANGELOG.md +9 -0
- package/site/changelogs/packages/metadata/CHANGELOG.md +9 -0
- package/site/changelogs/packages/model-api-builder/CHANGELOG.md +9 -0
- package/site/changelogs/packages/monorepo/CHANGELOG.md +10 -1
- package/site/changelogs/packages/openapi-spec-builder/CHANGELOG.md +9 -0
- package/site/changelogs/packages/openapi-v3/CHANGELOG.md +9 -0
- package/site/changelogs/packages/repository/CHANGELOG.md +19 -0
- package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +9 -0
- package/site/changelogs/packages/repository-tests/CHANGELOG.md +9 -0
- package/site/changelogs/packages/rest/CHANGELOG.md +9 -0
- package/site/changelogs/packages/rest-crud/CHANGELOG.md +9 -0
- package/site/changelogs/packages/rest-explorer/CHANGELOG.md +9 -0
- package/site/changelogs/packages/security/CHANGELOG.md +9 -0
- package/site/changelogs/packages/service-proxy/CHANGELOG.md +9 -0
- package/site/changelogs/packages/testlab/CHANGELOG.md +10 -1
- package/site/changelogs/packages/tsdocs/CHANGELOG.md +9 -0
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,15 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See
|
|
4
4
|
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [5.1.5](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@5.1.4...@loopback/docs@5.1.5) (2022-12-14)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @loopback/docs
|
|
9
|
+
|
|
10
|
+
# Change Log
|
|
11
|
+
|
|
12
|
+
All notable changes to this project will be documented in this file. See
|
|
13
|
+
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
14
|
+
|
|
6
15
|
## [5.1.4](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@5.1.3...@loopback/docs@5.1.4) (2022-11-24)
|
|
7
16
|
|
|
8
17
|
### Bug Fixes
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@loopback/docs",
|
|
3
3
|
"description": "Documentation files rendered at [https://loopback.io](https://loopback.io)",
|
|
4
|
-
"version": "5.1.
|
|
4
|
+
"version": "5.1.5",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"LoopBack",
|
|
7
7
|
"docs"
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"tslib": "^2.4.1"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
|
-
"@loopback/build": "^9.0.
|
|
39
|
+
"@loopback/build": "^9.0.6"
|
|
40
40
|
},
|
|
41
|
-
"gitHead": "
|
|
41
|
+
"gitHead": "709a5ecd1ffddeb02262cecabf7b663c7b4d7e47"
|
|
42
42
|
}
|
|
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.refereshtokenwithrelations.htm
|
|
|
16
16
|
<b>Signature:</b>
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
|
-
export
|
|
19
|
+
export type RefereshTokenWithRelations = RefreshToken & RefreshTokenRelations;
|
|
20
20
|
```
|
|
21
21
|
<b>References:</b> [RefreshToken](./authentication-jwt.refreshtoken.md)<!-- -->, [RefreshTokenRelations](./authentication-jwt.refreshtokenrelations.md)
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.securityschemeobjects.html
|
|
|
16
16
|
<b>Signature:</b>
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
|
-
export
|
|
19
|
+
export type SecuritySchemeObjects = {
|
|
20
20
|
[securityScheme: string]: SecuritySchemeObject | ReferenceObject;
|
|
21
21
|
};
|
|
22
22
|
```
|
|
@@ -18,7 +18,7 @@ Describes the token object that returned by the refresh token service functions.
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type TokenObject = {
|
|
22
22
|
accessToken: string;
|
|
23
23
|
expiresIn?: string | undefined;
|
|
24
24
|
refreshToken?: string | undefined;
|
|
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.usercredentialswithrelations.h
|
|
|
16
16
|
<b>Signature:</b>
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
|
-
export
|
|
19
|
+
export type UserCredentialsWithRelations = UserCredentials & UserCredentialsRelations;
|
|
20
20
|
```
|
|
21
21
|
<b>References:</b> [UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->, [UserCredentialsRelations](./authentication-jwt.usercredentialsrelations.md)
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.userwithrelations.html
|
|
|
16
16
|
<b>Signature:</b>
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
|
-
export
|
|
19
|
+
export type UserWithRelations = User & UserRelations;
|
|
20
20
|
```
|
|
21
21
|
<b>References:</b> [User](./authentication-jwt.user.md)<!-- -->, [UserRelations](./authentication-jwt.userrelations.md)
|
|
22
22
|
|
|
@@ -18,7 +18,7 @@ A function to decide if access to the target should be allowed or denied
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type Authorizer<T extends AuthorizationMetadata = AuthorizationMetadata> =
|
|
22
22
|
(context: AuthorizationContext, metadata: T) => Promise<AuthorizationDecision>;
|
|
23
23
|
```
|
|
24
24
|
<b>References:</b> [AuthorizationMetadata](./authorization.authorizationmetadata.md)<!-- -->, [AuthorizationContext](./authorization.authorizationcontext.md)<!-- -->, [AuthorizationDecision](./authorization.authorizationdecision.md)
|
|
@@ -18,7 +18,7 @@ Type definition for ArtifactOptions. These are the options supported by this Boo
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type ArtifactOptions = {
|
|
22
22
|
dirs?: string | string[];
|
|
23
23
|
extensions?: string | string[];
|
|
24
24
|
nested?: boolean;
|
|
@@ -18,7 +18,7 @@ A filter function to control if a binding is to be rendered
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type BindingNodeFilter = (binding: ContextBinding) => boolean;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [ContextBinding](./context-explorer.contextbinding.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ The intercepted variant of a function to return `ValueOrPromise<T>`<!-- -->. If
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type AsInterceptedFunction<T> = T extends (...args: InvocationArgs) => infer R ? (...args: Parameters<T>) => AsValueOrPromise<R> : T;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [InvocationArgs](./context.invocationargs.md)<!-- -->, [AsValueOrPromise](./context.asvalueorpromise.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Create the Promise type for `T`<!-- -->. If `T` extends `Promise`<!-- -->, the t
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type AsValueOrPromise<T> = T extends Promise<unknown> ? T : ValueOrPromise<T>;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [ValueOrPromise](./context.valueorpromise.md)
|
|
24
24
|
|
|
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.context.bindingaddress.html
|
|
|
16
16
|
<b>Signature:</b>
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
|
-
export
|
|
19
|
+
export type BindingAddress<T = unknown> = string | BindingKey<T>;
|
|
20
20
|
```
|
|
21
21
|
<b>References:</b> [BindingKey](./context.bindingkey.md)
|
|
22
22
|
|
|
@@ -18,7 +18,7 @@ Information for a binding event
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type BindingEvent = {
|
|
22
22
|
type: 'changed' | string;
|
|
23
23
|
binding: Readonly<Binding<unknown>>;
|
|
24
24
|
operation: 'tag' | 'scope' | 'value' | string;
|
|
@@ -18,7 +18,7 @@ Event listeners for binding events
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type BindingEventListener = (
|
|
22
22
|
event: BindingEvent) => void;
|
|
23
23
|
```
|
|
24
24
|
<b>References:</b> [BindingEvent](./context.bindingevent.md)
|
|
@@ -18,7 +18,7 @@ Select binding(s) by key or a filter function
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type BindingSelector<ValueType = unknown> = BindingAddress<ValueType> | BindingFilter;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [BindingAddress](./context.bindingaddress.md)<!-- -->, [BindingFilter](./context.bindingfilter.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Source for the binding, including the type and value
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type BindingSource<T> = ConstantBindingSource<T> | DynamicValueBindingSource<T> | ClassBindingSource<T> | ProviderBindingSource<T> | AliasBindingSource<T>;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [ConstantBindingSource](./context.constantbindingsource.md)<!-- -->, [DynamicValueBindingSource](./context.dynamicvaluebindingsource.md)<!-- -->, [ClassBindingSource](./context.classbindingsource.md)<!-- -->, [ProviderBindingSource](./context.providerbindingsource.md)<!-- -->, [AliasBindingSource](./context.aliasbindingsource.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Specification of parameters for `@injectable()`
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type BindingSpec<T = unknown> = BindingTemplate<T> | BindingScopeAndTags;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [BindingTemplate](./context.bindingtemplate.md)<!-- -->, [BindingScopeAndTags](./context.bindingscopeandtags.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ A function as the template to configure bindings
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type BindingTemplate<T = unknown> = (binding: Binding<T>) => void;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [Binding](./context.binding.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Synchronous listener for context events
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type ContextEventListener = (event: ContextEvent) => void;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [ContextEvent](./context.contextevent.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Context event observer type - An instance of `ContextObserver` or a function
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type ContextEventObserver = ContextObserver | ContextObserverFn;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [ContextObserver](./context.contextobserver.md)<!-- -->, [ContextObserverFn](./context.contextobserverfn.md)
|
|
24
24
|
|
|
@@ -18,6 +18,6 @@ Context event types. We support `bind` and `unbind` for now but keep it open for
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type ContextEventType = 'bind' | 'unbind' | string;
|
|
22
22
|
```
|
|
23
23
|
|
|
@@ -18,7 +18,7 @@ Listen on `bind`<!-- -->, `unbind`<!-- -->, or other events
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type ContextObserverFn = (eventType: ContextEventType, binding: Readonly<Binding<unknown>>, context: Context) => ValueOrPromise<void>;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [ContextEventType](./context.contexteventtype.md)<!-- -->, [Binding](./context.binding.md)<!-- -->, [Context](./context.context.md)<!-- -->, [ValueOrPromise](./context.valueorpromise.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Binding source for `toDynamicValue`
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type DynamicValueBindingSource<T> = {
|
|
22
22
|
type: BindingType.DYNAMIC_VALUE;
|
|
23
23
|
value: ValueFactory<T> | DynamicValueProviderClass<T>;
|
|
24
24
|
};
|
|
@@ -18,7 +18,7 @@ An interceptor function to be invoked in a chain for the given context. It serve
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type GenericInterceptor<C extends Context = Context> = (context: C, next: Next) => ValueOrPromise<NonVoid>;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [Context](./context.context.md)<!-- -->, [Next](./context.next.md)<!-- -->, [ValueOrPromise](./context.valueorpromise.md)<!-- -->, [NonVoid](./context.nonvoid.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Interceptor function or a binding key that resolves a generic interceptor functi
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type GenericInterceptorOrKey<C extends Context = Context> = BindingAddress<GenericInterceptor<C>> | GenericInterceptor<C>;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [Context](./context.context.md)<!-- -->, [BindingAddress](./context.bindingaddress.md)<!-- -->, [GenericInterceptor](./context.genericinterceptor.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Interceptor function or binding key that can be used as parameters for `@interce
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type InterceptorOrKey = GenericInterceptorOrKey<InvocationContext>;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [GenericInterceptorOrKey](./context.genericinterceptororkey.md)<!-- -->, [InvocationContext](./context.invocationcontext.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ JSON values - primitive - object - array
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type JSONValue = JSONPrimitive | JSONObject | JSONArray;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [JSONPrimitive](./context.jsonprimitive.md)<!-- -->, [JSONObject](./context.jsonobject.md)<!-- -->, [JSONArray](./context.jsonarray.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ The `next` function that can be used to invoke next generic interceptor in the c
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type Next = () => ValueOrPromise<NonVoid>;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [ValueOrPromise](./context.valueorpromise.md)<!-- -->, [NonVoid](./context.nonvoid.md)
|
|
24
24
|
|
|
@@ -18,6 +18,6 @@ Any type except `void`<!-- -->. We use this type to enforce that interceptor fun
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type NonVoid = string | number | boolean | null | undefined | object;
|
|
22
22
|
```
|
|
23
23
|
|
|
@@ -18,7 +18,7 @@ A function to be executed with the resolution session
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type ResolutionAction = (session: ResolutionSession) => ValueOrPromise<BoundValue>;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [ResolutionSession](./context.resolutionsession.md)<!-- -->, [ValueOrPromise](./context.valueorpromise.md)<!-- -->, [BoundValue](./context.boundvalue.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Binding or injection elements tracked by resolution sessions
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type ResolutionElement = BindingElement | InjectionElement;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [BindingElement](./context.bindingelement.md)<!-- -->, [InjectionElement](./context.injectionelement.md)
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Resolution options or session
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export
|
|
21
|
+
export type ResolutionOptionsOrSession = ResolutionOptions | ResolutionSession;
|
|
22
22
|
```
|
|
23
23
|
<b>References:</b> [ResolutionOptions](./context.resolutionoptions.md)<!-- -->, [ResolutionSession](./context.resolutionsession.md)
|
|
24
24
|
|