{
  "metadata": {
    "toolPackage": "@microsoft/api-extractor",
    "toolVersion": "7.3.8",
    "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": "Reference",
              "text": "DEFAULT_HEALTH_OPTIONS"
            },
            {
              "kind": "Content",
              "text": ": "
            },
            {
              "kind": "Reference",
              "text": "HealthOptions"
            }
          ],
          "releaseTag": "Public",
          "name": "DEFAULT_HEALTH_OPTIONS",
          "variableTypeTokenRange": {
            "startIndex": 2,
            "endIndex": 3
          }
        },
        {
          "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 "
            },
            {
              "kind": "Reference",
              "text": "HealthBindings"
            },
            {
              "kind": "Content",
              "text": " "
            }
          ],
          "releaseTag": "Public",
          "name": "HealthBindings",
          "members": [
            {
              "kind": "Variable",
              "canonicalReference": "@loopback/extension-health!HealthBindings.COMPONENT:var",
              "docComment": "",
              "excerptTokens": [
                {
                  "kind": "Reference",
                  "text": "COMPONENT"
                },
                {
                  "kind": "Content",
                  "text": ": "
                },
                {
                  "kind": "Reference",
                  "text": "BindingKey"
                },
                {
                  "kind": "Content",
                  "text": "<"
                },
                {
                  "kind": "Reference",
                  "text": "HealthComponent"
                },
                {
                  "kind": "Content",
                  "text": ">"
                }
              ],
              "releaseTag": "Public",
              "name": "COMPONENT",
              "variableTypeTokenRange": {
                "startIndex": 2,
                "endIndex": 6
              }
            },
            {
              "kind": "Variable",
              "canonicalReference": "@loopback/extension-health!HealthBindings.CONFIG:var",
              "docComment": "",
              "excerptTokens": [
                {
                  "kind": "Reference",
                  "text": "CONFIG"
                },
                {
                  "kind": "Content",
                  "text": ": "
                },
                {
                  "kind": "Content",
                  "text": "import(\"@loopback/core\")."
                },
                {
                  "kind": "Reference",
                  "text": "BindingAddress"
                },
                {
                  "kind": "Content",
                  "text": "<"
                },
                {
                  "kind": "Reference",
                  "text": "Partial"
                },
                {
                  "kind": "Content",
                  "text": "<import(\"./types\")."
                },
                {
                  "kind": "Reference",
                  "text": "HealthOptions"
                },
                {
                  "kind": "Content",
                  "text": ">>"
                }
              ],
              "releaseTag": "Public",
              "name": "CONFIG",
              "variableTypeTokenRange": {
                "startIndex": 2,
                "endIndex": 9
              }
            },
            {
              "kind": "Variable",
              "canonicalReference": "@loopback/extension-health!HealthBindings.HEALTH_CHECKER:var",
              "docComment": "",
              "excerptTokens": [
                {
                  "kind": "Reference",
                  "text": "HEALTH_CHECKER"
                },
                {
                  "kind": "Content",
                  "text": ": "
                },
                {
                  "kind": "Reference",
                  "text": "BindingKey"
                },
                {
                  "kind": "Content",
                  "text": "<"
                },
                {
                  "kind": "Reference",
                  "text": "HealthChecker"
                },
                {
                  "kind": "Content",
                  "text": ">"
                }
              ],
              "releaseTag": "Public",
              "name": "HEALTH_CHECKER",
              "variableTypeTokenRange": {
                "startIndex": 2,
                "endIndex": 6
              }
            }
          ]
        },
        {
          "kind": "Class",
          "canonicalReference": "@loopback/extension-health!HealthComponent:class",
          "docComment": "/**\n * A component providing health status\n */\n",
          "excerptTokens": [
            {
              "kind": "Content",
              "text": "export declare class "
            },
            {
              "kind": "Reference",
              "text": "HealthComponent"
            },
            {
              "kind": "Content",
              "text": " implements "
            },
            {
              "kind": "Reference",
              "text": "Component"
            },
            {
              "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("
                },
                {
                  "kind": "Reference",
                  "text": "application"
                },
                {
                  "kind": "Content",
                  "text": ": "
                },
                {
                  "kind": "Reference",
                  "text": "Application"
                },
                {
                  "kind": "Content",
                  "text": ", "
                },
                {
                  "kind": "Reference",
                  "text": "healthConfig"
                },
                {
                  "kind": "Content",
                  "text": "?: "
                },
                {
                  "kind": "Reference",
                  "text": "HealthConfig"
                },
                {
                  "kind": "Content",
                  "text": ");"
                }
              ],
              "releaseTag": "Public",
              "overloadIndex": 1,
              "parameters": [
                {
                  "parameterName": "application",
                  "parameterTypeTokenRange": {
                    "startIndex": 3,
                    "endIndex": 4
                  }
                },
                {
                  "parameterName": "healthConfig",
                  "parameterTypeTokenRange": {
                    "startIndex": 7,
                    "endIndex": 8
                  }
                }
              ]
            }
          ],
          "implementsTokenRanges": [
            {
              "startIndex": 3,
              "endIndex": 5
            }
          ]
        },
        {
          "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 "
            },
            {
              "kind": "Reference",
              "text": "HealthConfig"
            },
            {
              "kind": "Content",
              "text": " = "
            },
            {
              "kind": "Reference",
              "text": "Partial"
            },
            {
              "kind": "Content",
              "text": "<"
            },
            {
              "kind": "Reference",
              "text": "HealthOptions"
            },
            {
              "kind": "Content",
              "text": ">"
            },
            {
              "kind": "Content",
              "text": ";"
            }
          ],
          "releaseTag": "Public",
          "name": "HealthConfig",
          "typeTokenRange": {
            "startIndex": 3,
            "endIndex": 7
          }
        },
        {
          "kind": "TypeAlias",
          "canonicalReference": "@loopback/extension-health!HealthOptions:type",
          "docComment": "/**\n * Options for health component\n */\n",
          "excerptTokens": [
            {
              "kind": "Content",
              "text": "export declare type "
            },
            {
              "kind": "Reference",
              "text": "HealthOptions"
            },
            {
              "kind": "Content",
              "text": " = "
            },
            {
              "kind": "Content",
              "text": "{\n    "
            },
            {
              "kind": "Reference",
              "text": "disabled"
            },
            {
              "kind": "Content",
              "text": "?: boolean;\n    "
            },
            {
              "kind": "Reference",
              "text": "healthPath"
            },
            {
              "kind": "Content",
              "text": ": string;\n    "
            },
            {
              "kind": "Reference",
              "text": "readyPath"
            },
            {
              "kind": "Content",
              "text": ": string;\n    "
            },
            {
              "kind": "Reference",
              "text": "livePath"
            },
            {
              "kind": "Content",
              "text": ": string;\n}"
            },
            {
              "kind": "Content",
              "text": ";"
            }
          ],
          "releaseTag": "Public",
          "name": "HealthOptions",
          "typeTokenRange": {
            "startIndex": 3,
            "endIndex": 12
          }
        },
        {
          "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 "
            },
            {
              "kind": "Reference",
              "text": "HealthTags"
            },
            {
              "kind": "Content",
              "text": " "
            }
          ],
          "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": "Reference",
                  "text": "LIVE_CHECK"
                },
                {
                  "kind": "Content",
                  "text": " = \"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": "Reference",
                  "text": "READY_CHECK"
                },
                {
                  "kind": "Content",
                  "text": " = \"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 "
            },
            {
              "kind": "Reference",
              "text": "LiveCheck"
            },
            {
              "kind": "Content",
              "text": " = "
            },
            {
              "kind": "Content",
              "text": "() => "
            },
            {
              "kind": "Reference",
              "text": "Promise"
            },
            {
              "kind": "Content",
              "text": "<void>"
            },
            {
              "kind": "Content",
              "text": ";"
            }
          ],
          "releaseTag": "Public",
          "name": "LiveCheck",
          "typeTokenRange": {
            "startIndex": 3,
            "endIndex": 6
          }
        },
        {
          "kind": "TypeAlias",
          "canonicalReference": "@loopback/extension-health!ReadyCheck:type",
          "docComment": "/**\n * Functions for readiness check\n */\n",
          "excerptTokens": [
            {
              "kind": "Content",
              "text": "export declare type "
            },
            {
              "kind": "Reference",
              "text": "ReadyCheck"
            },
            {
              "kind": "Content",
              "text": " = "
            },
            {
              "kind": "Content",
              "text": "() => "
            },
            {
              "kind": "Reference",
              "text": "Promise"
            },
            {
              "kind": "Content",
              "text": "<void>"
            },
            {
              "kind": "Content",
              "text": ";"
            }
          ],
          "releaseTag": "Public",
          "name": "ReadyCheck",
          "typeTokenRange": {
            "startIndex": 3,
            "endIndex": 6
          }
        }
      ]
    }
  ]
}