EventService
Stentor API Reference / stentor-service-event/src / EventService
Class: EventService
Defined in: packages/stentor-service-event/src/EventService.ts:79
Implements
Constructors
Constructor
new EventService(
stream,prefix):EventService
Defined in: packages/stentor-service-event/src/EventService.ts:89
Parameters
stream
AbstractEventStream | EventServiceProps | EventStream[]
prefix
EventPrefix = {}
Returns
EventService
Methods
addStream()
addStream(
newStream):void
Defined in: packages/stentor-service-event/src/EventService.ts:116
Add a new stream to send the events to
Parameters
newStream
EventStream
Returns
void
addPrefix()
addPrefix(
prefix):void
Defined in: packages/stentor-service-event/src/EventService.ts:126
Adds an object that is appended every event that is sent. All previous events added will not contain this prefix. If the key already exists in the prefix, then it will be replaced.
Parameters
prefix
The object that is appended to each event flushed.
Returns
void
request()
request(
request):Event
Defined in: packages/stentor-service-event/src/EventService.ts:134
Logs a Request object.
Parameters
request
The request to log.
Returns
Event
requestResponse()
requestResponse(
request,response):Event\<{request:Request;response:Response;tag?:string; }>
Defined in: packages/stentor-service-event/src/EventService.ts:197
Logs a request & response event
Parameters
request
response
Returns
Event\<{ request: Request; response: Response; tag?: string; }>
error()
error(
error):ErrorEvent
Defined in: packages/stentor-service-event/src/EventService.ts:210
Parameters
error
Error
Returns
ErrorEvent
Implementation of
message()
message(
name,message?):MessageEvent
Defined in: packages/stentor-service-event/src/EventService.ts:217
Parameters
name
string
message?
string
Returns
MessageEvent
event()
Call Signature
event(
stentorEvent):Event\<any>
Defined in: packages/stentor-service-event/src/EventService.ts:233
Add an event that will be sent to all event streams.
Parameters
stentorEvent
Event\<any>
Returns
Event\<any>
Call Signature
event(
type,name,payload?,keys?):Event\<any>
Defined in: packages/stentor-service-event/src/EventService.ts:234
Add an event that will be sent to all event streams.
Parameters
type
EventType
name
string
payload?
string | object
keys?
Record\<string, unknown>
Returns
Event\<any>
flush()
flush():
Promise\<void>
Defined in: packages/stentor-service-event/src/EventService.ts:268
Returns
Promise\<void>