Skip to content
On this page

Function: relayMaxLimit()

TypeScript
function relayMaxLimit(url: string, timeoutMs?: number): Promise<number | undefined>;

Defined in: pages.ts:358 (opens in a new tab)

The max_limit relay url's NIP-11 document declares, or undefined when it declares none or the document cannot be read. A redirect is not followed: it is a document that cannot be read. A declared limit is kept for the life of the process; a failed read is tried again next time.

ParametersLink to this section

ParameterTypeDefault
urlstringDefault undefined
timeoutMsnumberDefault 3000

ReturnsLink to this section

Promise<number | undefined>