PURISTA API

---

PURISTA API / @purista/core / getCommandSuccessMessageMock

Function: getCommandSuccessMessageMock()

getCommandSuccessMessageMock<PayloadType>(payload, input?, commandMessage?): Readonly<{ contentEncoding: string; contentType: string; correlationId: string; eventName?: string; id: string; messageType: CommandSuccessResponse; otp?: string; payload: PayloadType; principalId?: string; receiver: { instanceId: string; serviceName: string; serviceTarget: string; serviceVersion: string; }; sender: { instanceId: string; serviceName: string; serviceTarget: string; serviceVersion: string; }; tenantId?: string; timestamp: number; traceId?: string; }>

Defined in: packages/core/src/mocks/messages/getCommandSuccessMessage.mock.ts:14

A function that returns a mocked command success response message.

Type Parameters

PayloadType

PayloadType

Parameters

payload

PayloadType

input?

Partial<{ contentEncoding: string; contentType: string; correlationId: string; eventName?: string; id: string; messageType: CommandSuccessResponse; otp?: string; payload: PayloadType; principalId?: string; receiver: { instanceId: string; serviceName: string; serviceTarget: string; serviceVersion: string; }; sender: { instanceId: string; serviceName: string; serviceTarget: string; serviceVersion: string; }; tenantId?: string; timestamp: number; traceId?: string; }>

commandMessage?

contentEncoding

string

content encoding of message payload

contentType

string

content type of message payload

correlationId

string

correlation id to know which command response referrs to which command

eventName?

string

event name for this message

id

string

global unique id of message

messageType

Command

otp?

string

stringified Opentelemetry parent trace id

payload

{ parameter: unknown; payload: unknown; }

payload.parameter

unknown

payload.payload

unknown

principalId?

string

principal id

receiver

EBMessageAddress

sender

{ instanceId: string; serviceName: string; serviceTarget: string; serviceVersion: string; }

sender.instanceId

string

instance id of eventbridge

sender.serviceName

string

the name of the service

sender.serviceTarget

string

the name of the command or subscription

sender.serviceVersion

string

the version of the service

tenantId?

string

principal id

timestamp

number

timestamp of message creation time

traceId?

string

trace id of message

Returns

Readonly<{ contentEncoding: string; contentType: string; correlationId: string; eventName?: string; id: string; messageType: CommandSuccessResponse; otp?: string; payload: PayloadType; principalId?: string; receiver: { instanceId: string; serviceName: string; serviceTarget: string; serviceVersion: string; }; sender: { instanceId: string; serviceName: string; serviceTarget: string; serviceVersion: string; }; tenantId?: string; timestamp: number; traceId?: string; }>