@loopback/docs
Version:
Documentation for LoopBack 4
267 lines (266 loc) • 8.86 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.6.2",
"schemaVersion": 1003,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/extension-metrics!",
"docComment": "",
"name": "@loopback/extension-metrics",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@loopback/extension-metrics!",
"name": "",
"members": [
{
"kind": "Variable",
"canonicalReference": "@loopback/extension-metrics!DEFAULT_METRICS_OPTIONS:var",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "DEFAULT_METRICS_OPTIONS: "
},
{
"kind": "Reference",
"text": "MetricsOptions",
"canonicalReference": "@loopback/extension-metrics!MetricsOptions:interface"
}
],
"releaseTag": "Public",
"name": "DEFAULT_METRICS_OPTIONS",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Namespace",
"canonicalReference": "@loopback/extension-metrics!MetricsBindings:namespace",
"docComment": "/**\n * Binding keys used by this component.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace MetricsBindings "
}
],
"releaseTag": "Public",
"name": "MetricsBindings",
"members": [
{
"kind": "Variable",
"canonicalReference": "@loopback/extension-metrics!MetricsBindings.COMPONENT:var",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "COMPONENT: "
},
{
"kind": "Reference",
"text": "BindingKey",
"canonicalReference": "@loopback/context!BindingKey:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "MetricsComponent",
"canonicalReference": "@loopback/extension-metrics!MetricsComponent:class"
},
{
"kind": "Content",
"text": ">"
}
],
"releaseTag": "Public",
"name": "COMPONENT",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
}
]
},
{
"kind": "Class",
"canonicalReference": "@loopback/extension-metrics!MetricsComponent:class",
"docComment": "/**\n * A component providing metrics for Prometheus\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class MetricsComponent implements "
},
{
"kind": "Reference",
"text": "Component",
"canonicalReference": "@loopback/core!Component:interface"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "MetricsComponent",
"members": [
{
"kind": "Constructor",
"canonicalReference": "@loopback/extension-metrics!MetricsComponent:constructor(1)",
"docComment": "/**\n * Constructs a new instance of the `MetricsComponent` class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor(application: "
},
{
"kind": "Reference",
"text": "Application",
"canonicalReference": "@loopback/core!Application:class"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "MetricsOptions",
"canonicalReference": "@loopback/extension-metrics!MetricsOptions:interface"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "application",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
}
],
"implementsTokenRanges": [
{
"startIndex": 1,
"endIndex": 3
}
]
},
{
"kind": "Interface",
"canonicalReference": "@loopback/extension-metrics!MetricsOptions:interface",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface MetricsOptions "
}
],
"releaseTag": "Public",
"name": "MetricsOptions",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/extension-metrics!MetricsOptions#defaultMetrics:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "defaultMetrics?: "
},
{
"kind": "Content",
"text": "{\n disabled?: boolean;\n } & "
},
{
"kind": "Reference",
"text": "DefaultMetricsCollectorConfiguration",
"canonicalReference": "prom-client!DefaultMetricsCollectorConfiguration:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "defaultMetrics",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/extension-metrics!MetricsOptions#endpoint:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "endpoint?: "
},
{
"kind": "Content",
"text": "{\n disabled?: boolean;\n basePath?: string;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "endpoint",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/extension-metrics!MetricsOptions#pushGateway:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "pushGateway?: "
},
{
"kind": "Content",
"text": "{\n disabled?: boolean;\n url: string;\n interval?: number;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "pushGateway",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
}
]
}
]
}