Function getStatus

  • getStatus(payload): Promise<{
        components: {
            chain: {
                detail?: null | string;
                status: string;
            };
            network: {
                detail?: null | string;
                status: string;
            };
            transport: {
                detail?: null | string;
                status: string;
            };
        };
        nodeState: string;
        overall: string;
    }>

  • Parameters

    • payload: {
          apiEndpoint: string | URL;
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: string | URL

        The API endpoint for authentication.

      • apiToken: string

        The API token for authentication.

      • Optional timeout?: number

        optional timeout for the requests

    Returns Promise<{
        components: {
            chain: {
                detail?: null | string;
                status: string;
            };
            network: {
                detail?: null | string;
                status: string;
            };
            transport: {
                detail?: null | string;
                status: string;
            };
        };
        nodeState: string;
        overall: string;
    }>

Settings

Member Visibility

Theme