Class HealthCheck

healthCheck returns an empty object iff the node is running

Hierarchy

Constructors

constructor

Properties

c intDecoding query

Methods - JSONRequest

doRaw prepare setIntDecoding

Methods - Other

do path

Constructors

constructor

Properties

c

c: HTTPClient

intDecoding

intDecoding: IntDecoding

query

query: Record<string, any>

JSONRequest Methods

doRaw

  • Execute the request, but do not process the response data in any way.

    Returns

    A promise which resolves to the raw response data, exactly as returned by the server.

    Parameters

    • headers: Record<string, any> = {}

      Additional headers to send in the request. Optional.

    Returns Promise<Uint8Array>

prepare

  • Prepare a JSON response before returning it.

    Use this method to change and restructure response data as needed after receiving it from the do() method.

    Parameters

    • body: Uint8Array | Record<string, any>

      Response body received

    Returns Record<string, any>

setIntDecoding

  • Configure how integers in this request's JSON response will be decoded.

    The options are:

    • "default": Integers will be decoded according to JSON.parse, meaning they will all be Numbers and any values greater than Number.MAX_SAFE_INTEGER will lose precision.
    • "safe": All integers will be decoded as Numbers, but if any values are greater than Number.MAX_SAFE_INTEGER an error will be thrown.
    • "mixed": Integers will be decoded as Numbers if they are less than or equal to Number.MAX_SAFE_INTEGER, otherwise they will be decoded as BigInts.
    • "bigint": All integers will be decoded as BigInts.

    Parameters

    • method: IntDecoding

      The method to use when parsing the response for this request. Must be one of "default", "safe", "mixed", or "bigint".

    Returns <internal>.HealthCheck

Other Methods

do

  • Execute the request.

    Returns

    A promise which resolves to the parsed response data.

    Parameters

    • headers: {} = {}

      Additional headers to send in the request. Optional.

      Returns Promise<{}>

    path

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc