Function readiness

readiness<chain extends undefined | Chain>(
client: { extend: <const client extends { [key: string]: unknown }>(fn: (client: { extend: ... }) => client) => { [K in (...) | (...) | (...)]: (...)[(...)] } },
params: ReadinessParameters,
): Promise<ReadinessReturnType>
Returns the last evaluation of the startup health check results. This indicates if the node has finished initializing and is ready to handle requests.
- Docs: https://build.avax.network/docs/api-reference/health-api#healthreadiness
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: ReadinessParameters
  Optional tags to filter readiness checks. ReadinessParameters
Returns Promise<ReadinessReturnType>
The readiness check results. ReadinessReturnType
Example
```
import { createAvalancheCoreClient } from '@avalanche-sdk/client'
import { avalanche } from '@avalanche-sdk/client/chains'
import { readiness } from '@avalanche-sdk/client/methods/health'

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

const readinessStatus = await readiness(client, {
  tags: ["11111111111111111111111111111111LpoYY"]
})
```
- Defined in src/methods/health/readiness.ts:38