Skip to main content

FirehoseStream

Stentor API Reference

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

Class: FirehoseStream

Defined in: packages/stentor-service-event/src/FirehoseStream.ts:49

Extends​

Constructors​

Constructor​

new FirehoseStream(deliveryStreamName, injectedFirehose?): FirehoseStream

Defined in: packages/stentor-service-event/src/FirehoseStream.ts:53

Parameters​

deliveryStreamName​

string

injectedFirehose?​

FirehoseClient = globalFirehose

Returns​

FirehoseStream

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/FirehoseStream.ts:59

Parameters​

events​

Event<any>[]

Returns​

Promise<void>

Overrides​

AbstractEventStream.flushEvents