Class HealthCheck

A health check response.

Hierarchy

Constructors

constructor

Properties

attribute_map data dbAvailable errors isMigrating message round version

Methods

get_obj_for_encoding from_obj_for_encoding

Constructors

constructor

  • Creates a new HealthCheck object.

    Parameters

    • __namedParameters: { data?: Record<string, any>; dbAvailable: boolean; errors?: string[]; isMigrating: boolean; message: string; round: number | bigint; version: string }
      • Optional data?: Record<string, any>
      • dbAvailable: boolean
      • Optional errors?: string[]
      • isMigrating: boolean
      • message: string
      • round: number | bigint
      • version: string

    Returns indexerModels.HealthCheck

Properties

attribute_map

attribute_map: Record<string, string>

Optional data

data?: Record<string, any>

dbAvailable

dbAvailable: boolean

Optional errors

errors?: string[]

isMigrating

isMigrating: boolean

message

message: string

round

round: number | bigint

version

version: string

Current version.

Methods

get_obj_for_encoding

  • Get an object ready for encoding to either JSON or msgpack.

    Parameters

    • binary: boolean = false

      Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON.

    Returns Record<string, any>

Static from_obj_for_encoding

Settings

Member Visibility

Theme

Generated using TypeDoc