Skip to content

Commit 5e50cde

Browse files
committed
Updated doc
1 parent 2383706 commit 5e50cde

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/infrastructure/BlockHttp.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@ import {QueryParams} from './QueryParams';
3636
import { CreateStatementFromDTO } from './receipt/CreateReceiptFromDTO';
3737
import {CreateTransactionFromDTO, extractBeneficiary} from './transaction/CreateTransactionFromDTO';
3838

39+
/**
40+
* Blocks returned limits:
41+
* N_25: 25 blocks.
42+
* N_50: 50 blocks.
43+
* N_75: 75 blocks.
44+
* N_100: 100 blocks.
45+
*/
3946
export enum LimitType {
4047
N_25 = 25,
4148
N_50 = 50,
@@ -120,7 +127,7 @@ export class BlockHttp extends Http implements BlockRepository {
120127
/**
121128
* Gets array of BlockInfo for a block height with limit
122129
* @param height - Block height from which will be the first block in the array
123-
* @param limit - Number of blocks returned
130+
* @param limit - Number of blocks returned. Limit value only available in 25, 50. 75 and 100. (default 25)
124131
* @returns Observable<BlockInfo[]>
125132
*/
126133
public getBlocksByHeightWithLimit(height: number, limit: LimitType = LimitType.N_25): Observable<BlockInfo[]> {

0 commit comments

Comments
 (0)