tendermint-rpc: Fix doc comments in 34 client

This commit is contained in:
willclarktech 2021-06-08 16:16:18 +02:00
parent c676ba68a3
commit 14dd92e850
No known key found for this signature in database
GPG Key ID: 551A86E2E398ADF7

View File

@ -19,8 +19,6 @@ export class Tendermint34Client {
* Creates a new Tendermint client for the given endpoint.
*
* Uses HTTP when the URL schema is http or https. Uses WebSockets otherwise.
*
* If the adaptor is not set an auto-detection is attempted.
*/
public static async connect(url: string): Promise<Tendermint34Client> {
const useHttp = url.startsWith("http://") || url.startsWith("https://");
@ -30,8 +28,6 @@ export class Tendermint34Client {
/**
* Creates a new Tendermint client given an RPC client.
*
* If the adaptor is not set an auto-detection is attempted.
*/
public static async create(rpcClient: RpcClient): Promise<Tendermint34Client> {
// For some very strange reason I don't understand, tests start to fail on some systems
@ -63,7 +59,7 @@ export class Tendermint34Client {
private readonly r: Responses;
/**
* Use `Client.connect` or `Client.create` to create an instance.
* Use `Tendermint34Client.connect` or `Tendermint34Client.create` to create an instance.
*/
private constructor(client: RpcClient) {
this.client = client;