@loopback/docs 7.1.4 → 8.0.0

package/site/apidocs/http-caching-proxy.proxyoptions.md

@@ -21,12 +21,123 @@ export interface ProxyOptions
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [cachePath](./http-caching-proxy.proxyoptions.cachepath.md) |  | string | Directory where to keep the cached snapshots. |
-|  [logError?](./http-caching-proxy.proxyoptions.logerror.md) |  | boolean | _(Optional)_ A flag if the error should be logged |
-|  [port?](./http-caching-proxy.proxyoptions.port.md) |  | number | _(Optional)_ The port where the HTTP proxy should listen at. Default: 0 (let the system pick a free port) |
-|  [timeout?](./http-caching-proxy.proxyoptions.timeout.md) |  | number | _(Optional)_ Timeout to connect to the target service |
-|  [ttl?](./http-caching-proxy.proxyoptions.ttl.md) |  | number | <p>_(Optional)_ How long to keep snapshots before making a new request to the backend. The value is in milliseconds.</p><p>Default: one day</p> |
+<table><thead><tr><th>
 
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[cachePath](./http-caching-proxy.proxyoptions.cachepath.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+Directory where to keep the cached snapshots.
+
+
+</td></tr>
+<tr><td>
+
+[logError?](./http-caching-proxy.proxyoptions.logerror.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ A flag if the error should be logged
+
+
+</td></tr>
+<tr><td>
+
+[port?](./http-caching-proxy.proxyoptions.port.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The port where the HTTP proxy should listen at. Default: 0 (let the system pick a free port)
+
+
+</td></tr>
+<tr><td>
+
+[timeout?](./http-caching-proxy.proxyoptions.timeout.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ Timeout to connect to the target service
+
+
+</td></tr>
+<tr><td>
+
+[ttl?](./http-caching-proxy.proxyoptions.ttl.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ How long to keep snapshots before making a new request to the backend. The value is in milliseconds.
+
+Default: one day
+
+
+</td></tr>
+</tbody></table>
 

package/site/apidocs/http-server.basehttpoptions.md

@@ -24,8 +24,49 @@ export interface BaseHttpOptions extends ListenOptions, Partial<HttpServerProper
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [gracePeriodForClose?](./http-server.basehttpoptions.graceperiodforclose.md) |  | number | <p>_(Optional)_ The <code>gracePeriodForClose</code> property controls how to stop the server gracefully. Its value is the number of milliseconds to wait before in-flight requests finish when the server is being stopped. With this setting, we also reject new requests from existing keep-alive connections in addition to stopping accepting new connections.</p><p>Defaults to Infinity (don't force-close). If you want to immediately destroy all sockets set its value to <code>0</code>.</p><p>See [stoppable](https://www.npmjs.com/package/stoppable)</p> |
+<table><thead><tr><th>
 
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[gracePeriodForClose?](./http-server.basehttpoptions.graceperiodforclose.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The `gracePeriodForClose` property controls how to stop the server gracefully. Its value is the number of milliseconds to wait before in-flight requests finish when the server is being stopped. With this setting, we also reject new requests from existing keep-alive connections in addition to stopping accepting new connections.
+
+Defaults to Infinity (don't force-close). If you want to immediately destroy all sockets set its value to `0`<!-- -->.
+
+See [stoppable](https://www.npmjs.com/package/stoppable)
+
+
+</td></tr>
+</tbody></table>
 

package/site/apidocs/http-server.httpoptions.md

@@ -24,8 +24,45 @@ export interface HttpOptions extends BaseHttpOptions
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [protocol?](./http-server.httpoptions.protocol.md) |  | 'http' | _(Optional)_ |
+<table><thead><tr><th>
 
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[protocol?](./http-server.httpoptions.protocol.md)
+
+
+</td><td>
+
+
+</td><td>
+
+'http'
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
 

package/site/apidocs/http-server.httpserver._constructor_.md

@@ -23,9 +23,51 @@ constructor(requestListener: RequestListener, serverOptions?: HttpServerOptions)
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  requestListener | [RequestListener](./http-server.requestlistener.md) |  |
-|  serverOptions | [HttpServerOptions](./http-server.httpserveroptions.md) | _(Optional)_ |
+<table><thead><tr><th>
 
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+requestListener
+
+
+</td><td>
+
+[RequestListener](./http-server.requestlistener.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+serverOptions
+
+
+</td><td>
+
+[HttpServerOptions](./http-server.httpserveroptions.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
 

package/site/apidocs/http-server.httpserver.md

@@ -23,28 +23,272 @@ export declare class HttpServer
 
 ## Constructors
 
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(requestListener, serverOptions)](./http-server.httpserver._constructor_.md) |  | Constructs a new instance of the <code>HttpServer</code> class |
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(requestListener, serverOptions)](./http-server.httpserver._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Constructs a new instance of the `HttpServer` class
+
+
+</td></tr>
+</tbody></table>
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [address](./http-server.httpserver.address.md) | <code>readonly</code> | string \| AddressInfo \| undefined | Address of the HTTP / HTTPS server |
-|  [host](./http-server.httpserver.host.md) | <code>readonly</code> | string \| undefined | Host of the HTTP / HTTPS server |
-|  [listening](./http-server.httpserver.listening.md) | <code>readonly</code> | boolean | State of the HTTP / HTTPS server |
-|  [port](./http-server.httpserver.port.md) | <code>readonly</code> | number | Port number of the HTTP / HTTPS server |
-|  [protocol](./http-server.httpserver.protocol.md) | <code>readonly</code> | [HttpProtocol](./http-server.httpprotocol.md) | Protocol of the HTTP / HTTPS server |
-|  [server](./http-server.httpserver.server.md) | <code>readonly</code> | http.Server \| https.Server |  |
-|  [serverOptions](./http-server.httpserver.serveroptions.md) | <code>readonly</code> | [HttpServerOptions](./http-server.httpserveroptions.md) |  |
-|  [url](./http-server.httpserver.url.md) | <code>readonly</code> | string | URL of the HTTP / HTTPS server |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[address](./http-server.httpserver.address.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string \| AddressInfo \| undefined
+
+
+</td><td>
+
+Address of the HTTP / HTTPS server
+
+
+</td></tr>
+<tr><td>
+
+[host](./http-server.httpserver.host.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+Host of the HTTP / HTTPS server
+
+
+</td></tr>
+<tr><td>
+
+[listening](./http-server.httpserver.listening.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+State of the HTTP / HTTPS server
+
+
+</td></tr>
+<tr><td>
+
+[port](./http-server.httpserver.port.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+Port number of the HTTP / HTTPS server
+
+
+</td></tr>
+<tr><td>
+
+[protocol](./http-server.httpserver.protocol.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[HttpProtocol](./http-server.httpprotocol.md)
+
+
+</td><td>
+
+Protocol of the HTTP / HTTPS server
+
+
+</td></tr>
+<tr><td>
+
+[server](./http-server.httpserver.server.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+http.Server \| https.Server
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[serverOptions](./http-server.httpserver.serveroptions.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[HttpServerOptions](./http-server.httpserveroptions.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[url](./http-server.httpserver.url.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+URL of the HTTP / HTTPS server
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [start()](./http-server.httpserver.start.md) |  | Starts the HTTP / HTTPS server |
-|  [stop()](./http-server.httpserver.stop.md) |  | Stops the HTTP / HTTPS server |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[start()](./http-server.httpserver.start.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Starts the HTTP / HTTPS server
+
+
+</td></tr>
+<tr><td>
+
+[stop()](./http-server.httpserver.stop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Stops the HTTP / HTTPS server
+
 
+</td></tr>
+</tbody></table>
 

package/site/apidocs/http-server.httpsoptions.md

@@ -24,8 +24,43 @@ export interface HttpsOptions extends BaseHttpOptions, https.ServerOptions
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [protocol](./http-server.httpsoptions.protocol.md) |  | 'https' |  |
+<table><thead><tr><th>
 
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[protocol](./http-server.httpsoptions.protocol.md)
+
+
+</td><td>
+
+
+</td><td>
+
+'https'
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>