@purista/core v2.0.5

---

PURISTA API / @purista/core / Subscription

Type Alias: Subscription<PayloadType, ParameterType>

Subscription<PayloadType, ParameterType>: object

Defined in: packages/core/src/core/types/subscription/Subscription.ts:13

A subscription managed by the event bridge

Type Parameters

• PayloadType = unknown

• ParameterType = unknown

Type declaration

emitEventName?

optional emitEventName: string

the event name to be used for custom message if the subscriptions returns a result

eventBridgeConfig

eventBridgeConfig: DefinitionEventBridgeConfig

config information for event bridge

eventName?

optional eventName: string

the event name to subscribe for

messageType?

optional messageType: EBMessageType

the message type

payload?

optional payload: object

the message payload

payload.parameter?

optional payload.parameter: ParameterType

payload.payload?

optional payload.payload: PayloadType

principalId?

optional principalId: PrincipalId

the principal id

receiver?

optional receiver: object

the consumer address of the message

receiver.instanceId?

optional receiver.instanceId: InstanceId

receiver.serviceName?

optional receiver.serviceName: string

receiver.serviceTarget?

optional receiver.serviceTarget: string

receiver.serviceVersion?

optional receiver.serviceVersion: string

sender?

optional sender: object

the producer address of the message

sender.instanceId?

optional sender.instanceId: InstanceId

sender.serviceName?

optional sender.serviceName: string

sender.serviceTarget?

optional sender.serviceTarget: string

sender.serviceVersion?

optional sender.serviceVersion: string

subscriber

subscriber: EBMessageAddress

the address of the subscription (service name, version and subscription name)

tenantId?

optional tenantId: TenantId

the tenant id