Type Alias: StreamEvent#

StreamEvent = object

StreamEvent

This structure is used to pass streaming event information to the client. All event messages will be in this format.

Properties#

action#

action: eAction

The type of action that the event describes.

eta?#

optional eta: number

Time to completion of the requested action.

info#

info: string | TypeError

Additional information about the action.

queuePosition?#

optional queuePosition: number

The position of the event in the event queue.

sessionId?#

optional sessionId: UUID

The id of the session that sent the event.

stats?#

optional stats: StreamStats

Performance stats information about the running stream.

status#

status: eStatus

The status of the event action.

subSessionId?#

optional subSessionId: UUID

The id of the sub-session that sent the event.