@loopback/docs
Version:
Documentation for LoopBack 4
363 lines (362 loc) • 12.1 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.7.10",
"schemaVersion": 1003,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/http-caching-proxy!",
"docComment": "",
"name": "@loopback/http-caching-proxy",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@loopback/http-caching-proxy!",
"name": "",
"members": [
{
"kind": "Class",
"canonicalReference": "@loopback/http-caching-proxy!HttpCachingProxy:class",
"docComment": "/**\n * The HTTP proxy implementation.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class HttpCachingProxy "
}
],
"releaseTag": "Public",
"name": "HttpCachingProxy",
"members": [
{
"kind": "Constructor",
"canonicalReference": "@loopback/http-caching-proxy!HttpCachingProxy:constructor(1)",
"docComment": "/**\n * Constructs a new instance of the `HttpCachingProxy` class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor(options: "
},
{
"kind": "Reference",
"text": "ProxyOptions",
"canonicalReference": "@loopback/http-caching-proxy!ProxyOptions:interface"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
]
},
{
"kind": "Method",
"canonicalReference": "@loopback/http-caching-proxy!HttpCachingProxy#logError:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "logError(request: "
},
{
"kind": "Reference",
"text": "IncomingMessage",
"canonicalReference": "!\"\\\"http\\\"\".IncomingMessage:class"
},
{
"kind": "Content",
"text": ", error: "
},
{
"kind": "Reference",
"text": "Error",
"canonicalReference": "!Error:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "request",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "error",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"name": "logError"
},
{
"kind": "Method",
"canonicalReference": "@loopback/http-caching-proxy!HttpCachingProxy#start:member(1)",
"docComment": "/**\n * Start listening.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "start(): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "start"
},
{
"kind": "Method",
"canonicalReference": "@loopback/http-caching-proxy!HttpCachingProxy#stop:member(1)",
"docComment": "/**\n * Stop listening.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "stop(): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "stop"
},
{
"kind": "Property",
"canonicalReference": "@loopback/http-caching-proxy!HttpCachingProxy#url:member",
"docComment": "/**\n * URL where the proxy is listening on. Provide this value to your HTTP client as the proxy configuration.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "url: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "url",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false
}
],
"implementsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@loopback/http-caching-proxy!ProxyOptions:interface",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ProxyOptions "
}
],
"releaseTag": "Public",
"name": "ProxyOptions",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/http-caching-proxy!ProxyOptions#cachePath:member",
"docComment": "/**\n * Directory where to keep the cached snapshots.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "cachePath: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "cachePath",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/http-caching-proxy!ProxyOptions#logError:member",
"docComment": "/**\n * A flag if the error should be logged\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "logError?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "logError",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/http-caching-proxy!ProxyOptions#port:member",
"docComment": "/**\n * The port where the HTTP proxy should listen at. Default: 0 (let the system pick a free port)\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "port?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "port",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/http-caching-proxy!ProxyOptions#timeout:member",
"docComment": "/**\n * Timeout to connect to the target service\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "timeout?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "timeout",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/http-caching-proxy!ProxyOptions#ttl:member",
"docComment": "/**\n * How long to keep snapshots before making a new request to the backend. The value is in milliseconds.\n *\n * Default: one day\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "ttl?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ttl",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
}
]
}
]
}