Avalanche SDK Client
    Preparing search index...

    Function health

    • Returns the last set of health check results for the node. This includes checks for all chains, network, database, and other components.

      Type Parameters

      • chain extends undefined | Chain

      Parameters

      • client: { extend: <const client extends { [key: string]: unknown }>(fn: (client: { extend: ... }) => client) => { [K in (...) | (...) | (...)]: (...)[(...)] } }

        The client to use. AvalancheCoreClient

      • params: HealthParameters

        Optional tags to filter health checks. HealthParameters

      Returns Promise<HealthReturnType>

      The health check results. HealthReturnType

      import { createAvalancheCoreClient } from '@avalanche-sdk/client'
      import { avalanche } from '@avalanche-sdk/client/chains'
      import { health } from '@avalanche-sdk/client/methods/health'

      const client = createAvalancheCoreClient({
      chain: avalanche,
      transport: {
      type: "http",
      url: "<url>",
      },
      })

      const healthStatus = await health(client, {
      tags: ["11111111111111111111111111111111LpoYY", "29uVeLPJB1eQJkzRemU8g8wZDw5uJRqpab5U2mX9euieVwiEbL"]
      })