Skip to main content

KinesisStream

Stentor API Reference

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

Class: KinesisStream

Defined in: packages/stentor-service-event/src/KinesisStream.ts:38

Extends​

Constructors​

Constructor​

new KinesisStream(props): KinesisStream

Defined in: packages/stentor-service-event/src/KinesisStream.ts:43

Parameters​

props​

KinesisStreamProps

Returns​

KinesisStream

Overrides​

AbstractEventStream.constructor

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

Inherited from​

AbstractEventStream.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>

Inherited from​

AbstractEventStream.flush

flushEvents()​

flushEvents(events): Promise<void>

Defined in: packages/stentor-service-event/src/KinesisStream.ts:59

Parameters​

events​

Event<any>[]

Returns​

Promise<void>

Overrides​

AbstractEventStream.flushEvents