@loopback/docs 3.27.0 → 4.0.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 +53 -0
- package/package.json +4 -4
- package/site/Authorization-component-authorizer.md +3 -0
- package/site/Include-filter.md +5 -0
- package/site/apidocs/authorization.authorizationoptions.md +2 -2
- package/site/apidocs/boot.bootmixin.md +2 -2
- package/site/apidocs/context.aliasbindingsource.md +1 -1
- package/site/apidocs/context.classbindingsource.md +1 -1
- package/site/apidocs/context.constantbindingsource.md +1 -1
- package/site/apidocs/context.context.createview.md +2 -1
- package/site/apidocs/context.context.getscopedcontext.md +1 -1
- package/site/apidocs/context.context.md +1 -1
- package/site/apidocs/context.contextview._constructor_.md +2 -1
- package/site/apidocs/context.contextview.asgetter.md +2 -2
- package/site/apidocs/context.contextview.md +1 -1
- package/site/apidocs/context.contextview.resolve.md +2 -2
- package/site/apidocs/context.contextview.singlevalue.md +2 -2
- package/site/apidocs/context.contextview.values.md +2 -2
- package/site/apidocs/context.createviewgetter_1.md +2 -2
- package/site/apidocs/context.dynamicvaluebindingsource.md +1 -1
- package/site/apidocs/context.injectionmetadata.md +2 -2
- package/site/apidocs/context.providerbindingsource.md +1 -1
- package/site/apidocs/core.application.md +1 -1
- package/site/apidocs/core.application.state.md +1 -1
- package/site/apidocs/core.extensions.list.md +2 -1
- package/site/apidocs/core.extensions.md +2 -2
- package/site/apidocs/core.extensions.view.md +2 -1
- package/site/apidocs/core.md +1 -1
- package/site/apidocs/express.middlewaremixin.md +2 -2
- package/site/apidocs/filter.inclusion.md +1 -1
- package/site/apidocs/filter.inclusion.scope.md +3 -1
- package/site/apidocs/graphql.graphqlserver.exportgraphqlschema.md +33 -0
- package/site/apidocs/graphql.graphqlserver.md +1 -0
- package/site/apidocs/repository.belongstodefinition.md +1 -1
- package/site/apidocs/repository.findbyforeignkeys.md +4 -2
- package/site/apidocs/repository.hasmanydefinition.md +1 -1
- package/site/apidocs/repository.hasonedefinition.md +1 -1
- package/site/apidocs/repository.repositorymixin.md +2 -2
- package/site/apidocs/rest.normalizeparsingerror.md +2 -2
- package/site/apidocs/rest.restapplication.exportopenapispec.md +2 -5
- package/site/apidocs/rest.resthttperrors.unsupportedmediatype.md +2 -2
- package/site/apidocs/rest.restserver.exportopenapispec.md +2 -5
- package/site/apidocs/service-proxy.servicemixin.md +2 -2
- package/site/apidocs/socketio.socketiobindings.io.md +1 -1
- package/site/apidocs/socketio.socketiobindings.socket.md +1 -1
- package/site/apidocs/socketio.socketioserver.route.md +2 -2
- package/site/apidocs/socketio.socketioserver.use.md +2 -2
- package/site/apidocs/typeorm.typeormmixin.md +2 -2
- package/site/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +45 -0
- package/site/changelogs/examples/access-control-migration/CHANGELOG.md +45 -0
- package/site/changelogs/examples/binding-resolution/CHANGELOG.md +45 -0
- package/site/changelogs/examples/context/CHANGELOG.md +45 -0
- package/site/changelogs/examples/express-composition/CHANGELOG.md +45 -0
- package/site/changelogs/examples/file-transfer/CHANGELOG.md +45 -0
- package/site/changelogs/examples/graphql/CHANGELOG.md +45 -0
- package/site/changelogs/examples/greeter-extension/CHANGELOG.md +45 -0
- package/site/changelogs/examples/greeting-app/CHANGELOG.md +45 -0
- package/site/changelogs/examples/hello-world/CHANGELOG.md +45 -0
- package/site/changelogs/examples/lb3-application/CHANGELOG.md +45 -0
- package/site/changelogs/examples/log-extension/CHANGELOG.md +45 -0
- package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +45 -0
- package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +48 -0
- package/site/changelogs/examples/passport-login/CHANGELOG.md +45 -0
- package/site/changelogs/examples/rest-crud/CHANGELOG.md +45 -0
- package/site/changelogs/examples/rpc-server/CHANGELOG.md +45 -0
- package/site/changelogs/examples/soap-calculator/CHANGELOG.md +45 -0
- package/site/changelogs/examples/socketio/CHANGELOG.md +49 -0
- package/site/changelogs/examples/todo/CHANGELOG.md +45 -0
- package/site/changelogs/examples/todo-jwt/CHANGELOG.md +45 -0
- package/site/changelogs/examples/todo-list/CHANGELOG.md +45 -0
- package/site/changelogs/examples/validation-app/CHANGELOG.md +45 -0
- package/site/changelogs/examples/webpack/CHANGELOG.md +48 -0
- package/site/changelogs/extensions/apiconnect/CHANGELOG.md +45 -0
- package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +54 -0
- package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +45 -0
- package/site/changelogs/extensions/context-explorer/CHANGELOG.md +45 -0
- package/site/changelogs/extensions/cron/CHANGELOG.md +48 -0
- package/site/changelogs/extensions/graphql/CHANGELOG.md +48 -0
- package/site/changelogs/extensions/health/CHANGELOG.md +45 -0
- package/site/changelogs/extensions/logging/CHANGELOG.md +45 -0
- package/site/changelogs/extensions/metrics/CHANGELOG.md +50 -0
- package/site/changelogs/extensions/pooling/CHANGELOG.md +48 -0
- package/site/changelogs/extensions/socketio/CHANGELOG.md +48 -0
- package/site/changelogs/extensions/typeorm/CHANGELOG.md +48 -0
- package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +48 -0
- package/site/changelogs/packages/authentication/CHANGELOG.md +45 -0
- package/site/changelogs/packages/authorization/CHANGELOG.md +45 -0
- package/site/changelogs/packages/boot/CHANGELOG.md +45 -0
- package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +45 -0
- package/site/changelogs/packages/build/CHANGELOG.md +48 -0
- package/site/changelogs/packages/cli/CHANGELOG.md +53 -0
- package/site/changelogs/packages/context/CHANGELOG.md +48 -0
- package/site/changelogs/packages/core/CHANGELOG.md +56 -0
- package/site/changelogs/packages/eslint-config/CHANGELOG.md +45 -0
- package/site/changelogs/packages/express/CHANGELOG.md +45 -0
- package/site/changelogs/packages/filter/CHANGELOG.md +179 -0
- package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +61 -0
- package/site/changelogs/packages/http-server/CHANGELOG.md +45 -0
- package/site/changelogs/packages/metadata/CHANGELOG.md +45 -0
- package/site/changelogs/packages/model-api-builder/CHANGELOG.md +50 -0
- package/site/changelogs/packages/monorepo/CHANGELOG.md +45 -0
- package/site/changelogs/packages/openapi-spec-builder/CHANGELOG.md +45 -0
- package/site/changelogs/packages/openapi-v3/CHANGELOG.md +48 -0
- package/site/changelogs/packages/repository/CHANGELOG.md +51 -0
- package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +54 -0
- package/site/changelogs/packages/repository-tests/CHANGELOG.md +45 -0
- package/site/changelogs/packages/rest/CHANGELOG.md +48 -0
- package/site/changelogs/packages/rest-crud/CHANGELOG.md +45 -0
- package/site/changelogs/packages/rest-explorer/CHANGELOG.md +45 -0
- package/site/changelogs/packages/security/CHANGELOG.md +45 -0
- package/site/changelogs/packages/service-proxy/CHANGELOG.md +45 -0
- package/site/changelogs/packages/testlab/CHANGELOG.md +48 -0
- package/site/changelogs/packages/tsdocs/CHANGELOG.md +48 -0
- package/site/index.md +1 -1
- package/site/readmes/loopback-next/extensions/graphql/README.md +48 -1
- package/site/readmes/loopback-next/packages/build/README.md +9 -0
- package/site/tutorials/todo/todo-tutorial-model.md +0 -1
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
lang: en
|
|
3
|
+
title: 'API docs: graphql.graphqlserver.exportgraphqlschema'
|
|
4
|
+
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
|
|
5
|
+
sidebar: lb4_sidebar
|
|
6
|
+
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/graphql
|
|
7
|
+
permalink: /doc/en/lb4/apidocs.graphql.graphqlserver.exportgraphqlschema.html
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
11
|
+
|
|
12
|
+
[Home](./index.md) > [@loopback/graphql](./graphql.md) > [GraphQLServer](./graphql.graphqlserver.md) > [exportGraphQLSchema](./graphql.graphqlserver.exportgraphqlschema.md)
|
|
13
|
+
|
|
14
|
+
## GraphQLServer.exportGraphQLSchema() method
|
|
15
|
+
|
|
16
|
+
<b>Signature:</b>
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
exportGraphQLSchema(outFile?: string, log?: (message?: any, ...optionalParams: any[]) => void): Promise<void>;
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Parameters
|
|
23
|
+
|
|
24
|
+
| Parameter | Type | Description |
|
|
25
|
+
| --- | --- | --- |
|
|
26
|
+
| outFile | string | |
|
|
27
|
+
| log | (message?: any, ...optionalParams: any\[\]) => void | |
|
|
28
|
+
|
|
29
|
+
<b>Returns:</b>
|
|
30
|
+
|
|
31
|
+
Promise<void>
|
|
32
|
+
|
|
33
|
+
|
|
@@ -42,6 +42,7 @@ export declare class GraphQLServer extends Context implements Server
|
|
|
42
42
|
|
|
43
43
|
| Method | Modifiers | Description |
|
|
44
44
|
| --- | --- | --- |
|
|
45
|
+
| [exportGraphQLSchema(outFile, log)](./graphql.graphqlserver.exportgraphqlschema.md) | | |
|
|
45
46
|
| [getMiddlewareList()](./graphql.graphqlserver.getmiddlewarelist.md) | | Get a list of middleware |
|
|
46
47
|
| [getResolverClasses()](./graphql.graphqlserver.getresolverclasses.md) | | Get a list of resolver classes |
|
|
47
48
|
| [middleware(middleware)](./graphql.graphqlserver.middleware.md) | | Register a GraphQL middleware |
|
|
@@ -27,6 +27,6 @@ export interface BelongsToDefinition extends RelationDefinitionBase
|
|
|
27
27
|
| [keyFrom?](./repository.belongstodefinition.keyfrom.md) | string | <i>(Optional)</i> |
|
|
28
28
|
| [keyTo?](./repository.belongstodefinition.keyto.md) | string | <i>(Optional)</i> |
|
|
29
29
|
| [targetsMany](./repository.belongstodefinition.targetsmany.md) | false | |
|
|
30
|
-
| [type](./repository.belongstodefinition.type.md) | [RelationType.belongsTo](./repository.relationtype.
|
|
30
|
+
| [type](./repository.belongstodefinition.type.md) | [RelationType.belongsTo](./repository.relationtype.md) | |
|
|
31
31
|
|
|
32
32
|
|
|
@@ -18,7 +18,9 @@ Finds model instances that contain any of the provided foreign key values.
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export declare function findByForeignKeys<Target extends Entity, TargetRelations extends object, ForeignKey extends StringKeyOf<Target>>(targetRepository: EntityCrudRepository<Target, unknown, TargetRelations>, fkName: ForeignKey, fkValues: Target[ForeignKey][] | Target[ForeignKey], scope?: Filter<Target
|
|
21
|
+
export declare function findByForeignKeys<Target extends Entity, TargetRelations extends object, ForeignKey extends StringKeyOf<Target>>(targetRepository: EntityCrudRepository<Target, unknown, TargetRelations>, fkName: ForeignKey, fkValues: Target[ForeignKey][] | Target[ForeignKey], scope?: Filter<Target> & {
|
|
22
|
+
totalLimit?: number;
|
|
23
|
+
}, options?: Options): Promise<(Target & TargetRelations)[]>;
|
|
22
24
|
```
|
|
23
25
|
|
|
24
26
|
## Parameters
|
|
@@ -28,7 +30,7 @@ export declare function findByForeignKeys<Target extends Entity, TargetRelations
|
|
|
28
30
|
| targetRepository | [EntityCrudRepository](./repository.entitycrudrepository.md)<!-- --><Target, unknown, TargetRelations> | The target repository where the related model instances are found |
|
|
29
31
|
| fkName | ForeignKey | Name of the foreign key |
|
|
30
32
|
| fkValues | Target\[ForeignKey\]\[\] \| Target\[ForeignKey\] | One value or array of values of the foreign key to be included |
|
|
31
|
-
| scope | [Filter](./filter.filter.md)<!-- --><Target> | Additional scope constraints |
|
|
33
|
+
| scope | [Filter](./filter.filter.md)<!-- --><Target> & { totalLimit?: number; } | Additional scope constraints |
|
|
32
34
|
| options | [Options](./repository.options.md) | Options for the operations |
|
|
33
35
|
|
|
34
36
|
<b>Returns:</b>
|
|
@@ -30,6 +30,6 @@ export interface HasManyDefinition extends RelationDefinitionBase
|
|
|
30
30
|
| [keyTo?](./repository.hasmanydefinition.keyto.md) | string | <i>(Optional)</i> keyTo: The foreign key used by the target model for this relation. keyFrom: The source key used by the source model for this relation.<!-- -->E.g. when a Customer has many Order instances, then keyTo is "customerId". Note that "customerId" is the default FK assumed by the framework, users can provide a custom FK name by setting "keyTo". And Customer.id is keyFrom. keyFrom defaults to the id property of a model. Users can provide a custom source key name by setting "keyTo". |
|
|
31
31
|
| [targetsMany](./repository.hasmanydefinition.targetsmany.md) | true | |
|
|
32
32
|
| [through?](./repository.hasmanydefinition.through.md) | { model: [TypeResolver](./repository.typeresolver.md)<!-- --><[Entity](./repository.entity.md)<!-- -->, typeof [Entity](./repository.entity.md)<!-- -->>; keyFrom?: string; keyTo?: string; } | <i>(Optional)</i> Description of the through model of the hasManyThrough relation.<!-- -->A <code>hasManyThrough</code> relation defines a many-to-many connection with another model. This relation indicates that the declaring model can be matched with zero or more instances of another model by proceeding through a third model.<!-- -->E.g a Category has many Products, and a Product can have many Categories. CategoryProductLink can be the through model. Such a through model has information of foreign keys of the source model(Category) and the target model(Product).<!-- -->Warning: The hasManyThrough interface is experimental and is subject to change. If backwards-incompatible changes are made, a new major version may not be released. |
|
|
33
|
-
| [type](./repository.hasmanydefinition.type.md) | [RelationType.hasMany](./repository.relationtype.
|
|
33
|
+
| [type](./repository.hasmanydefinition.type.md) | [RelationType.hasMany](./repository.relationtype.md) | |
|
|
34
34
|
|
|
35
35
|
|
|
@@ -27,6 +27,6 @@ export interface HasOneDefinition extends RelationDefinitionBase
|
|
|
27
27
|
| [keyFrom?](./repository.hasonedefinition.keyfrom.md) | string | <i>(Optional)</i> |
|
|
28
28
|
| [keyTo?](./repository.hasonedefinition.keyto.md) | string | <i>(Optional)</i> keyTo: The foreign key used by the target model for this relation. keyFrom: The source key used by the source model for this relation.<!-- -->E.g. when a Customer has one Address instance, then keyTo is "customerId". Note that "customerId" is the default FK assumed by the framework, users can provide a custom FK name by setting "keyTo". And Customer.id is keyFrom. keyFrom defaults to the id property of a model. Users can provide a custom source key name by setting "keyTo". |
|
|
29
29
|
| [targetsMany](./repository.hasonedefinition.targetsmany.md) | false | |
|
|
30
|
-
| [type](./repository.hasonedefinition.type.md) | [RelationType.hasOne](./repository.relationtype.
|
|
30
|
+
| [type](./repository.hasonedefinition.type.md) | [RelationType.hasOne](./repository.relationtype.md) | |
|
|
31
31
|
|
|
32
32
|
|
|
@@ -61,7 +61,7 @@ export declare function RepositoryMixin<T extends MixinTarget<Application>>(supe
|
|
|
61
61
|
unsubscribe: (observer: loopbackContext.ContextEventObserver) => boolean;
|
|
62
62
|
close: () => void;
|
|
63
63
|
isSubscribed: (observer: loopbackContext.ContextObserver) => boolean;
|
|
64
|
-
createView: <T_7 = unknown>(filter: loopbackContext.BindingFilter, comparator?: loopbackContext.BindingComparator | undefined) => loopbackContext.ContextView<T_7>;
|
|
64
|
+
createView: <T_7 = unknown>(filter: loopbackContext.BindingFilter, comparator?: loopbackContext.BindingComparator | undefined, options?: Omit<loopbackContext.ResolutionOptions, "session"> | undefined) => loopbackContext.ContextView<T_7>;
|
|
65
65
|
contains: (key: loopbackContext.BindingAddress<unknown>) => boolean;
|
|
66
66
|
isBound: (key: loopbackContext.BindingAddress<unknown>) => boolean;
|
|
67
67
|
getOwnerContext: (keyOrBinding: loopbackContext.BindingAddress<unknown> | Readonly<Binding<unknown>>) => loopbackContext.Context | undefined;
|
|
@@ -121,7 +121,7 @@ export declare function RepositoryMixin<T extends MixinTarget<Application>>(supe
|
|
|
121
121
|
|
|
122
122
|
<b>Returns:</b>
|
|
123
123
|
|
|
124
|
-
{ new (...args: any\[\]): { repository<R extends [Repository](./repository.repository.md)<!-- --><any>>(repoClass: [Class](./repository.class.md)<!-- --><R>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><R>; getRepository<R\_1 extends [Repository](./repository.repository.md)<!-- --><any>>(repo: [Class](./repository.class.md)<!-- --><R\_1>): Promise<R\_1>; dataSource<D extends juggler.DataSource>(dataSource: D \| [Class](./repository.class.md)<!-- --><D>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><D>; model<M extends [Class](./repository.class.md)<!-- --><unknown>>(modelClass: M): [Binding](./context.binding.md)<!-- --><M>; component<C extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->>(componentCtor: [Constructor](./context.constructor.md)<!-- --><C>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><C>; mountComponentRepositories(componentInstanceOrClass: [Class](./repository.class.md)<!-- --><unknown> \| [RepositoryComponent](./repository.repositorycomponent.md)<!-- -->): void; mountComponentModels(component: [RepositoryComponent](./repository.repositorycomponent.md)<!-- -->): void; migrateSchema(options?: [SchemaMigrationOptions](./repository.schemamigrationoptions.md)<!-- -->): Promise<void>; readonly options: loopbackContext.[ApplicationConfig](./core.applicationconfig.md)<!-- -->; readonly state: string; controller: <T\_1>(controllerCtor: loopbackContext.[ControllerClass](./core.controllerclass.md)<!-- --><T\_1>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_1>; server: <T\_2 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctor: [Constructor](./context.constructor.md)<!-- --><T\_2>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_2>; servers: <T\_3 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctors: [Constructor](./context.constructor.md)<!-- --><T\_3>\[\]) => [Binding](./context.binding.md)<!-- --><any>\[\]; getServer: <T\_4 extends loopbackContext.[Server](./core.server.md)<!-- -->>(target: string \| [Constructor](./context.constructor.md)<!-- --><T\_4>) => Promise<T\_4>; init: () => Promise<void>; onInit: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; start: () => Promise<void>; onStart: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; stop: () => Promise<void>; onStop: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; setMetadata: (metadata: loopbackContext.[ApplicationMetadata](./core.applicationmetadata.md)<!-- -->) => void; lifeCycleObserver: <T\_5 extends loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>(ctor: [Constructor](./context.constructor.md)<!-- --><T\_5>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_5>; service: <S>(cls: loopbackContext.[ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- --><S>, nameOrOptions?: string \| loopbackContext.[ServiceOptions](./core.serviceoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><S>; interceptor: (interceptor: loopbackContext.[Interceptor](./context.interceptor.md) \| [Constructor](./context.constructor.md)<!-- --><loopbackContext.[Provider](./context.provider.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>>, nameOrOptions?: string \| loopbackContext.[InterceptorBindingOptions](./context.interceptorbindingoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>; readonly name: string; readonly subscriptionManager: loopbackContext.[ContextSubscriptionManager](./context.contextsubscriptionmanager.md)<!-- -->; scope: [BindingScope](./context.bindingscope.md)<!-- -->; readonly parent: loopbackContext.[Context](./context.context.md) \| undefined; emitEvent: <T\_6 extends loopbackContext.[ContextEvent](./context.contextevent.md)<!-- -->>(type: string, event: T\_6) => void; emitError: (err: unknown) => void; bind: <ValueType = any>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType>) => [Binding](./context.binding.md)<!-- --><ValueType>; add: (binding: [Binding](./context.binding.md)<!-- --><unknown>) => [Application](./core.application.md)<!-- -->; configure: <ConfigValueType = any>(key?: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| undefined) => [Binding](./context.binding.md)<!-- --><ConfigValueType>; getConfigAsValueOrPromise: <ConfigValueType\_1>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ConfigValueType\_1 \| undefined>; getConfig: <ConfigValueType\_2>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => Promise<ConfigValueType\_2 \| undefined>; getConfigSync: <ConfigValueType\_3>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => ConfigValueType\_3 \| undefined; unbind: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; subscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => loopbackContext.[Subscription](./context.subscription.md)<!-- -->; unsubscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => boolean; close: () => void; isSubscribed: (observer: loopbackContext.[ContextObserver](./context.contextobserver.md)<!-- -->) => boolean; createView: <T\_7 = unknown>(filter: loopbackContext.[BindingFilter](./context.bindingfilter.md)<!-- -->, comparator?: loopbackContext.[BindingComparator](./context.bindingcomparator.md) \| undefined) => loopbackContext.[ContextView](./context.contextview.md)<!-- --><T\_7>; contains: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; isBound: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; getOwnerContext: (keyOrBinding: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; getScopedContext: (scope: [BindingScope.APPLICATION](./context.bindingscope.application.md) \| [BindingScope.SERVER](./context.bindingscope.server.md) \| [BindingScope.REQUEST](./context.bindingscope.request.md)<!-- -->) => loopbackContext.[Context](./context.context.md) \| undefined; getResolutionContext: (binding: Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; isVisibleTo: (ctx: loopbackContext.[Context](./context.context.md)<!-- -->) => boolean; find: <ValueType\_1 = any>(pattern?: string \| RegExp \| loopbackContext.[BindingFilter](./context.bindingfilter.md) \| undefined) => Readonly<[Binding](./context.binding.md)<!-- --><ValueType\_1>>\[\]; findByTag: <ValueType\_2 = any>(tagFilter: RegExp \| loopbackContext.[BindingTag](./context.bindingtag.md)<!-- -->) => Readonly<[Binding](./context.binding.md)<!-- --><ValueType\_2>>\[\]; get: { <ValueType\_3>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_3>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): Promise<ValueType\_3>; <ValueType\_4>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_4>, options: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->): Promise<ValueType\_4 \| undefined>; }; getSync: { <ValueType\_5>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_5>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): ValueType\_5; <ValueType\_6>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_6>, options?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined): ValueType\_6 \| undefined; }; getBinding: { <ValueType\_7 = any>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_7>): [Binding](./context.binding.md)<!-- --><ValueType\_7>; <ValueType\_8>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_8>, options?: { optional?: boolean \| undefined; } \| undefined): [Binding](./context.binding.md)<!-- --><ValueType\_8> \| undefined; }; findOrCreateBinding: <T\_8>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><T\_8>, policy?: loopbackContext.[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_8>; getValueOrPromise: <ValueType\_9>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_9>, optionsOrSession?: loopbackContext.[ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ValueType\_9 \| undefined>; toJSON: () => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; inspect: (options?: loopbackContext.[ContextInspectOptions](./context.contextinspectoptions.md) \| undefined) => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; on: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Application](./core.application.md)<!-- -->; }; once: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Application](./core.application.md)<!-- -->; }; addListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; removeListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; off: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; removeAllListeners: (event?: string \| symbol \| undefined) => [Application](./core.application.md)<!-- -->; setMaxListeners: (n: number) => [Application](./core.application.md)<!-- -->; getMaxListeners: () => number; listeners: (event: string \| symbol) => Function\[\]; rawListeners: (event: string \| symbol) => Function\[\]; emit: (event: string \| symbol, ...args: any\[\]) => boolean; listenerCount: (type: string \| symbol) => number; prependListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; prependOnceListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; eventNames: () => (string \| symbol)\[\]; }; } & T
|
|
124
|
+
{ new (...args: any\[\]): { repository<R extends [Repository](./repository.repository.md)<!-- --><any>>(repoClass: [Class](./repository.class.md)<!-- --><R>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><R>; getRepository<R\_1 extends [Repository](./repository.repository.md)<!-- --><any>>(repo: [Class](./repository.class.md)<!-- --><R\_1>): Promise<R\_1>; dataSource<D extends juggler.DataSource>(dataSource: D \| [Class](./repository.class.md)<!-- --><D>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><D>; model<M extends [Class](./repository.class.md)<!-- --><unknown>>(modelClass: M): [Binding](./context.binding.md)<!-- --><M>; component<C extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->>(componentCtor: [Constructor](./context.constructor.md)<!-- --><C>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><C>; mountComponentRepositories(componentInstanceOrClass: [Class](./repository.class.md)<!-- --><unknown> \| [RepositoryComponent](./repository.repositorycomponent.md)<!-- -->): void; mountComponentModels(component: [RepositoryComponent](./repository.repositorycomponent.md)<!-- -->): void; migrateSchema(options?: [SchemaMigrationOptions](./repository.schemamigrationoptions.md)<!-- -->): Promise<void>; readonly options: loopbackContext.[ApplicationConfig](./core.applicationconfig.md)<!-- -->; readonly state: string; controller: <T\_1>(controllerCtor: loopbackContext.[ControllerClass](./core.controllerclass.md)<!-- --><T\_1>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_1>; server: <T\_2 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctor: [Constructor](./context.constructor.md)<!-- --><T\_2>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_2>; servers: <T\_3 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctors: [Constructor](./context.constructor.md)<!-- --><T\_3>\[\]) => [Binding](./context.binding.md)<!-- --><any>\[\]; getServer: <T\_4 extends loopbackContext.[Server](./core.server.md)<!-- -->>(target: string \| [Constructor](./context.constructor.md)<!-- --><T\_4>) => Promise<T\_4>; init: () => Promise<void>; onInit: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; start: () => Promise<void>; onStart: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; stop: () => Promise<void>; onStop: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; setMetadata: (metadata: loopbackContext.[ApplicationMetadata](./core.applicationmetadata.md)<!-- -->) => void; lifeCycleObserver: <T\_5 extends loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>(ctor: [Constructor](./context.constructor.md)<!-- --><T\_5>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_5>; service: <S>(cls: loopbackContext.[ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- --><S>, nameOrOptions?: string \| loopbackContext.[ServiceOptions](./core.serviceoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><S>; interceptor: (interceptor: loopbackContext.[Interceptor](./context.interceptor.md) \| [Constructor](./context.constructor.md)<!-- --><loopbackContext.[Provider](./context.provider.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>>, nameOrOptions?: string \| loopbackContext.[InterceptorBindingOptions](./context.interceptorbindingoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>; readonly name: string; readonly subscriptionManager: loopbackContext.[ContextSubscriptionManager](./context.contextsubscriptionmanager.md)<!-- -->; scope: [BindingScope](./context.bindingscope.md)<!-- -->; readonly parent: loopbackContext.[Context](./context.context.md) \| undefined; emitEvent: <T\_6 extends loopbackContext.[ContextEvent](./context.contextevent.md)<!-- -->>(type: string, event: T\_6) => void; emitError: (err: unknown) => void; bind: <ValueType = any>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType>) => [Binding](./context.binding.md)<!-- --><ValueType>; add: (binding: [Binding](./context.binding.md)<!-- --><unknown>) => [Application](./core.application.md)<!-- -->; configure: <ConfigValueType = any>(key?: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| undefined) => [Binding](./context.binding.md)<!-- --><ConfigValueType>; getConfigAsValueOrPromise: <ConfigValueType\_1>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ConfigValueType\_1 \| undefined>; getConfig: <ConfigValueType\_2>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => Promise<ConfigValueType\_2 \| undefined>; getConfigSync: <ConfigValueType\_3>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => ConfigValueType\_3 \| undefined; unbind: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; subscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => loopbackContext.[Subscription](./context.subscription.md)<!-- -->; unsubscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => boolean; close: () => void; isSubscribed: (observer: loopbackContext.[ContextObserver](./context.contextobserver.md)<!-- -->) => boolean; createView: <T\_7 = unknown>(filter: loopbackContext.[BindingFilter](./context.bindingfilter.md)<!-- -->, comparator?: loopbackContext.[BindingComparator](./context.bindingcomparator.md) \| undefined, options?: Omit<loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, "session"> \| undefined) => loopbackContext.[ContextView](./context.contextview.md)<!-- --><T\_7>; contains: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; isBound: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; getOwnerContext: (keyOrBinding: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; getScopedContext: (scope: [BindingScope.APPLICATION](./context.bindingscope.md) \| [BindingScope.SERVER](./context.bindingscope.md) \| [BindingScope.REQUEST](./context.bindingscope.md)<!-- -->) => loopbackContext.[Context](./context.context.md) \| undefined; getResolutionContext: (binding: Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; isVisibleTo: (ctx: loopbackContext.[Context](./context.context.md)<!-- -->) => boolean; find: <ValueType\_1 = any>(pattern?: string \| RegExp \| loopbackContext.[BindingFilter](./context.bindingfilter.md) \| undefined) => Readonly<[Binding](./context.binding.md)<!-- --><ValueType\_1>>\[\]; findByTag: <ValueType\_2 = any>(tagFilter: RegExp \| loopbackContext.[BindingTag](./context.bindingtag.md)<!-- -->) => Readonly<[Binding](./context.binding.md)<!-- --><ValueType\_2>>\[\]; get: { <ValueType\_3>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_3>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): Promise<ValueType\_3>; <ValueType\_4>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_4>, options: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->): Promise<ValueType\_4 \| undefined>; }; getSync: { <ValueType\_5>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_5>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): ValueType\_5; <ValueType\_6>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_6>, options?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined): ValueType\_6 \| undefined; }; getBinding: { <ValueType\_7 = any>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_7>): [Binding](./context.binding.md)<!-- --><ValueType\_7>; <ValueType\_8>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_8>, options?: { optional?: boolean \| undefined; } \| undefined): [Binding](./context.binding.md)<!-- --><ValueType\_8> \| undefined; }; findOrCreateBinding: <T\_8>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><T\_8>, policy?: loopbackContext.[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_8>; getValueOrPromise: <ValueType\_9>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_9>, optionsOrSession?: loopbackContext.[ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ValueType\_9 \| undefined>; toJSON: () => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; inspect: (options?: loopbackContext.[ContextInspectOptions](./context.contextinspectoptions.md) \| undefined) => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; on: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Application](./core.application.md)<!-- -->; }; once: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Application](./core.application.md)<!-- -->; }; addListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; removeListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; off: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; removeAllListeners: (event?: string \| symbol \| undefined) => [Application](./core.application.md)<!-- -->; setMaxListeners: (n: number) => [Application](./core.application.md)<!-- -->; getMaxListeners: () => number; listeners: (event: string \| symbol) => Function\[\]; rawListeners: (event: string \| symbol) => Function\[\]; emit: (event: string \| symbol, ...args: any\[\]) => boolean; listenerCount: (type: string \| symbol) => number; prependListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; prependOnceListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; eventNames: () => (string \| symbol)\[\]; }; } & T
|
|
125
125
|
|
|
126
126
|
A new class that extends the super class with repository related methods
|
|
127
127
|
|
|
@@ -18,7 +18,7 @@ Normalize parsing errors as `4xx`
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
export declare function normalizeParsingError(err: HttpError): HttpError
|
|
21
|
+
export declare function normalizeParsingError(err: HttpError): HttpError<number>;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
## Parameters
|
|
@@ -29,6 +29,6 @@ export declare function normalizeParsingError(err: HttpError): HttpError;
|
|
|
29
29
|
|
|
30
30
|
<b>Returns:</b>
|
|
31
31
|
|
|
32
|
-
HttpError
|
|
32
|
+
HttpError<number>
|
|
33
33
|
|
|
34
34
|
|
|
@@ -18,10 +18,7 @@ Export the OpenAPI spec to the given json or yaml file
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
exportOpenApiSpec(outFile?: string, log?:
|
|
22
|
-
(...data: any[]): void;
|
|
23
|
-
(message?: any, ...optionalParams: any[]): void;
|
|
24
|
-
}): Promise<void>;
|
|
21
|
+
exportOpenApiSpec(outFile?: string, log?: (message?: any, ...optionalParams: any[]) => void): Promise<void>;
|
|
25
22
|
```
|
|
26
23
|
|
|
27
24
|
## Parameters
|
|
@@ -29,7 +26,7 @@ exportOpenApiSpec(outFile?: string, log?: {
|
|
|
29
26
|
| Parameter | Type | Description |
|
|
30
27
|
| --- | --- | --- |
|
|
31
28
|
| outFile | string | File name for the spec. The extension of the file determines the format of the file. - <code>yaml</code> or <code>yml</code>: YAML - <code>json</code> or other: JSON If the outFile is not provided or its value is <code>''</code> or <code>'-'</code>, the spec is written to the console using the <code>log</code> function. |
|
|
32
|
-
| log |
|
|
29
|
+
| log | (message?: any, ...optionalParams: any\[\]) => void | Log function, default to <code>console.log</code> |
|
|
33
30
|
|
|
34
31
|
<b>Returns:</b>
|
|
35
32
|
|
|
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.rest.resthttperrors.unsupportedmediatype.html
|
|
|
16
16
|
<b>Signature:</b>
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
|
-
function unsupportedMediaType(contentType: string, allowedTypes?: string[]): HttpErrors.HttpError & {
|
|
19
|
+
function unsupportedMediaType(contentType: string, allowedTypes?: string[]): HttpErrors.HttpError<415> & {
|
|
20
20
|
code: string;
|
|
21
21
|
contentType: string;
|
|
22
22
|
allowedMediaTypes: string[];
|
|
@@ -32,6 +32,6 @@ function unsupportedMediaType(contentType: string, allowedTypes?: string[]): Htt
|
|
|
32
32
|
|
|
33
33
|
<b>Returns:</b>
|
|
34
34
|
|
|
35
|
-
HttpErrors.HttpError & { code: string; contentType: string; allowedMediaTypes: string\[\]; }
|
|
35
|
+
HttpErrors.HttpError<415> & { code: string; contentType: string; allowedMediaTypes: string\[\]; }
|
|
36
36
|
|
|
37
37
|
|
|
@@ -18,10 +18,7 @@ Export the OpenAPI spec to the given json or yaml file
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
exportOpenApiSpec(outFile?: string, log?:
|
|
22
|
-
(...data: any[]): void;
|
|
23
|
-
(message?: any, ...optionalParams: any[]): void;
|
|
24
|
-
}): Promise<void>;
|
|
21
|
+
exportOpenApiSpec(outFile?: string, log?: (message?: any, ...optionalParams: any[]) => void): Promise<void>;
|
|
25
22
|
```
|
|
26
23
|
|
|
27
24
|
## Parameters
|
|
@@ -29,7 +26,7 @@ exportOpenApiSpec(outFile?: string, log?: {
|
|
|
29
26
|
| Parameter | Type | Description |
|
|
30
27
|
| --- | --- | --- |
|
|
31
28
|
| outFile | string | File name for the spec. The extension of the file determines the format of the file. - <code>yaml</code> or <code>yml</code>: YAML - <code>json</code> or other: JSON If the outFile is not provided or its value is <code>''</code> or <code>'-'</code>, the spec is written to the console using the <code>log</code> function. |
|
|
32
|
-
| log |
|
|
29
|
+
| log | (message?: any, ...optionalParams: any\[\]) => void | Log function, default to <code>console.log</code> |
|
|
33
30
|
|
|
34
31
|
<b>Returns:</b>
|
|
35
32
|
|
|
@@ -56,7 +56,7 @@ export declare function ServiceMixin<T extends MixinTarget<Application>>(superCl
|
|
|
56
56
|
unsubscribe: (observer: loopbackContext.ContextEventObserver) => boolean;
|
|
57
57
|
close: () => void;
|
|
58
58
|
isSubscribed: (observer: loopbackContext.ContextObserver) => boolean;
|
|
59
|
-
createView: <T_7 = unknown>(filter: loopbackContext.BindingFilter, comparator?: loopbackContext.BindingComparator | undefined) => loopbackContext.ContextView<T_7>;
|
|
59
|
+
createView: <T_7 = unknown>(filter: loopbackContext.BindingFilter, comparator?: loopbackContext.BindingComparator | undefined, options?: Omit<loopbackContext.ResolutionOptions, "session"> | undefined) => loopbackContext.ContextView<T_7>;
|
|
60
60
|
contains: (key: BindingAddress<unknown>) => boolean;
|
|
61
61
|
isBound: (key: BindingAddress<unknown>) => boolean;
|
|
62
62
|
getOwnerContext: (keyOrBinding: BindingAddress<unknown> | Readonly<Binding<unknown>>) => loopbackContext.Context | undefined;
|
|
@@ -116,7 +116,7 @@ export declare function ServiceMixin<T extends MixinTarget<Application>>(superCl
|
|
|
116
116
|
|
|
117
117
|
<b>Returns:</b>
|
|
118
118
|
|
|
119
|
-
{ new (...args: any\[\]): { serviceProvider<S>(provider: [Constructor](./context.constructor.md)<!-- --><[Provider](./context.provider.md)<!-- --><S>>, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><S>; component<C extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->>(componentCtor: [Constructor](./context.constructor.md)<!-- --><C>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><C>; mountComponentServices<C\_1 extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->>(component: [Constructor](./context.constructor.md)<!-- --><C\_1>, componentBindingKey?: [BindingAddress](./context.bindingaddress.md)<!-- --><C\_1> \| undefined): void; readonly options: loopbackContext.[ApplicationConfig](./core.applicationconfig.md)<!-- -->; readonly state: string; controller: <T\_1>(controllerCtor: loopbackContext.[ControllerClass](./core.controllerclass.md)<!-- --><T\_1>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_1>; server: <T\_2 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctor: [Constructor](./context.constructor.md)<!-- --><T\_2>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_2>; servers: <T\_3 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctors: [Constructor](./context.constructor.md)<!-- --><T\_3>\[\]) => [Binding](./context.binding.md)<!-- --><any>\[\]; getServer: <T\_4 extends loopbackContext.[Server](./core.server.md)<!-- -->>(target: string \| [Constructor](./context.constructor.md)<!-- --><T\_4>) => Promise<T\_4>; init: () => Promise<void>; onInit: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; start: () => Promise<void>; onStart: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; stop: () => Promise<void>; onStop: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; setMetadata: (metadata: loopbackContext.[ApplicationMetadata](./core.applicationmetadata.md)<!-- -->) => void; lifeCycleObserver: <T\_5 extends loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>(ctor: [Constructor](./context.constructor.md)<!-- --><T\_5>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_5>; service: <S\_1>(cls: loopbackContext.[ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- --><S\_1>, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><S\_1>; interceptor: (interceptor: loopbackContext.[Interceptor](./context.interceptor.md) \| [Constructor](./context.constructor.md)<!-- --><[Provider](./context.provider.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>>, nameOrOptions?: string \| loopbackContext.[InterceptorBindingOptions](./context.interceptorbindingoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>; readonly name: string; readonly subscriptionManager: loopbackContext.[ContextSubscriptionManager](./context.contextsubscriptionmanager.md)<!-- -->; scope: loopbackContext.[BindingScope](./context.bindingscope.md)<!-- -->; readonly parent: loopbackContext.[Context](./context.context.md) \| undefined; emitEvent: <T\_6 extends loopbackContext.[ContextEvent](./context.contextevent.md)<!-- -->>(type: string, event: T\_6) => void; emitError: (err: unknown) => void; bind: <ValueType = any>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType>) => [Binding](./context.binding.md)<!-- --><ValueType>; add: (binding: [Binding](./context.binding.md)<!-- --><unknown>) => [Application](./core.application.md)<!-- -->; configure: <ConfigValueType = any>(key?: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| undefined) => [Binding](./context.binding.md)<!-- --><ConfigValueType>; getConfigAsValueOrPromise: <ConfigValueType\_1>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ConfigValueType\_1 \| undefined>; getConfig: <ConfigValueType\_2>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => Promise<ConfigValueType\_2 \| undefined>; getConfigSync: <ConfigValueType\_3>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => ConfigValueType\_3 \| undefined; unbind: (key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; subscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => loopbackContext.[Subscription](./context.subscription.md)<!-- -->; unsubscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => boolean; close: () => void; isSubscribed: (observer: loopbackContext.[ContextObserver](./context.contextobserver.md)<!-- -->) => boolean; createView: <T\_7 = unknown>(filter: loopbackContext.[BindingFilter](./context.bindingfilter.md)<!-- -->, comparator?: loopbackContext.[BindingComparator](./context.bindingcomparator.md) \| undefined) => loopbackContext.[ContextView](./context.contextview.md)<!-- --><T\_7>; contains: (key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; isBound: (key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; getOwnerContext: (keyOrBinding: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; getScopedContext: (scope: loopbackContext.[BindingScope.APPLICATION](./context.bindingscope.application.md) \| loopbackContext.[BindingScope.SERVER](./context.bindingscope.server.md) \| loopbackContext.[BindingScope.REQUEST](./context.bindingscope.request.md)<!-- -->) => loopbackContext.[Context](./context.context.md) \| undefined; getResolutionContext: (binding: Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; isVisibleTo: (ctx: loopbackContext.[Context](./context.context.md)<!-- -->) => boolean; find: <ValueType\_1 = any>(pattern?: string \| RegExp \| loopbackContext.[BindingFilter](./context.bindingfilter.md) \| undefined) => Readonly<[Binding](./context.binding.md)<!-- --><ValueType\_1>>\[\]; findByTag: <ValueType\_2 = any>(tagFilter: RegExp \| loopbackContext.[BindingTag](./context.bindingtag.md)<!-- -->) => Readonly<[Binding](./context.binding.md)<!-- --><ValueType\_2>>\[\]; get: { <ValueType\_3>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_3>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): Promise<ValueType\_3>; <ValueType\_4>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_4>, options: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->): Promise<ValueType\_4 \| undefined>; }; getSync: { <ValueType\_5>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_5>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): ValueType\_5; <ValueType\_6>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_6>, options?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined): ValueType\_6 \| undefined; }; getBinding: { <ValueType\_7 = any>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_7>): [Binding](./context.binding.md)<!-- --><ValueType\_7>; <ValueType\_8>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_8>, options?: { optional?: boolean \| undefined; } \| undefined): [Binding](./context.binding.md)<!-- --><ValueType\_8> \| undefined; }; findOrCreateBinding: <T\_8>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><T\_8>, policy?: loopbackContext.[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_8>; getValueOrPromise: <ValueType\_9>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_9>, optionsOrSession?: loopbackContext.[ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ValueType\_9 \| undefined>; toJSON: () => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; inspect: (options?: loopbackContext.[ContextInspectOptions](./context.contextinspectoptions.md) \| undefined) => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; on: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Application](./core.application.md)<!-- -->; }; once: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Application](./core.application.md)<!-- -->; }; addListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; removeListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; off: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; removeAllListeners: (event?: string \| symbol \| undefined) => [Application](./core.application.md)<!-- -->; setMaxListeners: (n: number) => [Application](./core.application.md)<!-- -->; getMaxListeners: () => number; listeners: (event: string \| symbol) => Function\[\]; rawListeners: (event: string \| symbol) => Function\[\]; emit: (event: string \| symbol, ...args: any\[\]) => boolean; listenerCount: (type: string \| symbol) => number; prependListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; prependOnceListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; eventNames: () => (string \| symbol)\[\]; }; } & T
|
|
119
|
+
{ new (...args: any\[\]): { serviceProvider<S>(provider: [Constructor](./context.constructor.md)<!-- --><[Provider](./context.provider.md)<!-- --><S>>, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><S>; component<C extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->>(componentCtor: [Constructor](./context.constructor.md)<!-- --><C>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined): [Binding](./context.binding.md)<!-- --><C>; mountComponentServices<C\_1 extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->>(component: [Constructor](./context.constructor.md)<!-- --><C\_1>, componentBindingKey?: [BindingAddress](./context.bindingaddress.md)<!-- --><C\_1> \| undefined): void; readonly options: loopbackContext.[ApplicationConfig](./core.applicationconfig.md)<!-- -->; readonly state: string; controller: <T\_1>(controllerCtor: loopbackContext.[ControllerClass](./core.controllerclass.md)<!-- --><T\_1>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_1>; server: <T\_2 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctor: [Constructor](./context.constructor.md)<!-- --><T\_2>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_2>; servers: <T\_3 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctors: [Constructor](./context.constructor.md)<!-- --><T\_3>\[\]) => [Binding](./context.binding.md)<!-- --><any>\[\]; getServer: <T\_4 extends loopbackContext.[Server](./core.server.md)<!-- -->>(target: string \| [Constructor](./context.constructor.md)<!-- --><T\_4>) => Promise<T\_4>; init: () => Promise<void>; onInit: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; start: () => Promise<void>; onStart: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; stop: () => Promise<void>; onStop: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => [Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; setMetadata: (metadata: loopbackContext.[ApplicationMetadata](./core.applicationmetadata.md)<!-- -->) => void; lifeCycleObserver: <T\_5 extends loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>(ctor: [Constructor](./context.constructor.md)<!-- --><T\_5>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_5>; service: <S\_1>(cls: loopbackContext.[ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- --><S\_1>, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><S\_1>; interceptor: (interceptor: loopbackContext.[Interceptor](./context.interceptor.md) \| [Constructor](./context.constructor.md)<!-- --><[Provider](./context.provider.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>>, nameOrOptions?: string \| loopbackContext.[InterceptorBindingOptions](./context.interceptorbindingoptions.md) \| undefined) => [Binding](./context.binding.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>; readonly name: string; readonly subscriptionManager: loopbackContext.[ContextSubscriptionManager](./context.contextsubscriptionmanager.md)<!-- -->; scope: loopbackContext.[BindingScope](./context.bindingscope.md)<!-- -->; readonly parent: loopbackContext.[Context](./context.context.md) \| undefined; emitEvent: <T\_6 extends loopbackContext.[ContextEvent](./context.contextevent.md)<!-- -->>(type: string, event: T\_6) => void; emitError: (err: unknown) => void; bind: <ValueType = any>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType>) => [Binding](./context.binding.md)<!-- --><ValueType>; add: (binding: [Binding](./context.binding.md)<!-- --><unknown>) => [Application](./core.application.md)<!-- -->; configure: <ConfigValueType = any>(key?: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| undefined) => [Binding](./context.binding.md)<!-- --><ConfigValueType>; getConfigAsValueOrPromise: <ConfigValueType\_1>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ConfigValueType\_1 \| undefined>; getConfig: <ConfigValueType\_2>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => Promise<ConfigValueType\_2 \| undefined>; getConfigSync: <ConfigValueType\_3>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => ConfigValueType\_3 \| undefined; unbind: (key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; subscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => loopbackContext.[Subscription](./context.subscription.md)<!-- -->; unsubscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => boolean; close: () => void; isSubscribed: (observer: loopbackContext.[ContextObserver](./context.contextobserver.md)<!-- -->) => boolean; createView: <T\_7 = unknown>(filter: loopbackContext.[BindingFilter](./context.bindingfilter.md)<!-- -->, comparator?: loopbackContext.[BindingComparator](./context.bindingcomparator.md) \| undefined, options?: Omit<loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, "session"> \| undefined) => loopbackContext.[ContextView](./context.contextview.md)<!-- --><T\_7>; contains: (key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; isBound: (key: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; getOwnerContext: (keyOrBinding: [BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; getScopedContext: (scope: loopbackContext.[BindingScope.APPLICATION](./context.bindingscope.md) \| loopbackContext.[BindingScope.SERVER](./context.bindingscope.md) \| loopbackContext.[BindingScope.REQUEST](./context.bindingscope.md)<!-- -->) => loopbackContext.[Context](./context.context.md) \| undefined; getResolutionContext: (binding: Readonly<[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; isVisibleTo: (ctx: loopbackContext.[Context](./context.context.md)<!-- -->) => boolean; find: <ValueType\_1 = any>(pattern?: string \| RegExp \| loopbackContext.[BindingFilter](./context.bindingfilter.md) \| undefined) => Readonly<[Binding](./context.binding.md)<!-- --><ValueType\_1>>\[\]; findByTag: <ValueType\_2 = any>(tagFilter: RegExp \| loopbackContext.[BindingTag](./context.bindingtag.md)<!-- -->) => Readonly<[Binding](./context.binding.md)<!-- --><ValueType\_2>>\[\]; get: { <ValueType\_3>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_3>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): Promise<ValueType\_3>; <ValueType\_4>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_4>, options: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->): Promise<ValueType\_4 \| undefined>; }; getSync: { <ValueType\_5>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_5>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): ValueType\_5; <ValueType\_6>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_6>, options?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined): ValueType\_6 \| undefined; }; getBinding: { <ValueType\_7 = any>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_7>): [Binding](./context.binding.md)<!-- --><ValueType\_7>; <ValueType\_8>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_8>, options?: { optional?: boolean \| undefined; } \| undefined): [Binding](./context.binding.md)<!-- --><ValueType\_8> \| undefined; }; findOrCreateBinding: <T\_8>(key: [BindingAddress](./context.bindingaddress.md)<!-- --><T\_8>, policy?: loopbackContext.[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) => [Binding](./context.binding.md)<!-- --><T\_8>; getValueOrPromise: <ValueType\_9>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_9>, optionsOrSession?: loopbackContext.[ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ValueType\_9 \| undefined>; toJSON: () => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; inspect: (options?: loopbackContext.[ContextInspectOptions](./context.contextinspectoptions.md) \| undefined) => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; on: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Application](./core.application.md)<!-- -->; }; once: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): [Application](./core.application.md)<!-- -->; }; addListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; removeListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; off: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; removeAllListeners: (event?: string \| symbol \| undefined) => [Application](./core.application.md)<!-- -->; setMaxListeners: (n: number) => [Application](./core.application.md)<!-- -->; getMaxListeners: () => number; listeners: (event: string \| symbol) => Function\[\]; rawListeners: (event: string \| symbol) => Function\[\]; emit: (event: string \| symbol, ...args: any\[\]) => boolean; listenerCount: (type: string \| symbol) => number; prependListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; prependOnceListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md)<!-- -->; eventNames: () => (string \| symbol)\[\]; }; } & T
|
|
120
120
|
|
|
121
121
|
A new class that extends the super class with service proxy related methods
|
|
122
122
|
|
|
@@ -16,6 +16,6 @@ permalink: /doc/en/lb4/apidocs.socketio.socketiobindings.io.html
|
|
|
16
16
|
<b>Signature:</b>
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
|
-
IO: BindingKey<Server<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap>>
|
|
19
|
+
IO: BindingKey<Server<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, any>>
|
|
20
20
|
```
|
|
21
21
|
|
|
@@ -16,6 +16,6 @@ permalink: /doc/en/lb4/apidocs.socketio.socketiobindings.socket.html
|
|
|
16
16
|
<b>Signature:</b>
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
|
-
SOCKET: BindingKey<Socket<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap>>
|
|
19
|
+
SOCKET: BindingKey<Socket<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, any>>
|
|
20
20
|
```
|
|
21
21
|
|
|
@@ -18,7 +18,7 @@ Register a socketio controller
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
route(controllerClass: Constructor<object>, meta?: SocketIoMetadata | string | RegExp): Server<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap> | import("socket.io").Namespace<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap>;
|
|
21
|
+
route(controllerClass: Constructor<object>, meta?: SocketIoMetadata | string | RegExp): Server<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, any> | import("socket.io").Namespace<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, any>;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
## Parameters
|
|
@@ -30,6 +30,6 @@ route(controllerClass: Constructor<object>, meta?: SocketIoMetadata | string | R
|
|
|
30
30
|
|
|
31
31
|
<b>Returns:</b>
|
|
32
32
|
|
|
33
|
-
Server<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap> \| import("socket.io").Namespace<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap>
|
|
33
|
+
Server<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, any> \| import("socket.io").Namespace<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, any>
|
|
34
34
|
|
|
35
35
|
|
|
@@ -18,7 +18,7 @@ Register a sock.io middleware function
|
|
|
18
18
|
<b>Signature:</b>
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
use(fn: SockIOMiddleware): Server<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap>;
|
|
21
|
+
use(fn: SockIOMiddleware): Server<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, any>;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
## Parameters
|
|
@@ -29,6 +29,6 @@ use(fn: SockIOMiddleware): Server<import("socket.io/dist/typed-events").DefaultE
|
|
|
29
29
|
|
|
30
30
|
<b>Returns:</b>
|
|
31
31
|
|
|
32
|
-
Server<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap>
|
|
32
|
+
Server<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, any>
|
|
33
33
|
|
|
34
34
|
|
|
@@ -55,7 +55,7 @@ export declare function TypeOrmMixin<T extends MixinTarget<Application>>(superCl
|
|
|
55
55
|
unsubscribe: (observer: loopbackContext.ContextEventObserver) => boolean;
|
|
56
56
|
close: () => void;
|
|
57
57
|
isSubscribed: (observer: loopbackContext.ContextObserver) => boolean;
|
|
58
|
-
createView: <T_8 = unknown>(filter: loopbackContext.BindingFilter, comparator?: loopbackContext.BindingComparator | undefined) => loopbackContext.ContextView<T_8>;
|
|
58
|
+
createView: <T_8 = unknown>(filter: loopbackContext.BindingFilter, comparator?: loopbackContext.BindingComparator | undefined, options?: Omit<loopbackContext.ResolutionOptions, "session"> | undefined) => loopbackContext.ContextView<T_8>;
|
|
59
59
|
contains: (key: loopbackContext.BindingAddress<unknown>) => boolean;
|
|
60
60
|
isBound: (key: loopbackContext.BindingAddress<unknown>) => boolean;
|
|
61
61
|
getOwnerContext: (keyOrBinding: loopbackContext.BindingAddress<unknown> | Readonly<loopbackContext.Binding<unknown>>) => loopbackContext.Context | undefined;
|
|
@@ -115,6 +115,6 @@ export declare function TypeOrmMixin<T extends MixinTarget<Application>>(superCl
|
|
|
115
115
|
|
|
116
116
|
<b>Returns:</b>
|
|
117
117
|
|
|
118
|
-
{ new (...args: any\[\]): { connectionManager: ConnectionManager; connection(connectionConfig: ConnectionOptions): loopbackContext.[Binding](./context.binding.md)<!-- --><Connection>; migrateSchema(): Promise<void>; readonly options: loopbackContext.[ApplicationConfig](./core.applicationconfig.md)<!-- -->; readonly state: string; controller: <T\_1>(controllerCtor: loopbackContext.[ControllerClass](./core.controllerclass.md)<!-- --><T\_1>, nameOrOptions?: string \| loopbackContext.[BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><T\_1>; server: <T\_2 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctor: loopbackContext.[Constructor](./context.constructor.md)<!-- --><T\_2>, nameOrOptions?: string \| loopbackContext.[BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><T\_2>; servers: <T\_3 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctors: loopbackContext.[Constructor](./context.constructor.md)<!-- --><T\_3>\[\]) => loopbackContext.[Binding](./context.binding.md)<!-- --><any>\[\]; getServer: <T\_4 extends loopbackContext.[Server](./core.server.md)<!-- -->>(target: string \| loopbackContext.[Constructor](./context.constructor.md)<!-- --><T\_4>) => Promise<T\_4>; init: () => Promise<void>; onInit: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => loopbackContext.[Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; start: () => Promise<void>; onStart: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => loopbackContext.[Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; stop: () => Promise<void>; onStop: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => loopbackContext.[Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; component: <T\_5 extends loopbackContext.[Component](./core.component.md) = loopbackContext.[Component](./core.component.md)<!-- -->>(componentCtor: loopbackContext.[Constructor](./context.constructor.md)<!-- --><T\_5>, nameOrOptions?: string \| loopbackContext.[BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><T\_5>; setMetadata: (metadata: loopbackContext.[ApplicationMetadata](./core.applicationmetadata.md)<!-- -->) => void; lifeCycleObserver: <T\_6 extends loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>(ctor: loopbackContext.[Constructor](./context.constructor.md)<!-- --><T\_6>, nameOrOptions?: string \| loopbackContext.[BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><T\_6>; service: <S>(cls: loopbackContext.[ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- --><S>, nameOrOptions?: string \| loopbackContext.[ServiceOptions](./core.serviceoptions.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><S>; interceptor: (interceptor: loopbackContext.[Interceptor](./context.interceptor.md) \| loopbackContext.[Constructor](./context.constructor.md)<!-- --><loopbackContext.[Provider](./context.provider.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>>, nameOrOptions?: string \| loopbackContext.[InterceptorBindingOptions](./context.interceptorbindingoptions.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>; readonly name: string; readonly subscriptionManager: loopbackContext.[ContextSubscriptionManager](./context.contextsubscriptionmanager.md)<!-- -->; scope: loopbackContext.[BindingScope](./context.bindingscope.md)<!-- -->; readonly parent: loopbackContext.[Context](./context.context.md) \| undefined; emitEvent: <T\_7 extends loopbackContext.[ContextEvent](./context.contextevent.md)<!-- -->>(type: string, event: T\_7) => void; emitError: (err: unknown) => void; bind: <ValueType = any>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType>) => loopbackContext.[Binding](./context.binding.md)<!-- --><ValueType>; add: (binding: loopbackContext.[Binding](./context.binding.md)<!-- --><unknown>) => loopbackContext.[Application](./core.application.md)<!-- -->; configure: <ConfigValueType = any>(key?: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><ConfigValueType>; getConfigAsValueOrPromise: <ConfigValueType\_1>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ConfigValueType\_1 \| undefined>; getConfig: <ConfigValueType\_2>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => Promise<ConfigValueType\_2 \| undefined>; getConfigSync: <ConfigValueType\_3>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => ConfigValueType\_3 \| undefined; unbind: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; subscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => loopbackContext.[Subscription](./context.subscription.md)<!-- -->; unsubscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => boolean; close: () => void; isSubscribed: (observer: loopbackContext.[ContextObserver](./context.contextobserver.md)<!-- -->) => boolean; createView: <T\_8 = unknown>(filter: loopbackContext.[BindingFilter](./context.bindingfilter.md)<!-- -->, comparator?: loopbackContext.[BindingComparator](./context.bindingcomparator.md) \| undefined) => loopbackContext.[ContextView](./context.contextview.md)<!-- --><T\_8>; contains: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; isBound: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; getOwnerContext: (keyOrBinding: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| Readonly<loopbackContext.[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; getScopedContext: (scope: loopbackContext.[BindingScope.APPLICATION](./context.bindingscope.application.md) \| loopbackContext.[BindingScope.SERVER](./context.bindingscope.server.md) \| loopbackContext.[BindingScope.REQUEST](./context.bindingscope.request.md)<!-- -->) => loopbackContext.[Context](./context.context.md) \| undefined; getResolutionContext: (binding: Readonly<loopbackContext.[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; isVisibleTo: (ctx: loopbackContext.[Context](./context.context.md)<!-- -->) => boolean; find: <ValueType\_1 = any>(pattern?: string \| RegExp \| loopbackContext.[BindingFilter](./context.bindingfilter.md) \| undefined) => Readonly<loopbackContext.[Binding](./context.binding.md)<!-- --><ValueType\_1>>\[\]; findByTag: <ValueType\_2 = any>(tagFilter: RegExp \| loopbackContext.[BindingTag](./context.bindingtag.md)<!-- -->) => Readonly<loopbackContext.[Binding](./context.binding.md)<!-- --><ValueType\_2>>\[\]; get: { <ValueType\_3>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_3>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): Promise<ValueType\_3>; <ValueType\_4>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_4>, options: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->): Promise<ValueType\_4 \| undefined>; }; getSync: { <ValueType\_5>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_5>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): ValueType\_5; <ValueType\_6>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_6>, options?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined): ValueType\_6 \| undefined; }; getBinding: { <ValueType\_7 = any>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_7>): loopbackContext.[Binding](./context.binding.md)<!-- --><ValueType\_7>; <ValueType\_8>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_8>, options?: { optional?: boolean \| undefined; } \| undefined): loopbackContext.[Binding](./context.binding.md)<!-- --><ValueType\_8> \| undefined; }; findOrCreateBinding: <T\_9>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><T\_9>, policy?: loopbackContext.[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><T\_9>; getValueOrPromise: <ValueType\_9>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_9>, optionsOrSession?: loopbackContext.[ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ValueType\_9 \| undefined>; toJSON: () => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; inspect: (options?: loopbackContext.[ContextInspectOptions](./context.contextinspectoptions.md) \| undefined) => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; on: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): loopbackContext.[Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): loopbackContext.[Application](./core.application.md)<!-- -->; }; once: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): loopbackContext.[Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): loopbackContext.[Application](./core.application.md)<!-- -->; }; addListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => loopbackContext.[Application](./core.application.md)<!-- -->; removeListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => loopbackContext.[Application](./core.application.md)<!-- -->; off: (event: string \| symbol, listener: (...args: any\[\]) => void) => loopbackContext.[Application](./core.application.md)<!-- -->; removeAllListeners: (event?: string \| symbol \| undefined) => loopbackContext.[Application](./core.application.md)<!-- -->; setMaxListeners: (n: number) => loopbackContext.[Application](./core.application.md)<!-- -->; getMaxListeners: () => number; listeners: (event: string \| symbol) => Function\[\]; rawListeners: (event: string \| symbol) => Function\[\]; emit: (event: string \| symbol, ...args: any\[\]) => boolean; listenerCount: (type: string \| symbol) => number; prependListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => loopbackContext.[Application](./core.application.md)<!-- -->; prependOnceListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => loopbackContext.[Application](./core.application.md)<!-- -->; eventNames: () => (string \| symbol)\[\]; }; } & T
|
|
118
|
+
{ new (...args: any\[\]): { connectionManager: ConnectionManager; connection(connectionConfig: ConnectionOptions): loopbackContext.[Binding](./context.binding.md)<!-- --><Connection>; migrateSchema(): Promise<void>; readonly options: loopbackContext.[ApplicationConfig](./core.applicationconfig.md)<!-- -->; readonly state: string; controller: <T\_1>(controllerCtor: loopbackContext.[ControllerClass](./core.controllerclass.md)<!-- --><T\_1>, nameOrOptions?: string \| loopbackContext.[BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><T\_1>; server: <T\_2 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctor: loopbackContext.[Constructor](./context.constructor.md)<!-- --><T\_2>, nameOrOptions?: string \| loopbackContext.[BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><T\_2>; servers: <T\_3 extends loopbackContext.[Server](./core.server.md)<!-- -->>(ctors: loopbackContext.[Constructor](./context.constructor.md)<!-- --><T\_3>\[\]) => loopbackContext.[Binding](./context.binding.md)<!-- --><any>\[\]; getServer: <T\_4 extends loopbackContext.[Server](./core.server.md)<!-- -->>(target: string \| loopbackContext.[Constructor](./context.constructor.md)<!-- --><T\_4>) => Promise<T\_4>; init: () => Promise<void>; onInit: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => loopbackContext.[Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; start: () => Promise<void>; onStart: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => loopbackContext.[Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; stop: () => Promise<void>; onStop: (fn: () => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><void>) => loopbackContext.[Binding](./context.binding.md)<!-- --><loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>; component: <T\_5 extends loopbackContext.[Component](./core.component.md) = loopbackContext.[Component](./core.component.md)<!-- -->>(componentCtor: loopbackContext.[Constructor](./context.constructor.md)<!-- --><T\_5>, nameOrOptions?: string \| loopbackContext.[BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><T\_5>; setMetadata: (metadata: loopbackContext.[ApplicationMetadata](./core.applicationmetadata.md)<!-- -->) => void; lifeCycleObserver: <T\_6 extends loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->>(ctor: loopbackContext.[Constructor](./context.constructor.md)<!-- --><T\_6>, nameOrOptions?: string \| loopbackContext.[BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><T\_6>; service: <S>(cls: loopbackContext.[ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- --><S>, nameOrOptions?: string \| loopbackContext.[ServiceOptions](./core.serviceoptions.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><S>; interceptor: (interceptor: loopbackContext.[Interceptor](./context.interceptor.md) \| loopbackContext.[Constructor](./context.constructor.md)<!-- --><loopbackContext.[Provider](./context.provider.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>>, nameOrOptions?: string \| loopbackContext.[InterceptorBindingOptions](./context.interceptorbindingoptions.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->>; readonly name: string; readonly subscriptionManager: loopbackContext.[ContextSubscriptionManager](./context.contextsubscriptionmanager.md)<!-- -->; scope: loopbackContext.[BindingScope](./context.bindingscope.md)<!-- -->; readonly parent: loopbackContext.[Context](./context.context.md) \| undefined; emitEvent: <T\_7 extends loopbackContext.[ContextEvent](./context.contextevent.md)<!-- -->>(type: string, event: T\_7) => void; emitError: (err: unknown) => void; bind: <ValueType = any>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType>) => loopbackContext.[Binding](./context.binding.md)<!-- --><ValueType>; add: (binding: loopbackContext.[Binding](./context.binding.md)<!-- --><unknown>) => loopbackContext.[Application](./core.application.md)<!-- -->; configure: <ConfigValueType = any>(key?: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><ConfigValueType>; getConfigAsValueOrPromise: <ConfigValueType\_1>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ConfigValueType\_1 \| undefined>; getConfig: <ConfigValueType\_2>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => Promise<ConfigValueType\_2 \| undefined>; getConfigSync: <ConfigValueType\_3>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => ConfigValueType\_3 \| undefined; unbind: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; subscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => loopbackContext.[Subscription](./context.subscription.md)<!-- -->; unsubscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) => boolean; close: () => void; isSubscribed: (observer: loopbackContext.[ContextObserver](./context.contextobserver.md)<!-- -->) => boolean; createView: <T\_8 = unknown>(filter: loopbackContext.[BindingFilter](./context.bindingfilter.md)<!-- -->, comparator?: loopbackContext.[BindingComparator](./context.bindingcomparator.md) \| undefined, options?: Omit<loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, "session"> \| undefined) => loopbackContext.[ContextView](./context.contextview.md)<!-- --><T\_8>; contains: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; isBound: (key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown>) => boolean; getOwnerContext: (keyOrBinding: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><unknown> \| Readonly<loopbackContext.[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; getScopedContext: (scope: loopbackContext.[BindingScope.APPLICATION](./context.bindingscope.md) \| loopbackContext.[BindingScope.SERVER](./context.bindingscope.md) \| loopbackContext.[BindingScope.REQUEST](./context.bindingscope.md)<!-- -->) => loopbackContext.[Context](./context.context.md) \| undefined; getResolutionContext: (binding: Readonly<loopbackContext.[Binding](./context.binding.md)<!-- --><unknown>>) => loopbackContext.[Context](./context.context.md) \| undefined; isVisibleTo: (ctx: loopbackContext.[Context](./context.context.md)<!-- -->) => boolean; find: <ValueType\_1 = any>(pattern?: string \| RegExp \| loopbackContext.[BindingFilter](./context.bindingfilter.md) \| undefined) => Readonly<loopbackContext.[Binding](./context.binding.md)<!-- --><ValueType\_1>>\[\]; findByTag: <ValueType\_2 = any>(tagFilter: RegExp \| loopbackContext.[BindingTag](./context.bindingtag.md)<!-- -->) => Readonly<loopbackContext.[Binding](./context.binding.md)<!-- --><ValueType\_2>>\[\]; get: { <ValueType\_3>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_3>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): Promise<ValueType\_3>; <ValueType\_4>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_4>, options: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->): Promise<ValueType\_4 \| undefined>; }; getSync: { <ValueType\_5>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_5>, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): ValueType\_5; <ValueType\_6>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_6>, options?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined): ValueType\_6 \| undefined; }; getBinding: { <ValueType\_7 = any>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_7>): loopbackContext.[Binding](./context.binding.md)<!-- --><ValueType\_7>; <ValueType\_8>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_8>, options?: { optional?: boolean \| undefined; } \| undefined): loopbackContext.[Binding](./context.binding.md)<!-- --><ValueType\_8> \| undefined; }; findOrCreateBinding: <T\_9>(key: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><T\_9>, policy?: loopbackContext.[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) => loopbackContext.[Binding](./context.binding.md)<!-- --><T\_9>; getValueOrPromise: <ValueType\_9>(keyWithPath: loopbackContext.[BindingAddress](./context.bindingaddress.md)<!-- --><ValueType\_9>, optionsOrSession?: loopbackContext.[ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) \| undefined) => loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- --><ValueType\_9 \| undefined>; toJSON: () => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; inspect: (options?: loopbackContext.[ContextInspectOptions](./context.contextinspectoptions.md) \| undefined) => loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; on: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): loopbackContext.[Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): loopbackContext.[Application](./core.application.md)<!-- -->; }; once: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): loopbackContext.[Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) => void): loopbackContext.[Application](./core.application.md)<!-- -->; }; addListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => loopbackContext.[Application](./core.application.md)<!-- -->; removeListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => loopbackContext.[Application](./core.application.md)<!-- -->; off: (event: string \| symbol, listener: (...args: any\[\]) => void) => loopbackContext.[Application](./core.application.md)<!-- -->; removeAllListeners: (event?: string \| symbol \| undefined) => loopbackContext.[Application](./core.application.md)<!-- -->; setMaxListeners: (n: number) => loopbackContext.[Application](./core.application.md)<!-- -->; getMaxListeners: () => number; listeners: (event: string \| symbol) => Function\[\]; rawListeners: (event: string \| symbol) => Function\[\]; emit: (event: string \| symbol, ...args: any\[\]) => boolean; listenerCount: (type: string \| symbol) => number; prependListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => loopbackContext.[Application](./core.application.md)<!-- -->; prependOnceListener: (event: string \| symbol, listener: (...args: any\[\]) => void) => loopbackContext.[Application](./core.application.md)<!-- -->; eventNames: () => (string \| symbol)\[\]; }; } & T
|
|
119
119
|
|
|
120
120
|
|
|
@@ -13,6 +13,51 @@ permalink: /doc/en/lb4/changelog.rest-msgpack.html
|
|
|
13
13
|
All notable changes to this project will be documented in this file.
|
|
14
14
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
15
15
|
|
|
16
|
+
## [0.6.1](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-msgpack@0.6.0...@loopback/rest-msgpack@0.6.1) (2022-01-11)
|
|
17
|
+
|
|
18
|
+
**Note:** Version bump only for package @loopback/rest-msgpack
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
# [0.6.0](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-msgpack@0.5.4...@loopback/rest-msgpack@0.6.0) (2021-11-18)
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### Features
|
|
28
|
+
|
|
29
|
+
* drop support for Node.js v10 ([9bcbbb3](https://github.com/loopbackio/loopback-next/commit/9bcbbb358ec3eabc3033d4e7e1c22b524a7069b3))
|
|
30
|
+
* support Node.js v17 ([8d86c03](https://github.com/loopbackio/loopback-next/commit/8d86c03cb7047e2b1f18d05870628ef5783e71b2))
|
|
31
|
+
* upgrade to TypeScript 4.5.2 ([72ece91](https://github.com/loopbackio/loopback-next/commit/72ece91289ecfdfd8747bb9888ad75db73e8ff4b))
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
### BREAKING CHANGES
|
|
35
|
+
|
|
36
|
+
* drop support for Node.js v10
|
|
37
|
+
|
|
38
|
+
Co-authored-by: Francisco Buceta <frbuceta@gmail.com>
|
|
39
|
+
Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
## [0.5.4](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-msgpack@0.5.3...@loopback/rest-msgpack@0.5.4) (2021-10-18)
|
|
46
|
+
|
|
47
|
+
**Note:** Version bump only for package @loopback/rest-msgpack
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
## [0.5.3](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-msgpack@0.5.2...@loopback/rest-msgpack@0.5.3) (2021-09-16)
|
|
54
|
+
|
|
55
|
+
**Note:** Version bump only for package @loopback/rest-msgpack
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
16
61
|
## [0.5.2](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-msgpack@0.5.1...@loopback/rest-msgpack@0.5.2) (2021-07-15)
|
|
17
62
|
|
|
18
63
|
**Note:** Version bump only for package @loopback/rest-msgpack
|
|
@@ -13,6 +13,51 @@ permalink: /doc/en/lb4/changelog.example-access-control-migration.html
|
|
|
13
13
|
All notable changes to this project will be documented in this file.
|
|
14
14
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
15
15
|
|
|
16
|
+
## [4.0.1](https://github.com/loopbackio/loopback-next/compare/@loopback/example-access-control-migration@4.0.0...@loopback/example-access-control-migration@4.0.1) (2022-01-11)
|
|
17
|
+
|
|
18
|
+
**Note:** Version bump only for package @loopback/example-access-control-migration
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
# [4.0.0](https://github.com/loopbackio/loopback-next/compare/@loopback/example-access-control-migration@3.0.2...@loopback/example-access-control-migration@4.0.0) (2021-11-18)
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### Features
|
|
28
|
+
|
|
29
|
+
* drop support for Node.js v10 ([9bcbbb3](https://github.com/loopbackio/loopback-next/commit/9bcbbb358ec3eabc3033d4e7e1c22b524a7069b3))
|
|
30
|
+
* support Node.js v17 ([8d86c03](https://github.com/loopbackio/loopback-next/commit/8d86c03cb7047e2b1f18d05870628ef5783e71b2))
|
|
31
|
+
* upgrade to TypeScript 4.5.2 ([72ece91](https://github.com/loopbackio/loopback-next/commit/72ece91289ecfdfd8747bb9888ad75db73e8ff4b))
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
### BREAKING CHANGES
|
|
35
|
+
|
|
36
|
+
* drop support for Node.js v10
|
|
37
|
+
|
|
38
|
+
Co-authored-by: Francisco Buceta <frbuceta@gmail.com>
|
|
39
|
+
Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
## [3.0.2](https://github.com/loopbackio/loopback-next/compare/@loopback/example-access-control-migration@3.0.1...@loopback/example-access-control-migration@3.0.2) (2021-10-18)
|
|
46
|
+
|
|
47
|
+
**Note:** Version bump only for package @loopback/example-access-control-migration
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
## [3.0.1](https://github.com/loopbackio/loopback-next/compare/@loopback/example-access-control-migration@3.0.0...@loopback/example-access-control-migration@3.0.1) (2021-09-16)
|
|
54
|
+
|
|
55
|
+
**Note:** Version bump only for package @loopback/example-access-control-migration
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
16
61
|
# [3.0.0](https://github.com/loopbackio/loopback-next/compare/@loopback/example-access-control-migration@2.5.1...@loopback/example-access-control-migration@3.0.0) (2021-07-15)
|
|
17
62
|
|
|
18
63
|
|