Interface EventSource

A transport of events for one consumer: an async iterable of deliveries plus ack.

interface EventSource {
    closeReason: CloseReason | undefined;
    ack(seq: number): Promise<void>;
    advance(seq: number): Promise<void>;
    answerAutocomplete(
        requestId: string,
        choices: readonly {}[],
    ): Promise<void>;
    close(): Promise<void>;
    settle(seq: number): Promise<void>;
}

Hierarchy

AsyncIterable<Delivery>
- EventSource

Implemented by

Index

Properties

Methods

ack advance answerAutocomplete close settle

Properties

`Readonly`closeReason

closeReason: CloseReason | undefined

Why the source stopped, once it has.

Methods

ack

ack(seq: number): Promise<void>
Acknowledges every event up to seq.
Parameters
- seq: number
  The seq.
Returns Promise<void>

advance

advance(seq: number): Promise<void>
Passes on a cursor; it never settles an open delivered event.
Parameters
- seq: number
  The cursor.
Returns Promise<void>

answerAutocomplete

answerAutocomplete(requestId: string, choices: readonly {}[]): Promise<void>
Sends the choices of an autocomplete request.
Parameters
- requestId: string
  The request.
- choices: readonly {}[]
  The choices.
Returns Promise<void>

close

close(): Promise<void>
Stops the source; the iterator ends.

Returns Promise<void>

settle

settle(seq: number): Promise<void>
Marks seq settled and acknowledges when the acknowledgement point moves.
Parameters
- seq: number
  The settled seq.
Returns Promise<void>