Interface IGroup

interface IGroup {
    event(event: Event): Observable<PublishResponse>;
    publish(event: Event, opts?: PublishOptions): Promise<PublishResponse[]>;
    req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
    request(
        filters: FilterInput,
        opts?: SubscriptionOptions,
    ): Observable<Event>;
    subscription(
        filters: FilterInput,
        opts?: SubscriptionOptions,
    ): Observable<SubscriptionResponse>;
}

Implemented by

RelayGroup

Index

Methods

event publish req request subscription

Methods

event

event(event: Event): Observable<PublishResponse>
Send an EVENT message
Parameters
- event: Event
Returns Observable<PublishResponse>
- Defined in packages/relay/src/types.ts:95

publish

publish(event: Event, opts?: PublishOptions): Promise<PublishResponse[]>
Send an EVENT message with retries
Parameters
- event: Event
- Optionalopts: PublishOptions
Returns Promise<PublishResponse[]>
- Defined in packages/relay/src/types.ts:97

req

req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>
Send a REQ message
Parameters
- filters: FilterInput
- Optionalid: string
Returns Observable<SubscriptionResponse>
- Defined in packages/relay/src/types.ts:93

request

request(filters: FilterInput, opts?: SubscriptionOptions): Observable<Event>
Send a REQ message with retries
Parameters
- filters: FilterInput
- Optionalopts: SubscriptionOptions
Returns Observable<Event>
- Defined in packages/relay/src/types.ts:99

subscription

subscription(
filters: FilterInput,
opts?: SubscriptionOptions,
): Observable<SubscriptionResponse>
Open a subscription with retries
Parameters
- filters: FilterInput
- Optionalopts: SubscriptionOptions
Returns Observable<SubscriptionResponse>
- Defined in packages/relay/src/types.ts:101