@loopback/docs
Version:
Documentation for LoopBack 4
213 lines (212 loc) • 7.02 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.6.2",
"schemaVersion": 1003,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/rest-explorer!",
"docComment": "",
"name": "@loopback/rest-explorer",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@loopback/rest-explorer!",
"name": "",
"members": [
{
"kind": "Namespace",
"canonicalReference": "@loopback/rest-explorer!RestExplorerBindings:namespace",
"docComment": "/**\n * Binding keys used by this component.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace RestExplorerBindings "
}
],
"releaseTag": "Public",
"name": "RestExplorerBindings",
"members": [
{
"kind": "Variable",
"canonicalReference": "@loopback/rest-explorer!RestExplorerBindings.COMPONENT:var",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "COMPONENT: "
},
{
"kind": "Reference",
"text": "BindingKey",
"canonicalReference": "@loopback/context!BindingKey:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "RestExplorerComponent",
"canonicalReference": "@loopback/rest-explorer!RestExplorerComponent:class"
},
{
"kind": "Content",
"text": ">"
}
],
"releaseTag": "Public",
"name": "COMPONENT",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
},
{
"kind": "Variable",
"canonicalReference": "@loopback/rest-explorer!RestExplorerBindings.CONFIG:var",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "CONFIG: "
},
{
"kind": "Content",
"text": "import(\"@loopback/context\")."
},
{
"kind": "Reference",
"text": "BindingAddress",
"canonicalReference": "@loopback/context!BindingAddress:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "RestExplorerConfig",
"canonicalReference": "@loopback/rest-explorer!RestExplorerConfig:type"
},
{
"kind": "Content",
"text": ">"
}
],
"releaseTag": "Public",
"name": "CONFIG",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
}
]
},
{
"kind": "Class",
"canonicalReference": "@loopback/rest-explorer!RestExplorerComponent:class",
"docComment": "/**\n * A component providing a self-hosted API Explorer.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class RestExplorerComponent implements "
},
{
"kind": "Reference",
"text": "Component",
"canonicalReference": "@loopback/core!Component:interface"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "RestExplorerComponent",
"members": [
{
"kind": "Constructor",
"canonicalReference": "@loopback/rest-explorer!RestExplorerComponent:constructor(1)",
"docComment": "/**\n * Constructs a new instance of the `RestExplorerComponent` class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor(application: "
},
{
"kind": "Reference",
"text": "RestApplication",
"canonicalReference": "@loopback/rest!RestApplication:class"
},
{
"kind": "Content",
"text": ", restExplorerConfig?: "
},
{
"kind": "Reference",
"text": "RestExplorerConfig",
"canonicalReference": "@loopback/rest-explorer!RestExplorerConfig:type"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "application",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "restExplorerConfig",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
}
],
"implementsTokenRanges": [
{
"startIndex": 1,
"endIndex": 3
}
]
},
{
"kind": "TypeAlias",
"canonicalReference": "@loopback/rest-explorer!RestExplorerConfig:type",
"docComment": "/**\n * Options to configure API Explorer UI\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type RestExplorerConfig = "
},
{
"kind": "Content",
"text": "{\n path?: string;\n useSelfHostedSpec?: false;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "RestExplorerConfig",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
]
}
]
}