AppleSauce
    Preparing search index...

    Interface IPool

    interface IPool {
        event(relays: string[], event: Event): Observable<PublishResponse>;
        group(relays: string[]): IGroup;
        publish(
            relays: string[],
            event: Event,
            opts?: { retries?: number },
        ): Promise<PublishResponse[]>;
        relay(url: string): IRelay;
        remove(relay: string | IRelay, close?: boolean): void;
        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

    Index

    Methods

    event group publish relay remove req request subscription

    Methods

    • Send an EVENT message to relays with retries

      Parameters

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

      Returns Promise<PublishResponse[]>

    • Removes a relay from the pool and defaults to closing the connection

      Parameters

      • relay: string | IRelay
      • Optionalclose: boolean

      Returns void

    • Send a REQ message to relays with retries

      Parameters

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

      Returns Observable<Event>

    Settings

    Member Visibility

    On This Page

    Methods