@loopback/docs
Version:
Documentation for LoopBack 4
304 lines (303 loc) • 9.9 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.7.10",
"schemaVersion": 1003,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/apiconnect!",
"docComment": "",
"name": "@loopback/apiconnect",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@loopback/apiconnect!",
"name": "",
"members": [
{
"kind": "Namespace",
"canonicalReference": "@loopback/apiconnect!ApiConnectBindings:namespace",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace ApiConnectBindings "
}
],
"releaseTag": "Public",
"name": "ApiConnectBindings",
"members": [
{
"kind": "Variable",
"canonicalReference": "@loopback/apiconnect!ApiConnectBindings.API_CONNECT_SPEC_ENHANCER:var",
"docComment": "/**\n * Strongly-typed binding key for ApiConnectSpecEnhancer\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "API_CONNECT_SPEC_ENHANCER: "
},
{
"kind": "Reference",
"text": "BindingKey",
"canonicalReference": "@loopback/context!BindingKey:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ApiConnectSpecEnhancer",
"canonicalReference": "@loopback/apiconnect!ApiConnectSpecEnhancer:class"
},
{
"kind": "Content",
"text": ">"
}
],
"releaseTag": "Public",
"name": "API_CONNECT_SPEC_ENHANCER",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
}
]
},
{
"kind": "Class",
"canonicalReference": "@loopback/apiconnect!ApiConnectComponent:class",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class ApiConnectComponent implements "
},
{
"kind": "Reference",
"text": "Component",
"canonicalReference": "@loopback/core!Component:interface"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ApiConnectComponent",
"members": [
{
"kind": "Property",
"canonicalReference": "@loopback/apiconnect!ApiConnectComponent#bindings:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "bindings: "
},
{
"kind": "Content",
"text": "import(\"@loopback/core\")."
},
{
"kind": "Reference",
"text": "Binding",
"canonicalReference": "@loopback/context!Binding:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ApiConnectSpecEnhancer",
"canonicalReference": "@loopback/apiconnect!ApiConnectSpecEnhancer:class"
},
{
"kind": "Content",
"text": ">[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "bindings",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"isStatic": false
}
],
"implementsTokenRanges": [
{
"startIndex": 1,
"endIndex": 3
}
]
},
{
"kind": "Class",
"canonicalReference": "@loopback/apiconnect!ApiConnectSpecEnhancer:class",
"docComment": "/**\n * An OpenAPI spec enhancer to add `x-ibm-configuration` extension required by API Connect\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class ApiConnectSpecEnhancer implements "
},
{
"kind": "Reference",
"text": "OASEnhancer",
"canonicalReference": "@loopback/openapi-v3!OASEnhancer:interface"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ApiConnectSpecEnhancer",
"members": [
{
"kind": "Constructor",
"canonicalReference": "@loopback/apiconnect!ApiConnectSpecEnhancer:constructor(1)",
"docComment": "/**\n * Constructs a new instance of the `ApiConnectSpecEnhancer` class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor(options: "
},
{
"kind": "Reference",
"text": "ApiConnectSpecOptions",
"canonicalReference": "@loopback/apiconnect!ApiConnectSpecOptions:type"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
]
},
{
"kind": "Method",
"canonicalReference": "@loopback/apiconnect!ApiConnectSpecEnhancer#modifySpec:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "modifySpec(spec: "
},
{
"kind": "Reference",
"text": "OpenAPIObject",
"canonicalReference": "openapi3-ts!OpenAPIObject:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "OpenAPIObject",
"canonicalReference": "openapi3-ts!OpenAPIObject:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "spec",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "modifySpec"
},
{
"kind": "Property",
"canonicalReference": "@loopback/apiconnect!ApiConnectSpecEnhancer#name:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "name: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "name",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false
}
],
"implementsTokenRanges": [
{
"startIndex": 1,
"endIndex": 3
}
]
},
{
"kind": "TypeAlias",
"canonicalReference": "@loopback/apiconnect!ApiConnectSpecOptions:type",
"docComment": "/**\n * Configuration for IBM API Connect extensions to the OpenAPI spec\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type ApiConnectSpecOptions = "
},
{
"kind": "Content",
"text": "{\n targetUrl: string;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ApiConnectSpecOptions",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
]
}
]
}