@loopback/docs
Version:
Documentation for LoopBack 4
740 lines (739 loc) • 21.3 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.2.1",
"schemaVersion": 1001,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/http-server",
"docComment": "",
"name": "@loopback/http-server",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "",
"name": "",
"members": [
{
"kind": "Interface",
"canonicalReference": "(HttpOptions:interface)",
"docComment": "/**\n * HTTP server options\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "HttpOptions"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "ListenOptions"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "HttpOptions",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "protocol",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "protocol"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "'http'"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "protocol",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 5
}
]
},
{
"kind": "Class",
"canonicalReference": "(HttpServer:class)",
"docComment": "/**\n * HTTP / HTTPS server used by LoopBack's RestServer\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "HttpServer"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "HttpServer",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Constructs a new instance of the `HttpServer` class\n *\n * @param - requestListener\n *\n * @param - serverOptions\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "requestListener"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "RequestListener"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "serverOptions"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "HttpServerOptions"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "requestListener",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "serverOptions",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
}
]
},
{
"kind": "Property",
"canonicalReference": "(address:instance)",
"docComment": "/**\n * Address of the HTTP / HTTPS server\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "address"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string | "
},
{
"kind": "Reference",
"text": "AddressInfo"
},
{
"kind": "Content",
"text": " | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "address",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 6
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(host:instance)",
"docComment": "/**\n * Host of the HTTP / HTTPS server\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "host"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "host",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(listening:instance)",
"docComment": "/**\n * State of the HTTP / HTTPS server\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "listening"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "listening",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(port:instance)",
"docComment": "/**\n * Port number of the HTTP / HTTPS server\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "port"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "port",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(protocol:instance)",
"docComment": "/**\n * Protocol of the HTTP / HTTPS server\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "protocol"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "HttpProtocol"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "protocol",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(server:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "server"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "http"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Server"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "https"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "Server"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "server",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 10
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "(start:instance,0)",
"docComment": "/**\n * Starts the HTTP / HTTPS server\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 * Stops the HTTP / HTTPS server\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 of the HTTP / HTTPS server\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "url"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "url",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": false
}
],
"implementsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(HttpsOptions:interface)",
"docComment": "/**\n * HTTPS server options\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "HttpsOptions"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "ListenOptions"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "https"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "ServerOptions"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "HttpsOptions",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "protocol",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "protocol"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "'https'"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "protocol",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 4
},
{
"startIndex": 5,
"endIndex": 9
}
]
},
{
"kind": "TypeAlias",
"canonicalReference": "HttpProtocol",
"docComment": "/**\n * Supported protocols\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "HttpProtocol"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "'http' | 'https'"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "HttpProtocol",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"kind": "TypeAlias",
"canonicalReference": "HttpServerOptions",
"docComment": "/**\n * Possible server options\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "HttpServerOptions"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "HttpOptions"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "HttpsOptions"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "HttpServerOptions",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 6
}
},
{
"kind": "TypeAlias",
"canonicalReference": "RequestListener",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "RequestListener"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "req"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "IncomingMessage"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "res"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ServerResponse"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "RequestListener",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 12
}
}
]
}
]
}