Interface: PageBounds
Defined in: pages.ts:36 (opens in a new tab)
How far one paged read goes.
PropertiesLink to this section
| Property | Type | Description | Defined in |
|---|---|---|---|
budget? | { left: number; } | REQs left across several reads: each takes one, and a read stops when none is left. | pages.ts:44 (opens in a new tab) |
budget.left | number | pages.ts:44 (opens in a new tab) | |
limit? | number | Events asked for per page; default 500. | pages.ts:38 (opens in a new tab) |
maxEvents? | number | Distinct events read before the read stops; default 2,000. | pages.ts:40 (opens in a new tab) |
maxLimit? | (relay: string) => Promise<number | undefined> | The max_limit a relay's NIP-11 document declares, if any (relayMaxLimit). | pages.ts:46 (opens in a new tab) |
maxPages? | number | REQs made before the read stops, so a relay that sends a few at a time still ends; default 16. | pages.ts:42 (opens in a new tab) |