@loopback/docs
Version:
Documentation for LoopBack 4
376 lines (375 loc) • 11.4 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.2.1",
"schemaVersion": 1001,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/http-caching-proxy",
"docComment": "",
"name": "@loopback/http-caching-proxy",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "",
"name": "",
"members": [
{
"kind": "Class",
"canonicalReference": "(HttpCachingProxy:class)",
"docComment": "/**\n * The HTTP proxy implementation.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "HttpCachingProxy"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "HttpCachingProxy",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Constructs a new instance of the `HttpCachingProxy` class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ProxyOptions"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
},
{
"kind": "Method",
"canonicalReference": "(logError:instance,0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "logError"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "request"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "IncomingMessage"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "error"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Error"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "request",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "error",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "logError"
},
{
"kind": "Method",
"canonicalReference": "(start:instance,0)",
"docComment": "/**\n * Start listening.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "start"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "start"
},
{
"kind": "Method",
"canonicalReference": "(stop:instance,0)",
"docComment": "/**\n * Stop listening.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "stop"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "stop"
},
{
"kind": "Property",
"canonicalReference": "(url:instance)",
"docComment": "/**\n * URL where the proxy is listening on. Provide this value to your HTTP client as the proxy configuration.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "url"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "url",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"isStatic": false
}
],
"implementsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(ProxyOptions:interface)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "ProxyOptions"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ProxyOptions",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "cachePath",
"docComment": "/**\n * Directory where to keep the cached snapshots.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "cachePath"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "cachePath",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "port",
"docComment": "/**\n * The port where the HTTP proxy should listen at. Default: 0 (let the system pick a free port)\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "port"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "port",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "ttl",
"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": "Reference",
"text": "ttl"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ttl",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
}
]
}
]
}