Class: Health

health.Health(status, details)

Carry information about the health of a component.

Constructor

new Health(status, details)

Creates a new health object.

Parameters:
Name Type Description
status Status

The status of the health.
details Record.<string, *>

The details of the health.

Members

(nullable) details :Record.<string, *>

The details of the health.

Type:
  • Record.<string, *>

status :Status

The status of the health.

Type:
  • Status

Methods

(static) down(options)

Creates a new health object with status Status.DOWN.

Parameters:
Name Type Description
options object

The health options.

Properties
Name Type Attributes Description
details Record.<string, *> <optional>

The details of the health.
error Error <optional>

The error of the health.

(static) outOfService(options)

Creates a new health object with status Status.OUT_OF_SERVICE.

Parameters:
Name Type Description
options object

The health options.

Properties
Name Type Attributes Description
details Record.<string, *> <optional>

The details of the health.

(static) status(options)

Creates a new health object.

Parameters:
Name Type Description
options object

The health options.

Properties
Name Type Attributes Description
status Status

The status of the health.
details Record.<string, *> <optional>

The details of the health.
error Error <optional>

The error of the health.

(static) unknown(options)

Creates a new health object with status Status.UNKNOWN.

Parameters:
Name Type Description
options object

The health options.

Properties
Name Type Attributes Description
details Record.<string, *> <optional>

The details of the health.

(static) up(options)

Creates a new health object with status Status.UP.

Parameters:
Name Type Description
options object

The health options.

Properties
Name Type Attributes Description
details Record.<string, *> <optional>

The details of the health.