Skip to main content

AbstractEventStream

Stentor API Reference


Stentor API Reference / stentor-service-event/src / AbstractEventStream

Abstract Class: AbstractEventStream

Defined in: packages/stentor-service-event/src/AbstractEventStream.ts:4

Extended by​

Implements​

  • EventStream

Constructors​

Constructor​

new AbstractEventStream(): AbstractEventStream

Defined in: packages/stentor-service-event/src/AbstractEventStream.ts:7

Returns​

AbstractEventStream

Methods​

addEvent()​

addEvent(event): void

Defined in: packages/stentor-service-event/src/AbstractEventStream.ts:11

Add an event to the stream. This will not be sent until the event is flushed.

Parameters​

event​

Event\<any>

The event to send.

Returns​

void

Implementation of​

EventStream.addEvent


flush()​

flush(): Promise\<void>

Defined in: packages/stentor-service-event/src/AbstractEventStream.ts:15

Send all the events to the end of the stream.

Returns​

Promise\<void>

Implementation of​

EventStream.flush


flushEvents()​

abstract protected flushEvents(event): Promise\<void>

Defined in: packages/stentor-service-event/src/AbstractEventStream.ts:21

Parameters​

event​

Event\<any>[]

Returns​

Promise\<void>