Type Alias SyncLoaderMethods

The per-relay functional methods the sync loader uses internally

type SyncLoaderMethods = {
    filterRelays?: (relays: string[]) => string[];
    getMaxLimit?: SyncMaxLimitMethod;
    getSupported: SyncSupportedMethod;
    request: SyncRequestMethod;
    sync: SyncSyncMethod;
}

Index

Properties

filterRelays? getMaxLimit? getSupported request sync

Properties

`Optional`filterRelays

filterRelays?: (relays: string[]) => string[]

Removes relays that should be skipped, they are reported with a "skipped" state

`Optional`getMaxLimit

getMaxLimit?: SyncMaxLimitMethod

Used to fit page and batch sizes under a relay's result cap; without it short pages are not trusted

getSupported

getSupported: SyncSupportedMethod

request

request: SyncRequestMethod

sync

sync: SyncSyncMethod