PURISTA API / @purista/core / CommandFunction
Type Alias: CommandFunction<S, MessagePayloadType, MessageParamsType, FunctionPayloadType, FunctionParamsType, FunctionOutputType, Resources, Invokes, StreamInvokes, EmitList, QueueInvokes>
CommandFunction<
S,MessagePayloadType,MessageParamsType,FunctionPayloadType,FunctionParamsType,FunctionOutputType,Resources,Invokes,StreamInvokes,EmitList,QueueInvokes> = (this,context,payload,parameter) =>Promise<FunctionOutputType>
Defined in: core/types/commandType/CommandFunction.ts:15
CommandFunction is a function which will be triggered when a matching event bridge message is received by the service
Type Parameters
S
S extends ServiceClass
MessagePayloadType
MessagePayloadType = unknown
MessageParamsType
MessageParamsType = unknown
FunctionPayloadType
FunctionPayloadType = unknown
FunctionParamsType
FunctionParamsType = unknown
FunctionOutputType
FunctionOutputType = 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
CommandFunctionContext<MessagePayloadType, MessageParamsType, Resources, Invokes, StreamInvokes, EmitList, QueueInvokes, ServiceClassMetrics<S>>
payload
Readonly<FunctionPayloadType>
parameter
Readonly<FunctionParamsType>
Returns
Promise<FunctionOutputType>