@loopback/docs 6.0.5 → 7.0.0

package/site/apidocs/rest.streambodyparser.supports.md

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

package/site/apidocs/rest.textbodyparser._constructor_.md

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

package/site/apidocs/rest.textbodyparser.md

@@ -0,0 +1,42 @@
+---
+lang: en
+title: 'API docs: rest.textbodyparser'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest
+permalink: /doc/en/lb4/apidocs.rest.textbodyparser.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [TextBodyParser](./rest.textbodyparser.md)
+
+## TextBodyParser class
+
+**Signature:**
+
+```typescript
+export declare class TextBodyParser implements BodyParser 
+```
+**Implements:** [BodyParser](./rest.bodyparser.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./rest.textbodyparser._constructor_.md) |  | Constructs a new instance of the <code>TextBodyParser</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [name](./rest.textbodyparser.name.md) |  | symbol |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [parse(request)](./rest.textbodyparser.parse.md) |  |  |
+|  [supports(mediaType)](./rest.textbodyparser.supports.md) |  |  |
+
+

package/site/apidocs/rest.textbodyparser.name.md

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

package/site/apidocs/rest.textbodyparser.parse.md

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

package/site/apidocs/rest.textbodyparser.supports.md

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

package/site/apidocs/rest.toexpresspath.md

@@ -0,0 +1,34 @@
+---
+lang: en
+title: 'API docs: rest.toexpresspath'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest
+permalink: /doc/en/lb4/apidocs.rest.toexpresspath.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [toExpressPath](./rest.toexpresspath.md)
+
+## toExpressPath() function
+
+Convert an OpenAPI path to Express (path-to-regexp) style
+
+**Signature:**
+
+```typescript
+export declare function toExpressPath(path: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  path | string | OpenAPI path with optional variables as <code>{var}</code> |
+
+**Returns:**
+
+string
+
+

package/site/apidocs/rest.trie.create.md

@@ -0,0 +1,35 @@
+---
+lang: en
+title: 'API docs: rest.trie.create'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest
+permalink: /doc/en/lb4/apidocs.rest.trie.create.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [Trie](./rest.trie.md) &gt; [create](./rest.trie.create.md)
+
+## Trie.create() method
+
+Create a node for a given path template
+
+**Signature:**
+
+```typescript
+create(routeTemplate: string, value: T): Node<T>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  routeTemplate | string |  |
+|  value | T | Value of the route |
+
+**Returns:**
+
+[Node](./rest.node.md)<!-- -->&lt;T&gt;
+
+

package/site/apidocs/rest.trie.list.md

@@ -0,0 +1,27 @@
+---
+lang: en
+title: 'API docs: rest.trie.list'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest
+permalink: /doc/en/lb4/apidocs.rest.trie.list.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [Trie](./rest.trie.md) &gt; [list](./rest.trie.list.md)
+
+## Trie.list() method
+
+List all nodes with value of the trie
+
+**Signature:**
+
+```typescript
+list(): NodeWithValue<T>[];
+```
+**Returns:**
+
+[NodeWithValue](./rest.nodewithvalue.md)<!-- -->&lt;T&gt;\[\]
+
+

package/site/apidocs/rest.trie.match.md

@@ -0,0 +1,36 @@
+---
+lang: en
+title: 'API docs: rest.trie.match'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest
+permalink: /doc/en/lb4/apidocs.rest.trie.match.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [Trie](./rest.trie.md) &gt; [match](./rest.trie.match.md)
+
+## Trie.match() method
+
+Match a route path against the trie
+
+**Signature:**
+
+```typescript
+match(path: string): (ResolvedNode<T> & {
+        node: NodeWithValue<T>;
+    }) | undefined;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  path | string | The route path, such as <code>/customers/c01</code> |
+
+**Returns:**
+
+([ResolvedNode](./rest.resolvednode.md)<!-- -->&lt;T&gt; &amp; { node: [NodeWithValue](./rest.nodewithvalue.md)<!-- -->&lt;T&gt;; }) \| undefined
+
+

package/site/apidocs/rest.trie.md

@@ -0,0 +1,38 @@
+---
+lang: en
+title: 'API docs: rest.trie'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest
+permalink: /doc/en/lb4/apidocs.rest.trie.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [Trie](./rest.trie.md)
+
+## Trie class
+
+An implementation of trie for routes. The key hierarchy is built with parts of the route path delimited by `/`
+
+**Signature:**
+
+```typescript
+export declare class Trie<T> 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [root](./rest.trie.root.md) | <code>readonly</code> | [Node](./rest.node.md)<!-- -->&lt;T&gt; |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [create(routeTemplate, value)](./rest.trie.create.md) |  | Create a node for a given path template |
+|  [list()](./rest.trie.list.md) |  | List all nodes with value of the trie |
+|  [match(path)](./rest.trie.match.md) |  | Match a route path against the trie |
+
+

package/site/apidocs/rest.trie.root.md

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

package/site/apidocs/rest.trierouter._constructor_.md

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

package/site/apidocs/rest.trierouter.addroutewithpathvars.md

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

package/site/apidocs/rest.trierouter.findroutewithpathvars.md

@@ -0,0 +1,33 @@
+---
+lang: en
+title: 'API docs: rest.trierouter.findroutewithpathvars'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest
+permalink: /doc/en/lb4/apidocs.rest.trierouter.findroutewithpathvars.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [TrieRouter](./rest.trierouter.md) &gt; [findRouteWithPathVars](./rest.trierouter.findroutewithpathvars.md)
+
+## TrieRouter.findRouteWithPathVars() method
+
+**Signature:**
+
+```typescript
+protected findRouteWithPathVars(verb: string, path: string): ResolvedRoute | undefined;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  verb | string |  |
+|  path | string |  |
+
+**Returns:**
+
+[ResolvedRoute](./rest.resolvedroute.md) \| undefined
+
+

package/site/apidocs/rest.trierouter.listrouteswithpathvars.md

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

package/site/apidocs/rest.trierouter.md

@@ -0,0 +1,39 @@
+---
+lang: en
+title: 'API docs: rest.trierouter'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest
+permalink: /doc/en/lb4/apidocs.rest.trierouter.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [TrieRouter](./rest.trierouter.md)
+
+## TrieRouter class
+
+Router implementation based on trie
+
+**Signature:**
+
+```typescript
+export declare class TrieRouter extends BaseRouter 
+```
+**Extends:** BaseRouter
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./rest.trierouter._constructor_.md) |  | Constructs a new instance of the <code>TrieRouter</code> class |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [addRouteWithPathVars(route)](./rest.trierouter.addroutewithpathvars.md) | <code>protected</code> |  |
+|  [findRouteWithPathVars(verb, path)](./rest.trierouter.findroutewithpathvars.md) | <code>protected</code> |  |
+|  [listRoutesWithPathVars()](./rest.trierouter.listrouteswithpathvars.md) | <code>protected</code> |  |
+
+

package/site/apidocs/rest.urlencodedbodyparser._constructor_.md

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

package/site/apidocs/rest.urlencodedbodyparser.md

@@ -0,0 +1,42 @@
+---
+lang: en
+title: 'API docs: rest.urlencodedbodyparser'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest
+permalink: /doc/en/lb4/apidocs.rest.urlencodedbodyparser.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [UrlEncodedBodyParser](./rest.urlencodedbodyparser.md)
+
+## UrlEncodedBodyParser class
+
+**Signature:**
+
+```typescript
+export declare class UrlEncodedBodyParser implements BodyParser 
+```
+**Implements:** [BodyParser](./rest.bodyparser.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./rest.urlencodedbodyparser._constructor_.md) |  | Constructs a new instance of the <code>UrlEncodedBodyParser</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [name](./rest.urlencodedbodyparser.name.md) |  | symbol |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [parse(request)](./rest.urlencodedbodyparser.parse.md) |  |  |
+|  [supports(mediaType)](./rest.urlencodedbodyparser.supports.md) |  |  |
+
+

package/site/apidocs/rest.urlencodedbodyparser.name.md

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