Documentation
    Preparing search index...

    Interface RelayPoolLike

    Minimal relay pool interface that the shell requires.

    interface RelayPoolLike {
        count?(
            relayUrls: string[],
            filters: NostrFilter[],
        ): number | Promise<number>;
        publish(relayUrls: string[], event: any): void | Promise<void>;
        request(
            relayUrls: string[],
            filters: any,
        ): {
            subscribe(
                observer: {
                    complete: () => void;
                    error: () => void;
                    next: (event: unknown) => void;
                },
            ): { unsubscribe(): void };
        };
        subscription(
            relayUrls: string[],
            filters: any,
        ): {
            subscribe(observer: (item: unknown) => void): { unsubscribe(): void };
        };
    }
    Index

    Methods

    count? publish request subscription

    Methods

    • Optional exact/approximate count support that does not return event payloads.

      Parameters

      Returns number | Promise<number>

    • Parameters

      • relayUrls: string[]
      • event: any

      Returns void | Promise<void>

    • Parameters

      • relayUrls: string[]
      • filters: any

      Returns {
          subscribe(
              observer: {
                  complete: () => void;
                  error: () => void;
                  next: (event: unknown) => void;
              },
          ): { unsubscribe(): void };
      }

    • Parameters

      • relayUrls: string[]
      • filters: any

      Returns { subscribe(observer: (item: unknown) => void): { unsubscribe(): void } }

    Settings

    Member Visibility

    On This Page

    Methods