Function NodesApiFp

  • NodesApiFp(configuration?): {
        node(address, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<Node>)>;
        nodes(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<NodesResponse>)>;
    }

  • NodesApi - functional programming interface

    Parameters

    Returns {
        node(address, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<Node>)>;
        nodes(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<NodesResponse>)>;
    }

    • node:function
      • node(address, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<Node>)>

      • Returns node information for the provided node address.

        Parameters

        • address: string
        • Optional height: number

          optional block height, defaults to current tip

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<Node>)>

        Throws

    • nodes:function

    Export

Settings

Member Visibility

Theme

Generated using TypeDoc