Documentation
    Preparing search index...

    Interface RelayPoolServiceOptions

    Options for creating a relay pool service.

    const relayPoolService = createRelayPoolService({
      subscribe: (filters, cb, urls) => myPool.subscribe(filters, cb, urls),
      publish: (event) => myPool.publish(event),
      selectRelayTier: (filters) => myPool.selectRelays(filters),
      isAvailable: () => myPool.connected,
    });
    interface RelayPoolServiceOptions {
        isAvailable(): boolean;
        publish(event: NostrEvent): void;
        selectRelayTier(filters: NostrFilter[]): string[];
        subscribe(
            filters: NostrFilter[],
            callback: (item: NostrEvent | "EOSE") => void,
            relayUrls?: string[],
        ): { unsubscribe(): void };
    }
    Index

    Methods

    isAvailable publish selectRelayTier subscribe

    Methods

    • Subscribe to events matching filters. Returns handle with unsubscribe().

      Parameters

      • filters: NostrFilter[]

        NIP-01 filter objects

      • callback: (item: NostrEvent | "EOSE") => void

        Receives matching events or 'EOSE'

      • OptionalrelayUrls: string[]

        Optional relay URL hints

      Returns { unsubscribe(): void }

      Handle to cancel the subscription

    Settings

    Member Visibility

    On This Page

    Methods