Improve docs to highlight query+filter

This commit is contained in:
Simon Warta 2020-08-18 09:15:08 +02:00
parent 9955ec0dbe
commit b94d130c84
2 changed files with 8 additions and 2 deletions

View File

@ -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 = {

View File

@ -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>;
/**