terminus
Entry point exports
Modules
TerminusModule
|
The Terminus module integrates health checks and graceful shutdowns in your Nest application |
Classes
ConnectionNotFoundError
|
Deprecated: This class has been deprecated and will be removed in the next major release.
Instead utilise the Error which gets thrown when the connection instance was not found in the application context |
HealthIndicator
|
Deprecated: This class has been deprecated and will be removed in the next major release.
Instead utilise the Represents an abstract health indicator with common functionalities |
StorageExceededError
|
Deprecated: This class has been deprecated and will be removed in the next major release.
Instead utilise the Error which gets thrown when the given storage threshold has exceeded. |
TimeoutError
|
Deprecated: This class has been deprecated and will be removed in the next major release.
Instead utilise the Gets thrown when the timeout of the health check exceeds |
UnhealthyResponseCodeError
|
Deprecated: This class has been deprecated and will be removed in the next major release.
Instead utilise the Error which gets thrown when the terminus client receives an unhealthy response code from the server. |
Structures
HealthCheckResult
|
The result of a health check |
TerminusModuleOptions
|
The Terminus module options |
Types
DiskHealthIndicatorOptions
|
The options of the disk health indicator |
HealthCheck
|
Marks the endpoint as a Health Check endpoint. |
HealthCheckStatus
|
|
HealthIndicatorFunction
|
A health indicator function for a health check |
HealthIndicatorResult
|
The result object of a health indicator |
HealthIndicatorStatus
|