PURISTA API

---

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

PayloadType = unknown

ParameterType

ParameterType = unknown

Properties

emitEventName?

optional emitEventName: string

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

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

---

eventBridgeConfig

eventBridgeConfig: DefinitionEventBridgeConfig

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

config information for event bridge

---

eventName?

optional eventName: string

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

the event name to subscribe for

---

messageType?

optional messageType: EBMessageType

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

the message type

---

payload?

optional payload: object

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

the message payload

parameter?

optional parameter: ParameterType

payload?

optional payload: PayloadType

---

principalId?

optional principalId: PrincipalId

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

the principal id

---

receiver?

optional receiver: object

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

the consumer address of the message

instanceId?

optional instanceId: InstanceId

serviceName?

optional serviceName: string

serviceTarget?

optional serviceTarget: string

serviceVersion?

optional serviceVersion: string

---

sender?

optional sender: object

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

the producer address of the message

instanceId?

optional instanceId: InstanceId

serviceName?

optional serviceName: string

serviceTarget?

optional serviceTarget: string

serviceVersion?

optional serviceVersion: string

---

subscriber

subscriber: EBMessageAddress

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

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

---

tenantId?

optional tenantId: TenantId

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

the tenant id