From b94d130c84ce02bf218dcc8b487b43cfe19b4ec5 Mon Sep 17 00:00:00 2001 From: Simon Warta Date: Tue, 18 Aug 2020 09:15:08 +0200 Subject: [PATCH] Improve docs to highlight query+filter --- packages/tendermint-rpc/src/client.ts | 5 ++++- packages/tendermint-rpc/types/client.d.ts | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/packages/tendermint-rpc/src/client.ts b/packages/tendermint-rpc/src/client.ts index 9bda89ea..b5845a75 100644 --- a/packages/tendermint-rpc/src/client.ts +++ b/packages/tendermint-rpc/src/client.ts @@ -75,7 +75,10 @@ export class Client { } /** - * Get block headers for minHeight <= height <= maxHeight. + * Queries block headers filtered by minHeight <= height <= maxHeight. + * + * @param minHeight The minimum height to be included in the result. Defaults to 0. + * @param maxHeight The maximum height to be included in the result. Defaults to infinity. */ public async blockchain(minHeight?: number, maxHeight?: number): Promise { const query: requests.BlockchainRequest = { diff --git a/packages/tendermint-rpc/types/client.d.ts b/packages/tendermint-rpc/types/client.d.ts index 5844ad64..92606f94 100644 --- a/packages/tendermint-rpc/types/client.d.ts +++ b/packages/tendermint-rpc/types/client.d.ts @@ -16,7 +16,10 @@ export declare class Client { block(height?: number): Promise; blockResults(height?: number): Promise; /** - * Get block headers for minHeight <= height <= maxHeight. + * Queries block headers filtered by minHeight <= height <= maxHeight. + * + * @param minHeight The minimum height to be included in the result. Defaults to 0. + * @param maxHeight The maximum height to be included in the result. Defaults to infinity. */ blockchain(minHeight?: number, maxHeight?: number): Promise; /**