Class RelayGroup

Implements

IGroup

Index

Constructors

Properties

Methods

event mergeEOSE negentropy publish req request subscription sync

Constructors

constructor

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

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:103

`Protected`mergeEOSE

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

negentropy

negentropy(
    store: IEventStoreRead | IAsyncEventStoreRead | Event[],
    filter: Filter,
    reconcile: ReconcileFunction,
    opts?: GroupNegentropySyncOptions,
): Promise<boolean>
Negentropy sync events with the relays and an event store
Parameters
- store: IEventStoreRead | IAsyncEventStoreRead | Event[]
- filter: Filter
- reconcile: ReconcileFunction
- Optionalopts: GroupNegentropySyncOptions
Returns Promise<boolean>
Implementation of IGroup.negentropy
- Defined in packages/relay/src/group.ts:117

publish

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

req

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

request

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

subscription

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

sync

sync(
    store: IEventStoreRead | IAsyncEventStoreRead | Event[],
    filter: Filter,
    direction?: SyncDirection,
): Observable<Event>
Negentropy sync events with the relays and an event store
Parameters
- store: IEventStoreRead | IAsyncEventStoreRead | Event[]
- filter: Filter
- Optionaldirection: SyncDirection
Returns Observable<Event>
Implementation of IGroup.sync
- Defined in packages/relay/src/group.ts:179