SubscriptionEvents
Defined in: relay-sdks/ts/src/subscription-events.ts:32
Single-consumer iterator owning one subscription, never the shared connection.
Extends
Section titled “Extends”AsyncIterableIterator<SubscriptionEvent>
Methods
Section titled “Methods”[asyncIterator]()
Section titled “[asyncIterator]()”[asyncIterator](): AsyncIterableIterator<SubscriptionEvent, any, any>;Defined in: typescript/lib/lib.es2018.asynciterable.d.ts:43
Returns
Section titled “Returns”AsyncIterableIterator<SubscriptionEvent, any, any>
Inherited from
Section titled “Inherited from”AsyncIterableIterator.[asyncIterator]
close()
Section titled “close()”close(): void;Defined in: relay-sdks/ts/src/subscription-events.ts:34
Discard queued events and settle pending reads as EOF. Idempotent.
Returns
Section titled “Returns”void
next()
Section titled “next()”next(...__namedParameters): Promise<IteratorResult<SubscriptionEvent, any>>;Defined in: typescript/lib/lib.es2018.asynciterable.d.ts:30
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
…__namedParameters |
[] | [any] |
Returns
Section titled “Returns”Promise<IteratorResult<SubscriptionEvent, any>>
Inherited from
Section titled “Inherited from”AsyncIterableIterator.next
return()
Section titled “return()”return(): Promise<IteratorResult<SubscriptionEvent, any>>;Defined in: relay-sdks/ts/src/subscription-events.ts:36
Called by for await on break or a throw: discards queued events, cancels the subscription, resolves done.
Returns
Section titled “Returns”Promise<IteratorResult<SubscriptionEvent, any>>
Overrides
Section titled “Overrides”AsyncIterableIterator.return
throw()?
Section titled “throw()?”throw?(e?): Promise<IteratorResult<SubscriptionEvent, any>>;Defined in: typescript/lib/lib.es2018.asynciterable.d.ts:32
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
e? |
any |
Returns
Section titled “Returns”Promise<IteratorResult<SubscriptionEvent, any>>
Inherited from
Section titled “Inherited from”AsyncIterableIterator.throw