Skip to main content

SNSStream

Stentor API Reference

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

Class: SNSStream

Defined in: packages/stentor-service-event/src/SNSStream.ts:17

Extends​

Constructors​

Constructor​

new SNSStream(topicArn, sns?): SNSStream

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

Parameters​

topicArn​

string

sns?​

SNSClient = globalSNS

Returns​

SNSStream

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/SNSStream.ts:27

Parameters​

events​

Event<any>[]

Returns​

Promise<void>

Overrides​

AbstractEventStream.flushEvents