Type Alias SyncMethodOptions

Per-relay options threaded through the request and sync methods

type SyncMethodOptions = {
    authRetries?: number;
    authTimeout?: number | false;
    batchSize?: number;
    onAuthRequired?: SyncAuthHandler;
    waitForAuth?: SyncAuthRequirement;
}

Properties

authRetries?: number

The number of consecutive auth-required cycles to tolerate before giving up

authTimeout?: number | false

The maximum time (in milliseconds) to wait for a single auth phase, or false to wait indefinitely

batchSize?: number

The max number of missing event ids a negentropy sync requests in a single REQ

onAuthRequired?: SyncAuthHandler

Called when the relay signals that authentication is required for this operation