AppleSauce
    Preparing search index...

    Interface IPool

    Signals emitted by the pool

    interface IPool {
        add$: Observable<IRelay>;
        remove$: Observable<IRelay>;
        event(relays: string[], event: Event): Observable<PublishResponse>;
        group(relays: string[]): IGroup;
        negentropy(
            relays: string[],
            store: IEventStoreRead | IAsyncEventStoreRead | Event[],
            filter: Filter,
            reconcile: ReconcileFunction,
            opts?: GroupNegentropySyncOptions,
        ): Promise<boolean>;
        publish(
            relays: string[],
            event: Event,
            opts?: PublishOptions,
        ): 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?: GroupRequestOptions,
        ): Observable<Event>;
        subscription(
            relays: string[],
            filters: FilterInput,
            opts?: GroupSubscriptionOptions,
        ): Observable<SubscriptionResponse>;
        sync(
            relays: string[],
            store: IEventStoreRead | IAsyncEventStoreRead | Event[],
            filter: Filter,
            direction?: SyncDirection,
        ): Observable<Event>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    add$ remove$

    Methods

    event group negentropy publish relay remove req request subscription sync

    Properties

    add$: Observable<IRelay>
    remove$: Observable<IRelay>

    Methods

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

      Parameters

      • relay: string | IRelay
      • Optionalclose: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods