Type Alias: StreamEvent

StreamEvent = object

Defined in: StreamEvent.ts:134

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

Defined in: StreamEvent.ts:136

The type of action that the event describes.

---

eta?

optional eta: number

Defined in: StreamEvent.ts:148

Time to completion of the requested action.

---

info

info: string | TypeError

Defined in: StreamEvent.ts:140

Additional information about the action.

---

queuePosition?

optional queuePosition: number

Defined in: StreamEvent.ts:146

The position of the event in the event queue.

---

sessionId?

optional sessionId: UUID

Defined in: StreamEvent.ts:142

The id of the session that sent the event.

---

stats?

optional stats: StreamStats

Defined in: StreamEvent.ts:150

Performance stats information about the running stream.

---

status

status: eStatus

Defined in: StreamEvent.ts:138

The status of the event action.

---

subSessionId?

optional subSessionId: UUID

Defined in: StreamEvent.ts:144

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