Class FeedClient<T>

A class to iterate through to a Fauna event feed.

Type Parameters

T extends QueryValue = any

Index

Constructors

Methods

[asyncIterator] flatten nextPage

Constructors

constructor

new FeedClient<T>(token, clientConfiguration): FeedClient<T>
Type Parameters
- T extends QueryValue = any
Parameters
- token: EventSource | (() => Promise<EventSource>)
  A lambda that returns a promise for a EventSource
- clientConfiguration: FeedClientConfiguration
  The FeedClientConfiguration to apply
Returns FeedClient<T>
Example
```
 const feed = client.feed(eventSource);
```
- Defined in src/client.ts:957

Methods

[asyncIterator]

[asyncIterator](): AsyncGenerator<FeedPage<T>, any, unknown>
Returns AsyncGenerator<FeedPage<T>, any, unknown>
- Defined in src/client.ts:1020

flatten

flatten(): AsyncGenerator<StreamEventData<T>, any, unknown>
Returns an async generator that yields the events of the event feed directly.

Returns AsyncGenerator<StreamEventData<T>, any, unknown>
Example
```
 const feed = client.feed(fql`MyCollection.all().eventSource()`)

 for await (const user of feed.flatten()) {
   // do something with each event
 }
```
- Defined in src/client.ts:1081

nextPage

nextPage(): Promise<FeedPage<T>>
Fetches the next page of the event feed. If there are no more pages to fetch, this method will throw a ClientError.

Returns Promise<FeedPage<T>>
- Defined in src/client.ts:1030