PURISTA API / @purista/core / StreamFunction
Type Alias: StreamFunction()<S, MessagePayloadType, MessageParamsType, FunctionPayloadType, FunctionParamsType, ChunkType, FinalType, Resources, Invokes, StreamInvokes, EmitList, QueueInvokes, AgentInvokes>
StreamFunction<
S,MessagePayloadType,MessageParamsType,FunctionPayloadType,FunctionParamsType,ChunkType,FinalType,Resources,Invokes,StreamInvokes,EmitList,QueueInvokes,AgentInvokes> = (this,context,payload,parameter,writer) =>Promise<void>
Defined in: core/types/stream/StreamFunction.ts:11
Type Parameters
S
S extends ServiceClass
MessagePayloadType
MessagePayloadType = unknown
MessageParamsType
MessageParamsType = unknown
FunctionPayloadType
FunctionPayloadType = unknown
FunctionParamsType
FunctionParamsType = unknown
ChunkType
ChunkType = unknown
FinalType
FinalType = unknown
Resources
Resources extends Record<string, unknown> = EmptyObject
Invokes
Invokes extends InvokeList = EmptyObject
StreamInvokes
StreamInvokes extends StreamInvokeList = EmptyObject
EmitList
EmitList extends Record<string, Schema> = EmptyObject
QueueInvokes
QueueInvokes extends QueueInvokeList = QueueInvokeList
AgentInvokes
AgentInvokes extends AgentInvokeList = EmptyObject
Parameters
this
S
context
StreamFunctionContext<MessagePayloadType, MessageParamsType, Resources, Invokes, StreamInvokes, EmitList, QueueInvokes, AgentInvokes>
payload
Readonly<FunctionPayloadType>
parameter
Readonly<FunctionParamsType>
writer
StreamWriter<ChunkType, FinalType>
Returns
Promise<void>