Interface IPool

interface IPool {
    event(relays: string[], event: Event): Observable<PublishResponse>;
    group(relays: string[]): IGroup;
    publish(
        relays: string[],
        event: Event,
        opts?: { retries?: number },
    ): Observable<PublishResponse>;
    relay(url: string): IRelay;
    req(
        relays: string[],
        filters: FilterInput,
        id?: string,
    ): Observable<SubscriptionResponse>;
    request(
        relays: string[],
        filters: FilterInput,
        opts?: { id?: string; retries?: number },
    ): Observable<Event>;
    subscription(
        relays: string[],
        filters: FilterInput,
        opts?: { id?: string; retries?: number },
    ): Observable<SubscriptionResponse>;
}

Implemented by

Methods

event group publish relay req request subscription

Methods

event

group

publish

  • publish(
        relays: string[],
        event: Event,
        opts?: { retries?: number },
    ): Observable<PublishResponse>

    Send an EVENT message to relays with retries

    Parameters

    • relays: string[]
    • event: Event
    • Optionalopts: { retries?: number }

    Returns Observable<PublishResponse>

relay

req

request

  • request(
        relays: string[],
        filters: FilterInput,
        opts?: { id?: string; retries?: number },
    ): Observable<Event>

    Send a REQ message to relays with retries

    Parameters

    • relays: string[]
    • filters: FilterInput
    • Optionalopts: { id?: string; retries?: number }

    Returns Observable<Event>

subscription

Settings

Member Visibility

On This Page

Methods