API reference / @node-ts/bus-messages / messageAttributes

Function: messageAttributes()

function messageAttributes<AttributesType, StickyAttributesType>(...input): MessageAttributes<AttributesType, StickyAttributesType>;

Defined in: packages/bus-messages/src/message-attributes.ts:75

Creates MessageAttributes with attributes and stickyAttributes defaulted to {}, so a test can call a handler directly without spelling out empty attributes. Handlers still receive both fields, so they read them without ?..

Type Parameters

Type Parameter	Default type
AttributesType extends MessageAttributeMap	object
StickyAttributesType extends MessageAttributeMap	object

Parameters

Parameter	Type	Description
...input	object extends AttributesType & StickyAttributesType ? [MessageAttributesInput<AttributesType, StickyAttributesType>] : [MessageAttributesInput<AttributesType, StickyAttributesType>]	the correlation id and the attributes to set

Returns

MessageAttributes<AttributesType, StickyAttributesType>

message attributes with any missing attributes or stickyAttributes set to {}

Examples

await placeOrderHandler.messageHandler(PlaceOrder({ orderId: '1' }), messageAttributes(), fakeContext)

messageAttributes({ correlationId: 'c', attributes: { tenantId: 'a' } })