@loopback/docs

<!DOCTYPE html>     <html class="no-js">  <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="#552">handleRequest</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-4"> <a href="#10">method</a> </li> <li class="depth-4"> <a href="#3">path</a> </li> <li class="depth-4"> <a href="#9">pathname</a> </li> <li class="depth-4"> <a href="#4">query</a> </li> <li class="depth-4"> <a href="#8">url</a> </li> <li class="depth-3"> <a href="#BindElement">Type: BindElement</a> </li> <li class="depth-3"> <a href="#FindRoute">Type: FindRoute</a> </li> <li class="depth-3"> <a href="#GetFromContext">Type: GetFromContext</a> </li> <li class="depth-3"> <a href="#InvokeMethod">Type: InvokeMethod</a> </li> <li class="depth-3"> <a href="#LogError">Type: LogError</a> </li> <li class="depth-3"> <a href="#OperationArgs">Type: OperationArgs</a> </li> <li class="depth-3"> <a href="#OperationRetval">Type: OperationRetval</a> </li> <li class="depth-3"> <a href="#ParseParams">Type: ParseParams</a> </li> <li class="depth-3"> <a href="#PathParameterValues">Type: PathParameterValues</a> </li> <li class="depth-3"> <a href="#Reject">Type: Reject</a> </li> <li class="depth-3"> <a href="#Send">Type: Send</a> </li> <li class="depth-3"> <a href="#RestBindings">Namespace: RestBindings</a> </li> <li class="depth-4"> <a href="#Http">Namespace: Http</a> </li> <li class="depth-4"> <a href="#SequenceActions">Namespace: SequenceActions</a> </li> <li class="depth-4"> <a href="#API_SPEC">API_SPEC</a> </li> <li class="depth-4"> <a href="#BIND_ELEMENT">BIND_ELEMENT</a> </li> <li class="depth-4"> <a href="#CONFIG">CONFIG</a> </li> <li class="depth-4"> <a href="#GET_FROM_CONTEXT">GET_FROM_CONTEXT</a> </li> <li class="depth-4"> <a href="#HANDLER">HANDLER</a> </li> <li class="depth-4"> <a href="#HOST">HOST</a> </li> <li class="depth-4"> <a href="#PORT">PORT</a> </li> <li class="depth-4"> <a href="#SEQUENCE">SEQUENCE</a> </li> <li class="depth-3"> <a href="#713">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="#889">>requestHandler</a> </li> <li class="depth-4"> <a href="#887">>restServer</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="#ERR_NO_MULTI_SERVER">ERR_NO_MULTI_SERVER</a> </li> <li class="depth-3"> <a href="#SequenceActions">SequenceActions</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-4"> <a href="#providers">Object: providers</a> </li> <li class="depth-4"> <a href="#servers">Object: servers</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="#743">requestHandler</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-4"> <a href="#738">requestHandler</a> </li> <li class="depth-3"> <a href="#RestServerConfig">Interface: RestServerConfig</a> </li> <li class="depth-4"> <a href="#849">apiExplorerUrl</a> </li> <li class="depth-4"> <a href="#848">cors</a> </li> <li class="depth-4"> <a href="#846">host</a> </li> <li class="depth-4"> <a href="#847">port</a> </li> <li class="depth-4"> <a href="#850">sequence</a> </li> <li class="depth-3"> <a href="#HttpRequestListener">Type: HttpRequestListener</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="#421">path</a> </li> <li class="depth-4"> <a href="#422">spec</a> </li> <li class="depth-4"> <a href="#419">verb</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="#441">spec</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-4"> <a href="#402">pathParams</a> </li> <li class="depth-3"> <a href="#RouteEntry">Interface: RouteEntry</a> </li> <li class="depth-4"> <a href="#387">path</a> </li> <li class="depth-4"> <a href="#388">spec</a> </li> <li class="depth-4"> <a href="#386">verb</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: ControllerClass</a> </li> <li class="depth-3"> <a href="#ControllerFactory">Type: ControllerFactory</a> </li> <li class="depth-3"> <a href="#ControllerInstance">Type: ControllerInstance</a> </li> <li class="depth-3"> <a href="#508">createControllerFactoryForBinding()</a> </li> <li class="depth-3"> <a href="#512">createControllerFactoryForClass()</a> </li> <li class="depth-3"> <a href="#516">createControllerFactoryForInstance()</a> </li> <li class="depth-3"> <a href="#501">createResolvedRoute()</a> </li> <li class="depth-3"> <a href="#487">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="#528">ctx</a> </li> <li class="depth-4"> <a href="#530">reject</a> </li> <li class="depth-4"> <a href="#529">send</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: SequenceFunction</a> </li> <li class="depth-3"> <a href="#687">writeErrorToResponse()</a> </li> <li class="depth-3"> <a href="#683">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>  </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-default-value">Default Value</th> <th class="hdr-flags">Flags</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name="552"></a> <strong class="code-arg-name"> handleRequest </strong> </td> <td class="code-arg-types"> <code>anonymous</code> </td> <td class="code-arg-default-value"> </td> <td class="code-arg-flags"> exported public </td> <td class="code-arg-desc">  </td> </tr> </table> </section> <section class="code-doc "> <a name="557"></a> <h4 class="code-ref">constructor(_rootContext: <a href="#Context">Context</a>) : <a href="#HttpHandler">HttpHandler</a></h4>   <div class="code-arguments-hdr">Parameters</div> <table class="params code-arguments"> <tr> <th class="hdr-name">Name</th> <th class="hdr-type">Type</th> <th class="hdr-default-value">Default Value</th> <th class="hdr-flags">Flags</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name=""></a> <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-default-value"> </td> <td class="code-arg-flags"> </td> <td class="code-arg-desc">  </td> </tr> </table> </section> <section class="code-doc "> <a name="574"></a> <h4 class="code-ref">describeApiPaths() : <a href="#PathObject">PathObject</a></h4>  </section> <section class="code-doc "> <a name="576"></a> <h4 class="code-ref">findRoute(request: <a href="#ParsedRequest">ParsedRequest</a>) : <a href="#ResolvedRoute">ResolvedRoute</a></h4>   <div class="code-arguments-hdr">Parameters</div> <table class="params code-arguments"> <tr> <th class="hdr-name">Name</th> <th class="hdr-type">Type</th> <th class="hdr-default-value">Default Value</th> <th class="hdr-flags">Flags</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name=""></a> <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-default-value"> </td> <td class="code-arg-flags"> </td> <td class="code-arg-desc">  </td> </tr> </table> </section> <section class="code-doc "> <a name="572"></a> <h4 class="code-ref">getApiDefinitions() : <a href="#SchemasObject">SchemasObject</a></h4>  </section> <section class="code-doc "> <a name="569"></a> <h4 class="code-ref">registerApiDefinitions(defs: <a href="#SchemasObject">SchemasObject</a>) : void</h4>   <div class="code-arguments-hdr">Parameters</div> <table class="params code-arguments"> <tr> <th class="hdr-name">Name</th> <th class="hdr-type">Type</th> <th class="hdr-default-value">Default Value</th> <th class="hdr-flags">Flags</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name=""></a> <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-default-value"> </td> <td class="code-arg-flags"> </td> <td class="code-arg-desc">  </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><T>, controllerFactory: <a href="#ControllerFactory">ControllerFactory</a><T>) : void</h4>   <div class="code-arguments-hdr">Parameters</div> <table class="params code-arguments"> <tr> <th class="hdr-name">Name</th> <th class="hdr-type">Type</th> <th class="hdr-default-value">Default Value</th> <th class="hdr-flags">Flags</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name=""></a> <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-default-value"> </td> <td class="code-arg-flags"> </td> <td class="code-arg-desc">  </td> </tr> <tr class="code-arg"> <td> <a name=""></a> <strong class="code-arg-name"> controllerCtor </strong> </td> <td class="code-arg-types"> <code><a href="#ControllerClass">ControllerClass</a><T></code> </td> <td class="code-arg-default-value"> </td> <td class="code-arg-flags"> </td> <td class="code-arg-desc">  </td> </tr> <tr class="code-arg"> <td> <a name=""></a> <strong class="code-arg-name"> controllerFactory </strong> </td> <td class="code-arg-types"> <code><a href="#ControllerFactory">ControllerFactory</a><T></code> </td> <td class="code-arg-default-value"> </td> <td class="code-arg-flags"> optional </td> <td class="code-arg-desc">  </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>   <div class="code-arguments-hdr">Parameters</div> <table class="params code-arguments"> <tr> <th class="hdr-name">Name</th> <th class="hdr-type">Type</th> <th class="hdr-default-value">Default Value</th> <th class="hdr-flags">Flags</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name=""></a> <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-default-value"> </td> <td class="code-arg-flags"> </td> <td class="code-arg-desc">  </td> </tr> </table> </section> <section class="code-doc "> <a name="ParsedRequest"></a> <h3 class="code-ref">Interface: ParsedRequest</h3>  </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-default-value">Default Value</th> <th class="hdr-flags">Flags</th> <th class="hdr-desc">Description</th> </tr> <tr class="code-arg"> <td> <a name="10"></a> <strong class="code-arg-name"> method </strong> </td> <td class="code-arg-types"> <code>string</code> </td> <td class="code-arg-default-value"> </td> <td class="code-arg-flags"> exported </td> <td class="code-arg-desc">  </td> </tr> <tr class="code-arg"> <td> <a name="3"></a> <strong class="code-arg-name"> path </strong> </td> <td class="code-arg-types"> <code>string</code> </td> <td class="code-arg-default-value"> </td> <td class="code-arg-flags"> exported </td> <td class="code-arg-desc">  </td> </tr> <tr class="code-arg"> <td> <a name="9"></a> <strong class="code-arg-name"> pathname </strong> </td> <td class="code-arg-types"> <code>string</code> </td> <td class="code-arg-default-value"> </td> <td class="code-arg-flags"> exported </td> <td class="code-arg-desc">  </td> </tr> <tr class="code-arg"> <td> <a name="4"></a> <strong class="code-arg-name"> query </strong> </td> <td class="code-arg-types"> <code>anonymous</code> </td> <td class="code-arg-default-value"> </td> <td class="code-arg-flags"> exported </td> <td class="code-arg-desc">  </td> </tr> <tr class="code-arg"> <td> <a name="8"></a> <strong class="code-arg-name"> url </strong> </td> <td class="code-arg-types"> <code>string</code> </td> <td class="code-arg-default-value"> </td> <td class="code-arg-flags"> exported </td> <td class="code-arg-desc">  </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="RestBindings"></a> <h3 class="code-ref">Namespace: RestBindings</h3>  <div class="code-desc"> <p><p>RestServer-specific bindings</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="Http"></a> <h3 class="code-ref">Namespace: RestBindings.Http</h3>  <div class="code-desc"> <p><p>Request-specific bindings</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="Http"></a> <h3 class="code-ref">const RestBindings.Http.CONTEXT = BindingKey.create<Context>( 'rest.http.request.context', )</h3>  <div class="code-desc"> <p><p>Binding key for setting and injecting the http request context</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="Http"></a> <h3 class="code-ref">const RestBindings.Http.REQUEST = BindingKey.create<ParsedRequest>( 'rest.http.request', )</h3>  <div class="code-desc"> <p><p>Binding key for setting and injecting the http request</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="Http"></a> <h3 class="code-ref">const RestBindings.Http.RESPONSE = BindingKey.create<ServerResponse>( 'rest.http.response', )</h3>  <div class="code-desc"> <p><p>Binding key for setting and injecting the http response</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="SequenceActions"></a> <h3 class="code-ref">Namespace: RestBindings.SequenceActions</h3>  <div class="code-desc"> <p><p>Bindings for potential actions that could be used in a sequence</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="SequenceActions"></a> <h3 class="code-ref">const RestBindings.SequenceActions.FIND_ROUTE = BindingKey.create<FindRoute>( 'rest.sequence.actions.findRoute', )</h3>  <div class="code-desc"> <p><p>Binding key for setting and injecting a route finding function</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="SequenceActions"></a> <h3 class="code-ref">const RestBindings.SequenceActions.INVOKE_METHOD = BindingKey.create<InvokeMethod>( 'rest.sequence.actions.invokeMethod', )</h3>  <div class="code-desc"> <p><p>Binding key for setting and injecting a controller route invoking function</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="SequenceActions"></a> <h3 class="code-ref">const RestBindings.SequenceActions.LOG_ERROR = BindingKey.create<LogError>( 'rest.sequence.actions.logError', )</h3>  <div class="code-desc"> <p><p>Binding key for setting and injecting an error logging function</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="SequenceActions"></a> <h3 class="code-ref">const RestBindings.SequenceActions.PARSE_PARAMS = BindingKey.create<ParseParams>( 'rest.sequence.actions.parseParams', )</h3>  <div class="code-desc"> <p><p>Binding key for setting and injecting a parameter parsing function</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="SequenceActions"></a> <h3 class="code-ref">const RestBindings.SequenceActions.REJECT = BindingKey.create<Reject>( 'rest.sequence.actions.reject', )</h3>  <div class="code-desc"> <p><p>Binding key for setting and injecting a bad response writing function</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="SequenceActions"></a> <h3 class="code-ref">const RestBindings.SequenceActions.SEND = BindingKey.create<Send>('rest.sequence.actions.send')</h3>  <div class="code-desc"> <p><p>Binding key for setting and injecting a response writing function</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="API_SPEC"></a> <h3 class="code-ref">const RestBindings.API_SPEC = BindingKey.create<OpenApiSpec>('rest.apiSpec')</h3>  <div class="code-desc"> <p><p>Binding key for setting and injecting an OpenAPI spec</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="BIND_ELEMENT"></a> <h3 class="code-ref">const RestBindings.BIND_ELEMENT = BindingKey.create<BindElement>('bindElement')</h3>  <div class="code-desc"> <p><p>Binding key for setting and injecting a wrapper function for setting values on a given context</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="CONFIG"></a> <h3 class="code-ref">const RestBindings.CONFIG = CoreBindings.APPLICATION_CONFIG.deepProperty('rest')</h3>  <div class="code-desc"> <p><p>Binding key for setting and injecting RestComponentConfig</p> </p> <p></p> </div> </section> <section class="code-doc "> <a name="GET_FROM_CONTEXT"></a> <h3 class="code-ref">const RestBindings.GET_FROM_CON