Class RelayGroup

Implements

IGroup

Index

Constructors

constructor

new RelayGroup(relays: IGroupRelayInput): RelayGroup
Parameters
- relays: IGroupRelayInput
Returns RelayGroup
- Defined in packages/relay/src/group.ts:87

Properties

`Protected`relays$

relays$: Observable<IRelay[]> | BehaviorSubject<IRelay[]> = ...

Accessors

relays

get relays(): IRelay[]
Returns IRelay[]
- Defined in packages/relay/src/group.ts:82

Methods

add

add(relay: IRelay): void
Add a relay to the group
Parameters
- relay: IRelay
Returns void
Implementation of IGroup.add
- Defined in packages/relay/src/group.ts:105

count

count(
filters: Filter | Filter[],
id?: string,
): Observable<Record<string, CountResponse>>
Count events on all relays in the group
Parameters
- filters: Filter | Filter[]
- id: string = ...
Returns Observable<Record<string, CountResponse>>
Implementation of IGroup.count
- Defined in packages/relay/src/group.ts:302

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

has

has(relay: string | IRelay): boolean
Check if a relay is in the group
Parameters
- relay: string | IRelay
Returns boolean
Implementation of IGroup.has
- Defined in packages/relay/src/group.ts:97

`Protected`internalPublish

internalPublish(
project: (relay: IRelay) => Observable<PublishResponse>,
): Observable<PublishResponse>
Internal logic for handling publishes to multiple relays
Parameters
- project: (relay: IRelay) => Observable<PublishResponse>
Returns Observable<PublishResponse>
- Defined in packages/relay/src/group.ts:190

`Protected`internalSubscription

internalSubscription(
project: (relay: IRelay) => Observable<SubscriptionResponse>,
eventOperator?: MonoTypeOperatorFunction<Event>,
): Observable<SubscriptionResponse>
Internal logic for handling requests to multiple relays
Parameters
- project: (relay: IRelay) => Observable<SubscriptionResponse>
- eventOperator: MonoTypeOperatorFunction<Event> = identity
Returns Observable<SubscriptionResponse>
- Defined in packages/relay/src/group.ts:117

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

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

remove

remove(relay: IRelay): void
Remove a relay from the group
Parameters
- relay: IRelay
Returns void
Implementation of IGroup.remove
- Defined in packages/relay/src/group.ts:111

req

req(
    filters: FilterInput,
    id?: string,
    opts?: { eventStore?: IEventStoreActions | IAsyncEventStoreActions | null },
): Observable<SubscriptionResponse>
Make a request to all relays
Parameters
- filters: FilterInput
- id: string = ...
- Optionalopts: { eventStore?: IEventStoreActions | IAsyncEventStoreActions | null }
  - OptionaleventStore?: IEventStoreActions | IAsyncEventStoreActions | null
    Deduplicate events with an event store (default is a temporary instance of EventMemory), null will disable deduplication
Returns Observable<SubscriptionResponse>
Note
This does not deduplicate events
Implementation of IGroup.req
- Defined in packages/relay/src/group.ts:226

request

request(filters: FilterInput, opts?: GroupRequestOptions): Observable<Event>
Request events from all relays and complete on EOSE
Parameters
- filters: FilterInput
- Optionalopts: GroupRequestOptions
Returns Observable<Event>
Implementation of IGroup.request
- Defined in packages/relay/src/group.ts:277

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

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

Class RelayGroup

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RelayGroup

Properties

Protectedrelays$

Accessors

relays

Returns IRelay[]

Methods

add

Parameters

Returns void

count

Parameters

Returns Observable<Record<string, CountResponse>>

event

Parameters

Returns Observable<PublishResponse>

has

Parameters

Returns boolean

ProtectedinternalPublish

Parameters

Returns Observable<PublishResponse>

ProtectedinternalSubscription

Parameters

Returns Observable<SubscriptionResponse>

negentropy

Parameters

Returns Promise<boolean>

publish

Parameters

Returns Promise<PublishResponse[]>

remove

Parameters

Returns void

req

Parameters

OptionaleventStore?: IEventStoreActions | IAsyncEventStoreActions | null

Returns Observable<SubscriptionResponse>

Note

request

Parameters

Returns Observable<Event>

subscription

Parameters

Returns Observable<SubscriptionResponse>

sync

Parameters

Returns Observable<Event>

Settings

On This Page

`Protected`relays$

`Protected`internalPublish

`Protected`internalSubscription

`Optional`eventStore?: IEventStoreActions | IAsyncEventStoreActions | null