Improve docs to highlight query+filter
This commit is contained in:
parent
9955ec0dbe
commit
b94d130c84
@ -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<responses.BlockchainResponse> {
|
||||
const query: requests.BlockchainRequest = {
|
||||
|
||||
5
packages/tendermint-rpc/types/client.d.ts
vendored
5
packages/tendermint-rpc/types/client.d.ts
vendored
@ -16,7 +16,10 @@ export declare class Client {
|
||||
block(height?: number): Promise<responses.BlockResponse>;
|
||||
blockResults(height?: number): Promise<responses.BlockResultsResponse>;
|
||||
/**
|
||||
* 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<responses.BlockchainResponse>;
|
||||
/**
|
||||
|
||||
Loading…
Reference in New Issue
Block a user