Applesauce
    Preparing search index...

    Type Alias SyncLoadRequest

    A request to load a set of events from a set of relays

    type SyncLoadRequest = {
        authRetries?: number;
        authTimeout?: number | false;
        concurrency?: number;
        filter: Filter;
        limit?: number;
        onAuthRequired?: SyncAuthHandler;
        relays: string[] | Observable<string[]>;
        timeout?: number | false;
        waitForAuth?: SyncAuthRequirement;
    }
    Index
    authRetries?: number

    The number of consecutive auth-required cycles to tolerate before giving up, owned by the relay layer.

    1
    
    authTimeout?: number | false

    The maximum time (in milliseconds) to wait for a single auth phase (handler execution plus the subsequent authentication wait), owned by the relay layer. Pass false to wait indefinitely for external auth state.

    30000
    
    concurrency?: number

    The max number of relays to load from concurrently (default 10)

    filter: Filter

    The filter describing the set of events to load (NIP-77 reconciles a single filter)

    limit?: number

    The page size for paginated REQ loading on relays without NIP-77 (default 500)

    onAuthRequired?: SyncAuthHandler

    Called when a relay signals that authentication is required, for both the negentropy sync and the paginated request path identically (RAUTH-08)

    relays: string[] | Observable<string[]>

    The relays to load from, or an observable of relay lists that starts added relays and stops removed ones

    an observable keeps the load open until it completes

    timeout?: number | false

    The max time in ms a single relay may take to make progress before it is errored: the time to the first event, and the time between events. This bounds offline or unresponsive relays so the loader always completes. A negentropy sync that times out falls back to a paginated request. Pass false to disable.

    30000
    
    waitForAuth?: SyncAuthRequirement

    What authentication to wait for when a relay requires NIP-42 auth for reading. A relay that responds with auth-required waits for authentication and retries both the negentropy sync and the paginated request. true (the default) waits for any authenticated user, a pubkey (or array of pubkeys) waits until those specific users are authenticated, and false disables waiting so an auth-required relay errors instead.

    true