Interface EventSource

Where a reader reads events again: a store, or the process of a writer (writer).

interface EventSource {
    writer?: number;
    read(
        tree: string,
        after: Position | null,
    ): ReadAnswer<StreamEvent> | Promise<ReadAnswer<StreamEvent>>;
}

Hierarchy (View Summary)

EventSource
- EventStore

Implemented by

Stream

Index

Properties

Methods

Properties

`Optional` `Readonly`writer

writer?: number

The writer whose process this is; absent for a store.

Methods

read

read(
tree: string,
after: Position | null,
): ReadAnswer<StreamEvent> | Promise<ReadAnswer<StreamEvent>>
Parameters
- tree: string
- after: Position | null
Returns ReadAnswer<StreamEvent> | Promise<ReadAnswer<StreamEvent>>
- Defined in src/events.ts:232