PURISTA API / @purista/core / StreamAfterGuardHook
Type Alias: StreamAfterGuardHook<S, MessagePayloadType, MessageParamsType, FunctionPayloadType, FunctionParamsType, FunctionFinalType, Resources, Invokes, StreamInvokes, EmitList, QueueInvokes>
StreamAfterGuardHook<
S,MessagePayloadType,MessageParamsType,FunctionPayloadType,FunctionParamsType,FunctionFinalType,Resources,Invokes,StreamInvokes,EmitList,QueueInvokes> = (this,context,result,originalPayload,originalParameter) =>Promise<void>
Defined in: core/types/stream/StreamAfterGuardHook.ts:18
Guard called after a stream completes successfully and the final payload has been validated.
result is the final payload written via writer.close(...), or the aggregated final payload when chunk aggregation is enabled.
Type Parameters
S
S extends ServiceClass = ServiceClass
MessagePayloadType
MessagePayloadType = unknown
MessageParamsType
MessageParamsType = unknown
FunctionPayloadType
FunctionPayloadType = unknown
FunctionParamsType
FunctionParamsType = unknown
FunctionFinalType
FunctionFinalType = 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
Parameters
this
S
context
StreamFunctionContext<MessagePayloadType, MessageParamsType, Resources, Invokes, StreamInvokes, EmitList, QueueInvokes>
result
Readonly<FunctionFinalType>
originalPayload
Readonly<FunctionPayloadType>
originalParameter
Readonly<FunctionParamsType>
Returns
Promise<void>