Class: Status

health.Status(code)

Express state of a component.

Constructor

new Status(code)

Creates a new status.

Parameters:
Name Type Description
code string

The status code.

Members

DOWN :Status

Indicates the component has suffered an unexpected failure.

Type:
  • Status

OUT_OF_SERVICE :Status

Indicates the component has been taken out of service and should not be used.

Type:
  • Status

UNKNOWN :Status

Indicates the component is in an unknown state.

Type:
  • Status

UP :Status

Indicates the component is functioning as expected

Type:
  • Status

Methods

toJSON() → {string}

Returns the status code.

Returns:

The status code.

Type
string

toString() → {string}

Returns a string representation of the status.

Returns:

The status code.

Type
string

valueOf() → {string}

Returns the value of the status.

Returns:

The status code.

Type
string