Class: SseStream
nekte-protocol / server/src / SseStream
Class: SseStream
Defined in: nekte-source/packages/server/src/sse-stream.ts:20
Constructors
Constructor
new SseStream(
res):SseStream
Defined in: nekte-source/packages/server/src/sse-stream.ts:24
Parameters
res
ServerResponse
Returns
SseStream
Accessors
isClosed
Get Signature
get isClosed():
boolean
Defined in: nekte-source/packages/server/src/sse-stream.ts:125
Whether the stream has been closed
Returns
boolean
Methods
cancelled()
cancelled(
taskId,previousStatus,reason?):void
Defined in: nekte-source/packages/server/src/sse-stream.ts:73
Send a cancelled event
Parameters
taskId
string
previousStatus
TaskStatus
reason?
string
Returns
void
close()
close():
void
Defined in: nekte-source/packages/server/src/sse-stream.ts:118
Close the stream
Returns
void
complete()
complete(
taskId,out,meta?):void
Defined in: nekte-source/packages/server/src/sse-stream.ts:51
Send completion event and close the stream
Parameters
taskId
string
out
MultiLevelResult
meta?
ms?
number
tokens_used?
number
Returns
void
error()
error(
code,message,taskId?):void
Defined in: nekte-source/packages/server/src/sse-stream.ts:64
Send error event and close the stream
Parameters
code
number
message
string
taskId?
string
Returns
void
partial()
partial(
out,resolvedLevel?):void
Defined in: nekte-source/packages/server/src/sse-stream.ts:43
Send a partial result (preliminary data)
Parameters
out
Record<string, unknown>
resolvedLevel?
any
Returns
void
progress()
progress(
processed,total,message?):void
Defined in: nekte-source/packages/server/src/sse-stream.ts:35
Send a progress event
Parameters
processed
number
total
number
message?
string
Returns
void
resumed()
resumed(
taskId,fromCheckpoint):void
Defined in: nekte-source/packages/server/src/sse-stream.ts:90
Send a resumed event
Parameters
taskId
string
fromCheckpoint
boolean
Returns
void
send()
send(
event):void
Defined in: nekte-source/packages/server/src/sse-stream.ts:106
Send a raw SSE event with backpressure awareness
Parameters
event
SseEvent
Returns
void
statusChange()
statusChange(
taskId,from,to,reason?):void
Defined in: nekte-source/packages/server/src/sse-stream.ts:98
Send a status change event
Parameters
taskId
string
from
TaskStatus
to
TaskStatus
reason?
string
Returns
void
suspended()
suspended(
taskId,checkpointAvailable):void
Defined in: nekte-source/packages/server/src/sse-stream.ts:82
Send a suspended event
Parameters
taskId
string
checkpointAvailable
boolean
Returns
void