Class RelayGroup

Implements

IGroup

Index

Constructors

Properties

Methods

event mergeEOSE publish req request subscription

Constructors

constructor

new RelayGroup(relays: IRelay[]): RelayGroup
Parameters
- relays: IRelay[]
Returns RelayGroup
- Defined in packages/relay/src/group.ts:19

Properties

relays

relays: IRelay[]

Methods

event

event(event: Event): Observable<PublishResponse>
Send an event to all relays
Parameters
- event: Event
Returns Observable<PublishResponse>
Implementation of IGroup.event
- Defined in packages/relay/src/group.ts:52

`Protected`mergeEOSE

mergeEOSE(
...requests: Observable<SubscriptionResponse>[],
): Observable<Event | "EOSE">
Takes an array of observables and only emits EOSE when all observables have emitted EOSE
Parameters
- ...requests: Observable<SubscriptionResponse>[]
Returns Observable<Event | "EOSE">
- Defined in packages/relay/src/group.ts:22

publish

publish(event: Event, opts?: PublishOptions): Observable<PublishResponse>
Publish an event to all relays with retries ( default 3 retries )
Parameters
- event: Event
- Optionalopts: PublishOptions
Returns Observable<PublishResponse>
Implementation of IGroup.publish
- Defined in packages/relay/src/group.ts:66

req

req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>
Make a request to all relays
Parameters
- filters: FilterInput
- id: string = ...
Returns Observable<SubscriptionResponse>
Implementation of IGroup.req
- Defined in packages/relay/src/group.ts:39

request

request(filters: FilterInput, opts?: RequestOptions): Observable<Event>
Request events from all relays with retries ( default 3 retries )
Parameters
- filters: FilterInput
- Optionalopts: RequestOptions
Returns Observable<Event>
Implementation of IGroup.request
- Defined in packages/relay/src/group.ts:80

subscription

subscription(
filters: FilterInput,
opts?: SubscriptionOptions,
): Observable<SubscriptionResponse>
Open a subscription to all relays with retries ( default 3 retries )
Parameters
- filters: FilterInput
- Optionalopts: SubscriptionOptions
Returns Observable<SubscriptionResponse>
Implementation of IGroup.subscription
- Defined in packages/relay/src/group.ts:92