UNPKG

@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

166 lines (76 loc) 2.58 kB
--- lang: en title: 'API docs: http-caching-proxy.proxyoptions' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/http-caching-proxy permalink: /doc/en/lb4/apidocs.http-caching-proxy.proxyoptions.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/http-caching-proxy](./http-caching-proxy.md) &gt; [ProxyOptions](./http-caching-proxy.proxyoptions.md) ## ProxyOptions interface **Signature:** ```typescript export interface ProxyOptions ``` ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [cachePath](./http-caching-proxy.proxyoptions.cachepath.md) </td><td markdown="1"> </td><td markdown="1"> string </td><td markdown="1"> Directory where to keep the cached snapshots. </td></tr> <tr><td markdown="1"> [logError?](./http-caching-proxy.proxyoptions.logerror.md) </td><td markdown="1"> </td><td markdown="1"> boolean </td><td markdown="1"> _(Optional)_ A flag if the error should be logged </td></tr> <tr><td markdown="1"> [port?](./http-caching-proxy.proxyoptions.port.md) </td><td markdown="1"> </td><td markdown="1"> number </td><td markdown="1"> _(Optional)_ The port where the HTTP proxy should listen at. Default: 0 (let the system pick a free port) </td></tr> <tr><td markdown="1"> [rejectUnauthorized?](./http-caching-proxy.proxyoptions.rejectunauthorized.md) </td><td markdown="1"> </td><td markdown="1"> boolean </td><td markdown="1"> _(Optional)_ Whether to reject unauthorized SSL certificates. Set to false to allow self-signed certificates in test environments. Default: true (strict SSL validation) </td></tr> <tr><td markdown="1"> [timeout?](./http-caching-proxy.proxyoptions.timeout.md) </td><td markdown="1"> </td><td markdown="1"> number </td><td markdown="1"> _(Optional)_ Timeout to connect to the target service </td></tr> <tr><td markdown="1"> [ttl?](./http-caching-proxy.proxyoptions.ttl.md) </td><td markdown="1"> </td><td markdown="1"> number </td><td markdown="1"> _(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>