@loopback/docs
Version:
Documentation for LoopBack 4
2,179 lines (1,409 loc) • 187 kB
HTML
<!DOCTYPE html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title></title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="css/bootstrap.min.css">
<link rel="stylesheet" href="css/code-themes/sl-theme.css">
<link rel="stylesheet" href="css/main.css">
</head>
<body>
<div class="navbar navbar-inverse navbar-static-top" role="navigation">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">docs.strongloop.com</a>
</div>
<div id="modules"></div>
</div>
<div class="row">
<div class="col-lg-3 column scroll-spy-target">
<ul class="nav nav-pills nav-stacked">
<div id="versions"></div>
<li class="depth-3">
<a href="#HttpHandler">Class: HttpHandler</a>
</li>
<li class="depth-4">
<a href="#557">constructor</a>
</li>
<li class="depth-4">
<a href="#574">describeApiPaths</a>
</li>
<li class="depth-4">
<a href="#576">findRoute</a>
</li>
<li class="depth-4">
<a href="#572">getApiDefinitions</a>
</li>
<li class="depth-4">
<a href="#569">registerApiDefinitions</a>
</li>
<li class="depth-4">
<a href="#560">registerController</a>
</li>
<li class="depth-4">
<a href="#566">registerRoute</a>
</li>
<li class="depth-3">
<a href="#ParsedRequest">Interface: ParsedRequest</a>
</li>
<li class="depth-3">
<a href="#BindElement">Type alias: BindElement</a>
</li>
<li class="depth-3">
<a href="#FindRoute">Type alias: FindRoute</a>
</li>
<li class="depth-3">
<a href="#GetFromContext">Type alias: GetFromContext</a>
</li>
<li class="depth-3">
<a href="#InvokeMethod">Type alias: InvokeMethod</a>
</li>
<li class="depth-3">
<a href="#LogError">Type alias: LogError</a>
</li>
<li class="depth-3">
<a href="#OperationArgs">Type alias: OperationArgs</a>
</li>
<li class="depth-3">
<a href="#OperationRetval">Type alias: OperationRetval</a>
</li>
<li class="depth-3">
<a href="#ParseParams">Type alias: ParseParams</a>
</li>
<li class="depth-3">
<a href="#PathParameterValues">Type alias: PathParameterValues</a>
</li>
<li class="depth-3">
<a href="#Reject">Type alias: Reject</a>
</li>
<li class="depth-3">
<a href="#Send">Type alias: Send</a>
</li>
<li class="depth-3">
<a href="#HttpError">Type alias: HttpError</a>
</li>
<li class="depth-3">
<a href="#MaybeBody">Type alias: MaybeBody</a>
</li>
<li class="depth-3">
<a href="#713">Function: parseOperationArgs</a>
</li>
<li class="depth-3">
<a href="#BindElementProvider">Class: BindElementProvider</a>
</li>
<li class="depth-4">
<a href="#633">constructor</a>
</li>
<li class="depth-4">
<a href="#638">action</a>
</li>
<li class="depth-4">
<a href="#636">value</a>
</li>
<li class="depth-3">
<a href="#FindRouteProvider">Class: FindRouteProvider</a>
</li>
<li class="depth-4">
<a href="#643">constructor</a>
</li>
<li class="depth-4">
<a href="#649">action</a>
</li>
<li class="depth-4">
<a href="#647">value</a>
</li>
<li class="depth-3">
<a href="#GetFromContextProvider">Class: GetFromContextProvider</a>
</li>
<li class="depth-4">
<a href="#654">constructor</a>
</li>
<li class="depth-4">
<a href="#659">action</a>
</li>
<li class="depth-4">
<a href="#657">value</a>
</li>
<li class="depth-3">
<a href="#InvokeMethodProvider">Class: InvokeMethodProvider</a>
</li>
<li class="depth-4">
<a href="#664">constructor</a>
</li>
<li class="depth-4">
<a href="#669">action</a>
</li>
<li class="depth-4">
<a href="#667">value</a>
</li>
<li class="depth-3">
<a href="#LogErrorProvider">Class: LogErrorProvider</a>
</li>
<li class="depth-4">
<a href="#677">action</a>
</li>
<li class="depth-4">
<a href="#675">value</a>
</li>
<li class="depth-3">
<a href="#ParseParamsProvider">Class: ParseParamsProvider</a>
</li>
<li class="depth-4">
<a href="#729">value</a>
</li>
<li class="depth-3">
<a href="#RejectProvider">Class: RejectProvider</a>
</li>
<li class="depth-4">
<a href="#693">constructor</a>
</li>
<li class="depth-4">
<a href="#698">action</a>
</li>
<li class="depth-4">
<a href="#696">value</a>
</li>
<li class="depth-3">
<a href="#SendProvider">Class: SendProvider</a>
</li>
<li class="depth-4">
<a href="#733">value</a>
</li>
<li class="depth-3">
<a href="#RestApplication">Class: RestApplication</a>
</li>
<li class="depth-4">
<a href="#891">constructor</a>
</li>
<li class="depth-4">
<a href="#915">api</a>
</li>
<li class="depth-4">
<a href="#901">handler</a>
</li>
<li class="depth-4">
<a href="#904">route</a>
</li>
<li class="depth-4">
<a href="#898">sequence</a>
</li>
<li class="depth-4">
<a href="#894">server</a>
</li>
<li class="depth-3">
<a href="#RestComponent">Class: RestComponent</a>
</li>
<li class="depth-4">
<a href="#875">constructor</a>
</li>
<li class="depth-3">
<a href="#RestComponentConfig">Interface: RestComponentConfig</a>
</li>
<li class="depth-3">
<a href="#RestServer">Class: RestServer</a>
</li>
<li class="depth-4">
<a href="#744">constructor</a>
</li>
<li class="depth-4">
<a href="#762">api</a>
</li>
<li class="depth-4">
<a href="#748">controller</a>
</li>
<li class="depth-4">
<a href="#765">getApiSpec</a>
</li>
<li class="depth-4">
<a href="#770">handler</a>
</li>
<li class="depth-4">
<a href="#751">route</a>
</li>
<li class="depth-4">
<a href="#767">sequence</a>
</li>
<li class="depth-4">
<a href="#773">start</a>
</li>
<li class="depth-4">
<a href="#775">stop</a>
</li>
<li class="depth-3">
<a href="#HttpServerLike">Interface: HttpServerLike</a>
</li>
<li class="depth-3">
<a href="#OpenApiSpecOptions">Interface: OpenApiSpecOptions</a>
</li>
<li class="depth-3">
<a href="#RestServerConfig">Interface: RestServerConfig</a>
</li>
<li class="depth-3">
<a href="#HttpRequestListener">Type alias: HttpRequestListener</a>
</li>
<li class="depth-3">
<a href="#OPENAPI_SPEC_MAPPING">Object literal: OPENAPI_SPEC_MAPPING</a>
</li>
<li class="depth-3">
<a href="#BaseRoute">Class: BaseRoute</a>
</li>
<li class="depth-4">
<a href="#420">constructor</a>
</li>
<li class="depth-4">
<a href="#437">describe</a>
</li>
<li class="depth-4">
<a href="#433">invokeHandler</a>
</li>
<li class="depth-4">
<a href="#427">match</a>
</li>
<li class="depth-4">
<a href="#430">updateBindings</a>
</li>
<li class="depth-3">
<a href="#ControllerRoute">Class: ControllerRoute</a>
</li>
<li class="depth-4">
<a href="#463">constructor</a>
</li>
<li class="depth-4">
<a href="#471">describe</a>
</li>
<li class="depth-4">
<a href="#476">invokeHandler</a>
</li>
<li class="depth-4">
<a href="#473">updateBindings</a>
</li>
<li class="depth-3">
<a href="#Route">Class: Route</a>
</li>
<li class="depth-4">
<a href="#440">constructor</a>
</li>
<li class="depth-4">
<a href="#447">describe</a>
</li>
<li class="depth-4">
<a href="#452">invokeHandler</a>
</li>
<li class="depth-4">
<a href="#449">updateBindings</a>
</li>
<li class="depth-3">
<a href="#RoutingTable">Class: RoutingTable</a>
</li>
<li class="depth-4">
<a href="#380">describeApiPaths</a>
</li>
<li class="depth-4">
<a href="#382">find</a>
</li>
<li class="depth-4">
<a href="#367">registerController</a>
</li>
<li class="depth-4">
<a href="#377">registerRoute</a>
</li>
<li class="depth-4">
<a href="#373">joinPath</a>
</li>
<li class="depth-3">
<a href="#ResolvedRoute">Interface: ResolvedRoute</a>
</li>
<li class="depth-3">
<a href="#RouteEntry">Interface: RouteEntry</a>
</li>
<li class="depth-4">
<a href="#399">describe</a>
</li>
<li class="depth-4">
<a href="#395">invokeHandler</a>
</li>
<li class="depth-4">
<a href="#389">match</a>
</li>
<li class="depth-4">
<a href="#392">updateBindings</a>
</li>
<li class="depth-3">
<a href="#ControllerClass">Type alias: ControllerClass</a>
</li>
<li class="depth-3">
<a href="#ControllerFactory">Type alias: ControllerFactory</a>
</li>
<li class="depth-3">
<a href="#ControllerInstance">Type alias: ControllerInstance</a>
</li>
<li class="depth-3">
<a href="#508">Function: createControllerFactoryForBinding</a>
</li>
<li class="depth-3">
<a href="#512">Function: createControllerFactoryForClass</a>
</li>
<li class="depth-3">
<a href="#516">Function: createControllerFactoryForInstance</a>
</li>
<li class="depth-3">
<a href="#501">Function: createResolvedRoute</a>
</li>
<li class="depth-3">
<a href="#487">Function: parseRequestUrl</a>
</li>
<li class="depth-3">
<a href="#DefaultSequence">Class: DefaultSequence</a>
</li>
<li class="depth-4">
<a href="#527">constructor</a>
</li>
<li class="depth-4">
<a href="#538">handle</a>
</li>
<li class="depth-3">
<a href="#SequenceHandler">Interface: SequenceHandler</a>
</li>
<li class="depth-4">
<a href="#522">handle</a>
</li>
<li class="depth-3">
<a href="#SequenceFunction">Type alias: SequenceFunction</a>
</li>
<li class="depth-3">
<a href="#687">Function: writeErrorToResponse</a>
</li>
<li class="depth-3">
<a href="#683">Function: writeResultToResponse</a>
</li>
</ul>
</div>
<div class="col-lg-9 col-lg-offset-3 column" data-spy="scroll" data-target=".scroll-spy-target" data-offset="0">
<div class="readability">
<section class="code-doc ">
<a name="HttpHandler"></a>
<h3 class="code-ref">Class: httphandler = new HttpHandler()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc">
<div class="code-arguments-hdr">Properties</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">handleRequest</strong>
</td>
<td class="code-arg-types">
<code>Function</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="557"></a>
<h4 class="code-ref">constructor(_rootContext: <a href="#Context">Context</a>) : HttpHandler</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">_rootContext</strong>
</td>
<td class="code-arg-types">
<code><a href="#Context">Context</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="574"></a>
<h4 class="code-ref">describeApiPaths() : PathsObject</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="576"></a>
<h4 class="code-ref">findRoute(request: <a href="#ParsedRequest">ParsedRequest</a>) : ResolvedRoute</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">request</strong>
</td>
<td class="code-arg-types">
<code><a href="#ParsedRequest">ParsedRequest</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="572"></a>
<h4 class="code-ref">getApiDefinitions() : SchemasObject</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="569"></a>
<h4 class="code-ref">registerApiDefinitions(defs: <a href="#SchemasObject">SchemasObject</a>) : void</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">defs</strong>
</td>
<td class="code-arg-types">
<code><a href="#SchemasObject">SchemasObject</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="560"></a>
<h4 class="code-ref">registerController(spec: <a href="#ControllerSpec">ControllerSpec</a>, controllerCtor: <a href="#ControllerClass">ControllerClass</a>, controllerFactory: <a href="#ControllerFactory">ControllerFactory</a>) : void</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">spec</strong>
</td>
<td class="code-arg-types">
<code><a href="#ControllerSpec">ControllerSpec</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">controllerCtor</strong>
</td>
<td class="code-arg-types">
<code><a href="#ControllerClass">ControllerClass</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">controllerFactory</strong>
</td>
<td class="code-arg-types">
<code><a href="#ControllerFactory">ControllerFactory</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="566"></a>
<h4 class="code-ref">registerRoute(route: <a href="#RouteEntry">RouteEntry</a>) : void</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">route</strong>
</td>
<td class="code-arg-types">
<code><a href="#RouteEntry">RouteEntry</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="ParsedRequest"></a>
<h3 class="code-ref">Interface: ParsedRequest</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc">
<div class="code-arguments-hdr">Properties</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">method</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">path</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">pathname</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">query</strong>
</td>
<td class="code-arg-types">
<code>Function</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">url</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="BindElement"></a>
<h3 class="code-ref">Type alias: BindElement(key: string): <a href="#Binding">Binding</a></h3>
<div class="code-desc">
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">key</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="FindRoute"></a>
<h3 class="code-ref">Type alias: FindRoute(request: <a href="#ParsedRequest">ParsedRequest</a>): <a href="#ResolvedRoute">ResolvedRoute</a></h3>
<div class="code-desc">
<p><p>Find a route matching the incoming request.
Throw an error when no route was found.</p>
</p>
<p></p>
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">request</strong>
</td>
<td class="code-arg-types">
<code><a href="#ParsedRequest">ParsedRequest</a></code>
</td>
<td class="code-arg-desc">
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="GetFromContext"></a>
<h3 class="code-ref">Type alias: GetFromContext(key: string): Promise<<a href="#BoundValue">BoundValue</a>></h3>
<div class="code-desc">
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">key</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="InvokeMethod"></a>
<h3 class="code-ref">Type alias: InvokeMethod(route: <a href="#RouteEntry">RouteEntry</a>, args: <a href="#OperationArgs">OperationArgs</a>): Promise<<a href="#OperationRetval">OperationRetval</a>></h3>
<div class="code-desc">
<p><p>Invokes a method defined in the Application Controller</p>
</p>
<p></p>
Returns: <p>OperationRetval Result from method invocation
</p>
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">route</strong>
</td>
<td class="code-arg-types">
<code><a href="#RouteEntry">RouteEntry</a></code>
</td>
<td class="code-arg-desc">
<div class="code-desc">
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">args</strong>
</td>
<td class="code-arg-types">
<code><a href="#OperationArgs">OperationArgs</a></code>
</td>
<td class="code-arg-desc">
<div class="code-desc">
<p>Operation arguments for the method</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="LogError"></a>
<h3 class="code-ref">Type alias: LogError(err: <a href="#Error">Error</a>, statusCode: number, request: <a href="#ServerRequest">ServerRequest</a>): void</h3>
<div class="code-desc">
<p><p>Log information about a failed request.</p>
</p>
<p></p>
Returns: <p></p>
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">err</strong>
</td>
<td class="code-arg-types">
<code><a href="#Error">Error</a></code>
</td>
<td class="code-arg-desc">
<div class="code-desc">
<p>The error reported by request handling code.</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">statusCode</strong>
</td>
<td class="code-arg-types">
<code>number</code>
</td>
<td class="code-arg-desc">
<div class="code-desc">
<p>Status code of the HTTP response</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">request</strong>
</td>
<td class="code-arg-types">
<code><a href="#ServerRequest">ServerRequest</a></code>
</td>
<td class="code-arg-desc">
<div class="code-desc">
<p>The request that failed.
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="OperationArgs"></a>
<h3 class="code-ref">Type alias: OperationArgs = any[]</h3>
</section>
<section class="code-doc ">
<a name="OperationRetval"></a>
<h3 class="code-ref">Type alias: OperationRetval = any</h3>
</section>
<section class="code-doc ">
<a name="ParseParams"></a>
<h3 class="code-ref">Type alias: ParseParams(request: <a href="#ParsedRequest">ParsedRequest</a>, route: <a href="#ResolvedRoute">ResolvedRoute</a>): Promise<<a href="#OperationArgs">OperationArgs</a>></h3>
<div class="code-desc">
<p></p>
<p></p>
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">request</strong>
</td>
<td class="code-arg-types">
<code><a href="#ParsedRequest">ParsedRequest</a></code>
</td>
<td class="code-arg-desc">
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">route</strong>
</td>
<td class="code-arg-types">
<code><a href="#ResolvedRoute">ResolvedRoute</a></code>
</td>
<td class="code-arg-desc">
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="PathParameterValues"></a>
<h3 class="code-ref">Type alias: PathParameterValues(key: string): any</h3>
<div class="code-desc">
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">key</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="Reject"></a>
<h3 class="code-ref">Type alias: Reject(response: <a href="#ServerResponse">ServerResponse</a>, request: <a href="#ServerRequest">ServerRequest</a>, err: <a href="#Error">Error</a>): void</h3>
<div class="code-desc">
<p><p>Reject the request with an error.</p>
</p>
<p></p>
Returns: <p></p>
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">response</strong>
</td>
<td class="code-arg-types">
<code><a href="#ServerResponse">ServerResponse</a></code>
</td>
<td class="code-arg-desc">
<div class="code-desc">
<p>The response the response to send to.</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">request</strong>
</td>
<td class="code-arg-types">
<code><a href="#ServerRequest">ServerRequest</a></code>
</td>
<td class="code-arg-desc">
<div class="code-desc">
<p>The request that triggered the error.</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">err</strong>
</td>
<td class="code-arg-types">
<code><a href="#Error">Error</a></code>
</td>
<td class="code-arg-desc">
<div class="code-desc">
<p>The error.
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="Send"></a>
<h3 class="code-ref">Type alias: Send(response: <a href="#ServerResponse">ServerResponse</a>, result: <a href="#OperationRetval">OperationRetval</a>): void</h3>
<div class="code-desc">
<p><p>Send the operation response back to the client.</p>
</p>
<p></p>
Returns: <p></p>
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">response</strong>
</td>
<td class="code-arg-types">
<code><a href="#ServerResponse">ServerResponse</a></code>
</td>
<td class="code-arg-desc">
<div class="code-desc">
<p>The response the response to send to.</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">result</strong>
</td>
<td class="code-arg-types">
<code><a href="#OperationRetval">OperationRetval</a></code>
</td>
<td class="code-arg-desc">
<div class="code-desc">
<p>The operation result to send.
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="HttpError"></a>
<h3 class="code-ref">Type alias: HttpError = HttpErrors.HttpError</h3>
</section>
<section class="code-doc ">
<a name="713"></a>
<h3 class="code-ref">Function: parseOperationArgs</h3>
<section class="code-doc ">
<a name="713"></a>
<h4 class="code-ref">parseOperationArgs(request: <a href="#ParsedRequest">ParsedRequest</a>, route: <a href="#ResolvedRoute">ResolvedRoute</a>) : Promise</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Parses the request to derive arguments to be passed in for the Application
controller method</p>
</p>
<p></p>
</div>
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">request</strong>
</td>
<td class="code-arg-types">
<code><a href="#ParsedRequest">ParsedRequest</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Incoming HTTP request</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">route</strong>
</td>
<td class="code-arg-types">
<code><a href="#ResolvedRoute">ResolvedRoute</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
</section>
<section class="code-doc ">
<a name="BindElementProvider"></a>
<h3 class="code-ref">Class: bindelementprovider = new BindElementProvider()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="633"></a>
<h4 class="code-ref">constructor(context: <a href="#Context">Context</a>) : BindElementProvider</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">context</strong>
</td>
<td class="code-arg-types">
<code><a href="#Context">Context</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="638"></a>
<h4 class="code-ref">action(key: string) : Binding</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">key</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="636"></a>
<h4 class="code-ref">value() : BindElement</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="FindRouteProvider"></a>
<h3 class="code-ref">Class: findrouteprovider = new FindRouteProvider()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="643"></a>
<h4 class="code-ref">constructor(context: <a href="#Context">Context</a>, handler: <a href="#HttpHandler">HttpHandler</a>) : FindRouteProvider</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">context</strong>
</td>
<td class="code-arg-types">
<code><a href="#Context">Context</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">handler</strong>
</td>
<td class="code-arg-types">
<code><a href="#HttpHandler">HttpHandler</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="649"></a>
<h4 class="code-ref">action(request: <a href="#ParsedRequest">ParsedRequest</a>) : ResolvedRoute</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">request</strong>
</td>
<td class="code-arg-types">
<code><a href="#ParsedRequest">ParsedRequest</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="647"></a>
<h4 class="code-ref">value() : FindRoute</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="GetFromContextProvider"></a>
<h3 class="code-ref">Class: getfromcontextprovider = new GetFromContextProvider()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="654"></a>
<h4 class="code-ref">constructor(context: <a href="#Context">Context</a>) : GetFromContextProvider</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">context</strong>
</td>
<td class="code-arg-types">
<code><a href="#Context">Context</a></code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="659"></a>
<h4 class="code-ref">action(key: string) : Promise</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-arguments-hdr">Arguments</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<strong class="code-arg-name">key</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="657"></a>
<h4 class="code-ref">value() : GetFromContext</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type