@loopback/docs 6.0.4 → 6.0.6

package/site/apidocs/express.middlewareview._constructor_.md

@@ -1,31 +0,0 @@
----
-lang: en
-title: 'API docs: express.middlewareview._constructor_'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/express
-permalink: /doc/en/lb4/apidocs.express.middlewareview._constructor_.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/express](./express.md) &gt; [MiddlewareView](./express.middlewareview.md) &gt; [(constructor)](./express.middlewareview._constructor_.md)
-
-## MiddlewareView.(constructor)
-
-Constructs a new instance of the `MiddlewareView` class
-
-**Signature:**
-
-```typescript
-constructor(ctx: Context, options?: InvokeMiddlewareOptions);
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  ctx | [Context](./context.context.md) |  |
-|  options | [InvokeMiddlewareOptions](./express.invokemiddlewareoptions.md) | _(Optional)_ |
-
-

package/site/apidocs/express.middlewareview.md

@@ -1,43 +0,0 @@
----
-lang: en
-title: 'API docs: express.middlewareview'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/express
-permalink: /doc/en/lb4/apidocs.express.middlewareview.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/express](./express.md) &gt; [MiddlewareView](./express.middlewareview.md)
-
-## MiddlewareView class
-
-Watch middleware binding keys for the given context and sort them by group
-
-**Signature:**
-
-```typescript
-export declare class MiddlewareView extends ContextView 
-```
-**Extends:** [ContextView](./context.contextview.md)
-
-## Constructors
-
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(ctx, options)](./express.middlewareview._constructor_.md) |  | Constructs a new instance of the <code>MiddlewareView</code> class |
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [middlewareBindingKeys](./express.middlewareview.middlewarebindingkeys.md) | <code>readonly</code> | string\[\] | A list of binding keys sorted by group for registered middleware |
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [refresh()](./express.middlewareview.refresh.md) |  |  |
-
-

package/site/apidocs/express.middlewareview.middlewarebindingkeys.md

@@ -1,23 +0,0 @@
----
-lang: en
-title: 'API docs: express.middlewareview.middlewarebindingkeys'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/express
-permalink: /doc/en/lb4/apidocs.express.middlewareview.middlewarebindingkeys.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/express](./express.md) &gt; [MiddlewareView](./express.middlewareview.md) &gt; [middlewareBindingKeys](./express.middlewareview.middlewarebindingkeys.md)
-
-## MiddlewareView.middlewareBindingKeys property
-
-A list of binding keys sorted by group for registered middleware
-
-**Signature:**
-
-```typescript
-get middlewareBindingKeys(): string[];
-```
-

package/site/apidocs/express.middlewareview.refresh.md

@@ -1,25 +0,0 @@
----
-lang: en
-title: 'API docs: express.middlewareview.refresh'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/express
-permalink: /doc/en/lb4/apidocs.express.middlewareview.refresh.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/express](./express.md) &gt; [MiddlewareView](./express.middlewareview.md) &gt; [refresh](./express.middlewareview.refresh.md)
-
-## MiddlewareView.refresh() method
-
-**Signature:**
-
-```typescript
-refresh(): void;
-```
-**Returns:**
-
-void
-
-

package/site/apidocs/express.registerexpressmiddleware.md

@@ -1,37 +0,0 @@
----
-lang: en
-title: 'API docs: express.registerexpressmiddleware'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/express
-permalink: /doc/en/lb4/apidocs.express.registerexpressmiddleware.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/express](./express.md) &gt; [registerExpressMiddleware](./express.registerexpressmiddleware.md)
-
-## registerExpressMiddleware() function
-
-Bind a Express middleware to the given context
-
-**Signature:**
-
-```typescript
-export declare function registerExpressMiddleware<CFG>(ctx: Context, middlewareFactory: ExpressMiddlewareFactory<CFG>, middlewareConfig?: CFG, options?: MiddlewareBindingOptions): Binding<Middleware>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  ctx | [Context](./context.context.md) | Context object |
-|  middlewareFactory | [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- -->&lt;CFG&gt; | Middleware module name or factory function |
-|  middlewareConfig | CFG | _(Optional)_ Middleware config |
-|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | _(Optional)_ Options for registration |
-
-**Returns:**
-
-[Binding](./context.binding.md)<!-- -->&lt;[Middleware](./express.middleware.md)<!-- -->&gt;
-
-

package/site/apidocs/express.registerexpressmiddlewareinterceptor.md

@@ -1,37 +0,0 @@
----
-lang: en
-title: 'API docs: express.registerexpressmiddlewareinterceptor'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/express
-permalink: /doc/en/lb4/apidocs.express.registerexpressmiddlewareinterceptor.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/express](./express.md) &gt; [registerExpressMiddlewareInterceptor](./express.registerexpressmiddlewareinterceptor.md)
-
-## registerExpressMiddlewareInterceptor() function
-
-Bind a middleware interceptor to the given context
-
-**Signature:**
-
-```typescript
-export declare function registerExpressMiddlewareInterceptor<CFG>(ctx: Context, middlewareFactory: ExpressMiddlewareFactory<CFG>, middlewareConfig?: CFG, options?: MiddlewareInterceptorBindingOptions): Binding<GenericInterceptor<InvocationContext>>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  ctx | [Context](./context.context.md) | Context object |
-|  middlewareFactory | [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- -->&lt;CFG&gt; | Express middleware factory function |
-|  middlewareConfig | CFG | _(Optional)_ Express middleware config |
-|  options | [MiddlewareInterceptorBindingOptions](./express.middlewareinterceptorbindingoptions.md) | _(Optional)_ Options for registration |
-
-**Returns:**
-
-[Binding](./context.binding.md)<!-- -->&lt;[GenericInterceptor](./context.genericinterceptor.md)<!-- -->&lt;[InvocationContext](./context.invocationcontext.md)<!-- -->&gt;&gt;
-
-

package/site/apidocs/express.registermiddleware.md

@@ -1,36 +0,0 @@
----
-lang: en
-title: 'API docs: express.registermiddleware'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/express
-permalink: /doc/en/lb4/apidocs.express.registermiddleware.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/express](./express.md) &gt; [registerMiddleware](./express.registermiddleware.md)
-
-## registerMiddleware() function
-
-Bind the middleware function or provider class to the context
-
-**Signature:**
-
-```typescript
-export declare function registerMiddleware(ctx: Context, middleware: Middleware | Constructor<Provider<Middleware>>, options: MiddlewareBindingOptions): Binding<Middleware>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  ctx | [Context](./context.context.md) | Context object |
-|  middleware | [Middleware](./express.middleware.md) \| [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)<!-- -->&gt;&gt; | Middleware function or provider class |
-|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | Middleware binding options |
-
-**Returns:**
-
-[Binding](./context.binding.md)<!-- -->&lt;[Middleware](./express.middleware.md)<!-- -->&gt;
-
-

package/site/apidocs/express.sortlistofgroups.md

@@ -1,34 +0,0 @@
----
-lang: en
-title: 'API docs: express.sortlistofgroups'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/express
-permalink: /doc/en/lb4/apidocs.express.sortlistofgroups.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/express](./express.md) &gt; [sortListOfGroups](./express.sortlistofgroups.md)
-
-## sortListOfGroups() function
-
-Sort the groups by their relative order
-
-**Signature:**
-
-```typescript
-export declare function sortListOfGroups(...orderedGroups: string[][]): string[];
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  orderedGroups | string\[\]\[\] | A list of arrays - each of which represents a partial order of groups. |
-
-**Returns:**
-
-string\[\]
-
-

package/site/apidocs/express.toexpressmiddleware.md

@@ -1,34 +0,0 @@
----
-lang: en
-title: 'API docs: express.toexpressmiddleware'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/express
-permalink: /doc/en/lb4/apidocs.express.toexpressmiddleware.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/express](./express.md) &gt; [toExpressMiddleware](./express.toexpressmiddleware.md)
-
-## toExpressMiddleware() function
-
-An adapter function to create an Express middleware handler to discover and invoke registered LoopBack-style middleware in the context.
-
-**Signature:**
-
-```typescript
-export declare function toExpressMiddleware(ctx: Context): ExpressRequestHandler;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  ctx | [Context](./context.context.md) | Context object to discover registered middleware |
-
-**Returns:**
-
-[ExpressRequestHandler](./express.expressrequesthandler.md)
-
-

package/site/apidocs/express.tointerceptor.md

@@ -1,43 +0,0 @@
----
-lang: en
-title: 'API docs: express.tointerceptor'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/express
-permalink: /doc/en/lb4/apidocs.express.tointerceptor.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/express](./express.md) &gt; [toInterceptor](./express.tointerceptor.md)
-
-## toInterceptor() function
-
-Wrap an express middleware handler function as an interceptor
-
-**Signature:**
-
-```typescript
-export declare function toInterceptor<CTX extends Context = InvocationContext>(firstHandler: ExpressRequestHandler, ...additionalHandlers: ExpressRequestHandler[]): GenericInterceptor<CTX>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  firstHandler | [ExpressRequestHandler](./express.expressrequesthandler.md) | An Express middleware handler |
-|  additionalHandlers | [ExpressRequestHandler](./express.expressrequesthandler.md)<!-- -->\[\] | A list of Express middleware handler function |
-
-**Returns:**
-
-[GenericInterceptor](./context.genericinterceptor.md)<!-- -->&lt;CTX&gt;
-
-## Example
-
-
-```ts
-toInterceptor(fn);
-toInterceptor(fn1, fn2, fn3);
-```
-
-

package/site/apidocs/express.tomiddleware.md

@@ -1,45 +0,0 @@
----
-lang: en
-title: 'API docs: express.tomiddleware'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/express
-permalink: /doc/en/lb4/apidocs.express.tomiddleware.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/express](./express.md) &gt; [toMiddleware](./express.tomiddleware.md)
-
-## toMiddleware() function
-
-An adapter function to create a LoopBack middleware that invokes the list of Express middleware handler functions in the order of their positions
-
-**Signature:**
-
-```typescript
-export declare function toMiddleware(firstHandler: ExpressRequestHandler, ...additionalHandlers: ExpressRequestHandler[]): Middleware;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  firstHandler | [ExpressRequestHandler](./express.expressrequesthandler.md) | An Express middleware handler |
-|  additionalHandlers | [ExpressRequestHandler](./express.expressrequesthandler.md)<!-- -->\[\] | A list of Express middleware handler functions |
-
-**Returns:**
-
-[Middleware](./express.middleware.md)
-
-A LoopBack middleware function that wraps the list of Express middleware
-
-## Example
-
-
-```ts
-toMiddleware(fn);
-toMiddleware(fn1, fn2, fn3);
-```
-
-

package/site/apidocs/repository.any.md

@@ -1,21 +0,0 @@
----
-lang: en
-title: 'API docs: repository.any'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.any.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [ANY](./repository.any.md)
-
-## ANY variable
-
-**Signature:**
-
-```typescript
-ANY: AnyType
-```
-

package/site/apidocs/repository.anyobject.md

@@ -1,23 +0,0 @@
----
-lang: en
-title: 'API docs: repository.anyobject'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.anyobject.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [AnyObject](./repository.anyobject.md)
-
-## AnyObject interface
-
-Objects with open properties
-
-**Signature:**
-
-```typescript
-export interface AnyObject 
-```
-

package/site/apidocs/repository.anytype.coerce.md

@@ -1,32 +0,0 @@
----
-lang: en
-title: 'API docs: repository.anytype.coerce'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.anytype.coerce.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [AnyType](./repository.anytype.md) &gt; [coerce](./repository.anytype.coerce.md)
-
-## AnyType.coerce() method
-
-**Signature:**
-
-```typescript
-coerce(value: any): any;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  value | any |  |
-
-**Returns:**
-
-any
-
-

package/site/apidocs/repository.anytype.defaultvalue.md

@@ -1,25 +0,0 @@
----
-lang: en
-title: 'API docs: repository.anytype.defaultvalue'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.anytype.defaultvalue.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [AnyType](./repository.anytype.md) &gt; [defaultValue](./repository.anytype.defaultvalue.md)
-
-## AnyType.defaultValue() method
-
-**Signature:**
-
-```typescript
-defaultValue(): any;
-```
-**Returns:**
-
-any
-
-

package/site/apidocs/repository.anytype.iscoercible.md

@@ -1,32 +0,0 @@
----
-lang: en
-title: 'API docs: repository.anytype.iscoercible'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.anytype.iscoercible.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [AnyType](./repository.anytype.md) &gt; [isCoercible](./repository.anytype.iscoercible.md)
-
-## AnyType.isCoercible() method
-
-**Signature:**
-
-```typescript
-isCoercible(value: any): boolean;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  value | any |  |
-
-**Returns:**
-
-boolean
-
-

package/site/apidocs/repository.anytype.isinstance.md

@@ -1,32 +0,0 @@
----
-lang: en
-title: 'API docs: repository.anytype.isinstance'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.anytype.isinstance.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [AnyType](./repository.anytype.md) &gt; [isInstance](./repository.anytype.isinstance.md)
-
-## AnyType.isInstance() method
-
-**Signature:**
-
-```typescript
-isInstance(value: any): boolean;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  value | any |  |
-
-**Returns:**
-
-boolean
-
-

package/site/apidocs/repository.anytype.md

@@ -1,41 +0,0 @@
----
-lang: en
-title: 'API docs: repository.anytype'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.anytype.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [AnyType](./repository.anytype.md)
-
-## AnyType class
-
-Any type
-
-**Signature:**
-
-```typescript
-export declare class AnyType implements Type<any> 
-```
-**Implements:** [Type](./repository.type.md)<!-- -->&lt;any&gt;
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [name](./repository.anytype.name.md) | <code>readonly</code> | (not declared) |  |
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [coerce(value)](./repository.anytype.coerce.md) |  |  |
-|  [defaultValue()](./repository.anytype.defaultvalue.md) |  |  |
-|  [isCoercible(value)](./repository.anytype.iscoercible.md) |  |  |
-|  [isInstance(value)](./repository.anytype.isinstance.md) |  |  |
-|  [serialize(value)](./repository.anytype.serialize.md) |  |  |
-
-

package/site/apidocs/repository.anytype.name.md

@@ -1,21 +0,0 @@
----
-lang: en
-title: 'API docs: repository.anytype.name'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.anytype.name.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [AnyType](./repository.anytype.md) &gt; [name](./repository.anytype.name.md)
-
-## AnyType.name property
-
-**Signature:**
-
-```typescript
-readonly name = "any";
-```
-

package/site/apidocs/repository.anytype.serialize.md

@@ -1,32 +0,0 @@
----
-lang: en
-title: 'API docs: repository.anytype.serialize'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.anytype.serialize.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [AnyType](./repository.anytype.md) &gt; [serialize](./repository.anytype.serialize.md)
-
-## AnyType.serialize() method
-
-**Signature:**
-
-```typescript
-serialize(value: any): any;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  value | any |  |
-
-**Returns:**
-
-any
-
-