@loopback/docs
Version:
Documentation for LoopBack 4
435 lines (434 loc) • 14.1 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.6.2",
"schemaVersion": 1003,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/extension-health!",
"docComment": "",
"name": "@loopback/extension-health",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@loopback/extension-health!",
"name": "",
"members": [
{
"kind": "Variable",
"canonicalReference": "@loopback/extension-health!DEFAULT_HEALTH_OPTIONS:var",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "DEFAULT_HEALTH_OPTIONS: "
},
{
"kind": "Reference",
"text": "HealthOptions",
"canonicalReference": "@loopback/extension-health!HealthOptions:type"
}
],
"releaseTag": "Public",
"name": "DEFAULT_HEALTH_OPTIONS",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Namespace",
"canonicalReference": "@loopback/extension-health!HealthBindings:namespace",
"docComment": "/**\n * Binding keys used by this component.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace HealthBindings "
}
],
"releaseTag": "Public",
"name": "HealthBindings",
"members": [
{
"kind": "Variable",
"canonicalReference": "@loopback/extension-health!HealthBindings.COMPONENT:var",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "COMPONENT: "
},
{
"kind": "Reference",
"text": "BindingKey",
"canonicalReference": "@loopback/context!BindingKey:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "HealthComponent",
"canonicalReference": "@loopback/extension-health!HealthComponent:class"
},
{
"kind": "Content",
"text": ">"
}
],
"releaseTag": "Public",
"name": "COMPONENT",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
},
{
"kind": "Variable",
"canonicalReference": "@loopback/extension-health!HealthBindings.CONFIG:var",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "CONFIG: "
},
{
"kind": "Content",
"text": "import(\"@loopback/core\")."
},
{
"kind": "Reference",
"text": "BindingAddress",
"canonicalReference": "@loopback/context!BindingAddress:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<import(\"./types\")."
},
{
"kind": "Reference",
"text": "HealthOptions",
"canonicalReference": "@loopback/extension-health!HealthOptions:type"
},
{
"kind": "Content",
"text": ">>"
}
],
"releaseTag": "Public",
"name": "CONFIG",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@loopback/extension-health!HealthBindings.HEALTH_CHECKER:var",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "HEALTH_CHECKER: "
},
{
"kind": "Reference",
"text": "BindingKey",
"canonicalReference": "@loopback/context!BindingKey:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "HealthChecker",
"canonicalReference": "@cloudnative/health!~HealthChecker:class"
},
{
"kind": "Content",
"text": ">"
}
],
"releaseTag": "Public",
"name": "HEALTH_CHECKER",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
}
]
},
{
"kind": "Class",
"canonicalReference": "@loopback/extension-health!HealthComponent:class",
"docComment": "/**\n * A component providing health status\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class HealthComponent implements "
},
{
"kind": "Reference",
"text": "Component",
"canonicalReference": "@loopback/core!Component:interface"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "HealthComponent",
"members": [
{
"kind": "Constructor",
"canonicalReference": "@loopback/extension-health!HealthComponent:constructor(1)",
"docComment": "/**\n * Constructs a new instance of the `HealthComponent` class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor(application: "
},
{
"kind": "Reference",
"text": "Application",
"canonicalReference": "@loopback/core!Application:class"
},
{
"kind": "Content",
"text": ", healthConfig?: "
},
{
"kind": "Reference",
"text": "HealthConfig",
"canonicalReference": "@loopback/extension-health!HealthConfig:type"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "application",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "healthConfig",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
}
],
"implementsTokenRanges": [
{
"startIndex": 1,
"endIndex": 3
}
]
},
{
"kind": "TypeAlias",
"canonicalReference": "@loopback/extension-health!HealthConfig:type",
"docComment": "/**\n * Configuration for health component with optional properties\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type HealthConfig = "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "HealthOptions",
"canonicalReference": "@loopback/extension-health!HealthOptions:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "HealthConfig",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@loopback/extension-health!HealthOptions:type",
"docComment": "/**\n * Options for health component\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type HealthOptions = "
},
{
"kind": "Content",
"text": "{\n disabled?: boolean;\n healthPath: string;\n readyPath: string;\n livePath: string;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "HealthOptions",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Namespace",
"canonicalReference": "@loopback/extension-health!HealthTags:namespace",
"docComment": "/**\n * Binding tags for health related services\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace HealthTags "
}
],
"releaseTag": "Public",
"name": "HealthTags",
"members": [
{
"kind": "Variable",
"canonicalReference": "@loopback/extension-health!HealthTags.LIVE_CHECK:var",
"docComment": "/**\n * Binding tag for liveness check functions\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "LIVE_CHECK = \"health.liveCheck\""
}
],
"releaseTag": "Public",
"name": "LIVE_CHECK",
"variableTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"kind": "Variable",
"canonicalReference": "@loopback/extension-health!HealthTags.READY_CHECK:var",
"docComment": "/**\n * Binding tag for readiness check functions\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "READY_CHECK = \"health.readyCheck\""
}
],
"releaseTag": "Public",
"name": "READY_CHECK",
"variableTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
]
},
{
"kind": "TypeAlias",
"canonicalReference": "@loopback/extension-health!LiveCheck:type",
"docComment": "/**\n * Functions for liveness check\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type LiveCheck = "
},
{
"kind": "Content",
"text": "() => "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "LiveCheck",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@loopback/extension-health!ReadyCheck:type",
"docComment": "/**\n * Functions for readiness check\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type ReadyCheck = "
},
{
"kind": "Content",
"text": "() => "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ReadyCheck",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
}
]
}
]
}