Interface SyncLoaderRelay

The minimal relay interface the sync loader needs (structurally satisfied by applesauce-relay's Relay)

interface SyncLoaderRelay {
    getLimitations?(): Promise<{ max_limit?: number } | null | undefined>;
    getSupported(): Promise<number[] | null>;
    request(
        filters: Filter | Filter[],
        opts?: SyncMethodOptions,
    ): Observable<NostrEvent>;
    sync(
        store: unknown,
        filter: Filter,
        direction?: unknown,
        opts?: SyncMethodOptions,
    ): Observable<SyncResult>;
}

Index

Methods

getLimitations? getSupported request sync

Methods

`Optional`getLimitations

getLimitations?(): Promise<{ max_limit?: number } | null | undefined>
Returns Promise<{ max_limit?: number } | null | undefined>
- Defined in loaders/sync-loader.ts:184

getSupported

getSupported(): Promise<number[] | null>
Returns Promise<number[] | null>
- Defined in loaders/sync-loader.ts:183

request

request(
filters: Filter | Filter[],
opts?: SyncMethodOptions,
): Observable<NostrEvent>
Parameters
- filters: Filter | Filter[]
- Optionalopts: SyncMethodOptions
Returns Observable<NostrEvent>
- Defined in loaders/sync-loader.ts:182

sync

sync(
    store: unknown,
    filter: Filter,
    direction?: unknown,
    opts?: SyncMethodOptions,
): Observable<SyncResult>
Parameters
- store: unknown
- filter: Filter
- Optionaldirection: unknown
- Optionalopts: SyncMethodOptions
Returns Observable<SyncResult>
- Defined in loaders/sync-loader.ts:185