Class HealthCheck

constructor

• new HealthCheck(__namedParameters): HealthCheck

• Creates a new HealthCheck object.

  Parameters

  • __namedParameters: {
        data?: UntypedValue;
        dbAvailable: boolean;
        errors?: string[];
        isMigrating: boolean;
        message: string;
        round: number | bigint;
        version: string;
    }

    • Optional data?: UntypedValue

    • dbAvailable: boolean

    • Optional errors?: string[]

    • isMigrating: boolean

    • message: string

    • round: number | bigint

    • version: string

  Returns HealthCheck

Optional data

dbAvailable

Optional errors

isMigrating

message

round

version

Static encodingSchema

• get encodingSchema(): Schema

• Returns Schema

getEncodingSchema

• getEncodingSchema(): Schema

• Get the encoding Schema for this object, used to prepare the encoding data for msgpack and JSON.

  Returns Schema

toEncodingData

• toEncodingData(): Map<string, unknown>

• Extract the encoding data for this object. This data, after being prepared by the encoding Schema, can be encoded to msgpack or JSON.

  Returns Map<string, unknown>

Static fromEncodingData

• fromEncodingData(data): HealthCheck

• Parameters

  • data: unknown

  Returns HealthCheck