@loopback/docs 8.0.3 → 8.0.4

package/site/apidocs/rest.httphandler.registerroute.md

@@ -52,6 +52,7 @@ route
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/site/apidocs/rest.httpserverlike.md

@@ -60,4 +60,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

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

@@ -56,4 +56,5 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.infospecenhancer.md

@@ -150,4 +150,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.infospecenhancer.modifyspec.md

@@ -52,6 +52,7 @@ spec
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [OpenApiSpec](./openapi-v3.openapispec.md)

package/site/apidocs/rest.invokebodyparsermiddleware.md

@@ -72,6 +72,7 @@ Http request
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 Promise&lt;any&gt;

package/site/apidocs/rest.invokemethodmiddlewareprovider.md

@@ -51,4 +51,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.invokemethodprovider.md

@@ -52,4 +52,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.invokemethodprovider.value.md

@@ -52,6 +52,7 @@ context
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [InvokeMethod](./rest.invokemethod.md)

package/site/apidocs/rest.joinpath.md

@@ -66,6 +66,7 @@ string
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 string

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

@@ -56,4 +56,5 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.jsonbodyparser.md

@@ -139,4 +139,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

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

@@ -52,6 +52,7 @@ Request
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 Promise&lt;[RequestBody](./rest.requestbody.md)<!-- -->&gt;

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

@@ -52,6 +52,7 @@ string
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 boolean

package/site/apidocs/rest.logerrorprovider.md

@@ -52,4 +52,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.md

@@ -1315,4 +1315,5 @@ A sequence function is a function implementing a custom sequence of actions to h
 
 </td></tr>
 </tbody></table>
+
 

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

@@ -86,4 +86,5 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.middlewaresequence.handle.md

@@ -64,6 +64,7 @@ The request context: HTTP request and response objects, per-request IoC containe
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 Promise&lt;void&gt;

package/site/apidocs/rest.middlewaresequence.md

@@ -179,4 +179,5 @@ In front of the groups above, we have a special middleware called `sendResponse`
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.node.md

@@ -142,4 +142,5 @@ _(Optional)_ Value of the node
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.normalizeparsingerror.md

@@ -54,6 +54,7 @@ HttpError
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 HttpError&lt;number&gt;

package/site/apidocs/rest.openapispecform.md

@@ -83,4 +83,5 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.openapispecoptions.md

@@ -140,4 +140,5 @@ _(Optional)_ A flag to force `servers` to be set from the http request for the O
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.parsejson.md

@@ -88,6 +88,7 @@ _(Optional)_ An array of keys to be rejected
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 any

package/site/apidocs/rest.parseoperationargs.md

@@ -104,6 +104,7 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 Promise&lt;[OperationArgs](./rest.operationargs.md)<!-- -->&gt;

package/site/apidocs/rest.parseparamsmiddlewareprovider.md

@@ -51,4 +51,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.parseparamsprovider.md

@@ -54,4 +54,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.parseparamsprovider.value.md

@@ -80,6 +80,7 @@ ajvFactory
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [ParseParams](./rest.parseparams.md)

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

@@ -56,4 +56,5 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.rawbodyparser.md

@@ -141,4 +141,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

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

@@ -52,6 +52,7 @@ Request
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 Promise&lt;[RequestBody](./rest.requestbody.md)<!-- -->&gt;

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

@@ -52,6 +52,7 @@ string
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 boolean

package/site/apidocs/rest.rebaseopenapispec.md

@@ -66,6 +66,7 @@ string
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 T

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

@@ -84,4 +84,5 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.redirectroute.invokehandler.md

@@ -66,6 +66,7 @@ args
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 Promise&lt;[OperationRetval](./rest.operationretval.md)<!-- -->&gt;

package/site/apidocs/rest.redirectroute.isredirectroute.md

@@ -54,6 +54,7 @@ any
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 obj is [RedirectRoute](./rest.redirectroute.md)

package/site/apidocs/rest.redirectroute.md

@@ -302,4 +302,5 @@ type guard type checker for this class
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.redirectroute.updatebindings.md

@@ -52,6 +52,7 @@ requestContext
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

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

@@ -56,4 +56,5 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 

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

@@ -52,6 +52,7 @@ route
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

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

@@ -66,6 +66,7 @@ string
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [ResolvedRoute](./rest.resolvedroute.md) \| undefined

package/site/apidocs/rest.regexprouter.md

@@ -117,4 +117,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.rejectprovider.md

@@ -52,4 +52,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.rejectprovider.value.md

@@ -68,6 +68,7 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Reject](./rest.reject.md)

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

@@ -72,4 +72,5 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.requestbodyparser.loadrequestbodyifneeded.md

@@ -66,6 +66,7 @@ Request
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 Promise&lt;[RequestBody](./rest.requestbody.md)<!-- -->&gt;

package/site/apidocs/rest.requestbodyparser.md

@@ -128,4 +128,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.requestbodyparseroptions.md

@@ -143,4 +143,5 @@ _(Optional)_ Validation options for AJV, see https://github.com/epoberezkin/ajv\
 
 </td></tr>
 </tbody></table>
+
 

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

@@ -112,4 +112,5 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.requestcontext.md

@@ -238,4 +238,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.requestwithsession.md

@@ -63,4 +63,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.resolvednode.md

@@ -79,4 +79,5 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.resolvedroute.md

@@ -86,4 +86,5 @@ Server/application wide schemas shared by multiple routes, e.g. model schemas. T
 
 </td></tr>
 </tbody></table>
+
 

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

@@ -56,4 +56,5 @@ Parent context
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.restapplication._constructor__1.md

@@ -72,4 +72,5 @@ _(Optional)_ Parent context
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.restapplication.api.md

@@ -58,6 +58,7 @@ The OpenAPI specification, as an object.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Binding](./context.binding.md)

package/site/apidocs/rest.restapplication.basepath.md

@@ -56,6 +56,7 @@ _(Optional)_ Base path
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/site/apidocs/rest.restapplication.bodyparser.md

@@ -70,6 +70,7 @@ _(Optional)_ Optional binding address
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Binding](./context.binding.md)<!-- -->&lt;[BodyParser](./rest.bodyparser.md)<!-- -->&gt;

package/site/apidocs/rest.restapplication.exportopenapispec.md

@@ -72,6 +72,7 @@ _(Optional)_ Log function, default to `console.log`
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 Promise&lt;void&gt;

package/site/apidocs/rest.restapplication.expressmiddleware.md

@@ -88,6 +88,7 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Binding](./context.binding.md)<!-- -->&lt;Middleware&gt;

package/site/apidocs/rest.restapplication.expressmiddleware_1.md

@@ -88,6 +88,7 @@ _(Optional)_ Options for registration
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Binding](./context.binding.md)<!-- -->&lt;Middleware&gt;

package/site/apidocs/rest.restapplication.handler.md

@@ -52,6 +52,7 @@ handlerFn
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/site/apidocs/rest.restapplication.md

@@ -392,4 +392,5 @@ Mount static assets to the REST server. See https://expressjs.com/en/4x/api.html
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.restapplication.middleware.md

@@ -72,6 +72,7 @@ _(Optional)_ Middleware binding options
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Binding](./context.binding.md)<!-- -->&lt;Middleware&gt;

package/site/apidocs/rest.restapplication.mountexpressrouter.md

@@ -88,6 +88,7 @@ _(Optional)_ A partial OpenAPI spec describing endpoints provided by the router.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/site/apidocs/rest.restapplication.redirect.md

@@ -88,6 +88,7 @@ _(Optional)_ HTTP status code to respond with, defaults to 303 (See Other).
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Binding](./context.binding.md)

package/site/apidocs/rest.restapplication.route.md

@@ -136,6 +136,7 @@ The name of the controller method
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Binding](./context.binding.md)

package/site/apidocs/rest.restapplication.route_1.md

@@ -104,6 +104,7 @@ The function to invoke with the request parameters described in the spec.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Binding](./context.binding.md)

package/site/apidocs/rest.restapplication.route_2.md

@@ -56,6 +56,7 @@ The route to add.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Binding](./context.binding.md)

package/site/apidocs/rest.restapplication.route_3.md

@@ -96,6 +96,7 @@ Function
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Binding](./context.binding.md)

package/site/apidocs/rest.restapplication.sequence.md

@@ -52,6 +52,7 @@ sequence
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Binding](./context.binding.md)

package/site/apidocs/rest.restapplication.server.md

@@ -68,6 +68,7 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Binding](./context.binding.md)

package/site/apidocs/rest.restapplication.static.md

@@ -88,6 +88,7 @@ _(Optional)_ Options for serve-static
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/site/apidocs/rest.restbindings.http.md

@@ -68,4 +68,5 @@ Binding key for setting and injecting the http response
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.restbindings.md

@@ -367,4 +367,5 @@ Binding key for setting and injecting the URL of RestServer
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.restbindings.operation.md

@@ -60,4 +60,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.restbindings.sequenceactions.md

@@ -112,4 +112,5 @@ Binding key for setting and injecting a response writing function
 
 </td></tr>
 </tbody></table>
+
 

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

@@ -70,4 +70,5 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/rest.restcomponent.md

@@ -131,4 +131,5 @@ Add built-in body parsers
 
 </td></tr>
 </tbody></table>
+