PURISTA

Appearance

PURISTA API

PURISTA API / @purista/core / SubscriptionDefinition

Type Alias: SubscriptionDefinition<S, TransformInputPayload, TransformInputParams, FunctionPayloadType, FunctionParamsType, FunctionOutputType, FinalFunctionOutputType, TransformOutputHookOutput, Resources, Invokes, StreamInvokes, EmitList, MetadataType, QueueInvokes> ​

SubscriptionDefinition<S, TransformInputPayload, TransformInputParams, FunctionPayloadType, FunctionParamsType, FunctionOutputType, FinalFunctionOutputType, TransformOutputHookOutput, Resources, Invokes, StreamInvokes, EmitList, MetadataType, QueueInvokes> = object

Defined in: core/types/subscription/SubscriptionDefinition.ts:23

The definition for a subscription provided by some service.

Type Parameters ​

S ​

S extends ServiceClass

TransformInputPayload ​

TransformInputPayload

TransformInputParams ​

TransformInputParams

FunctionPayloadType ​

FunctionPayloadType

FunctionParamsType ​

FunctionParamsType

FunctionOutputType ​

FunctionOutputType

FinalFunctionOutputType ​

FinalFunctionOutputType

TransformOutputHookOutput ​

TransformOutputHookOutput

Resources ​

Resources extends Record<string, unknown>

Invokes ​

Invokes extends InvokeList

StreamInvokes ​

StreamInvokes extends StreamInvokeList

EmitList ​

EmitList extends Record<string, Schema>

MetadataType ​

MetadataType extends SubscriptionDefinitionMetadataBase = SubscriptionDefinitionMetadataBase

QueueInvokes ​

QueueInvokes extends QueueInvokeList = QueueInvokeList

Properties ​

call ​

call: SubscriptionFunction<S, FunctionPayloadType, FunctionParamsType, FunctionOutputType, Resources, Invokes, StreamInvokes, EmitList, QueueInvokes>

Defined in: core/types/subscription/SubscriptionDefinition.ts:48

the subscription function

deprecated ​

deprecated: boolean

Defined in: core/types/subscription/SubscriptionDefinition.ts:137

emitEventName? ​

optional emitEventName?: string

Defined in: core/types/subscription/SubscriptionDefinition.ts:78

event name to be used for custom message if the subscription functions returns value

emitList ​

emitList: EmitList

Defined in: core/types/subscription/SubscriptionDefinition.ts:135

eventBridgeConfig ​

eventBridgeConfig: DefinitionEventBridgeConfig

Defined in: core/types/subscription/SubscriptionDefinition.ts:46

config information for event bridge

eventName? ​

optional eventName?: string

Defined in: core/types/subscription/SubscriptionDefinition.ts:76

filter forevent name

hooks ​

hooks: object

Defined in: core/types/subscription/SubscriptionDefinition.ts:84

hooks of subscription

afterGuard? ​

optional afterGuard?: Record<string, SubscriptionAfterGuardHook<S, FunctionPayloadType, FunctionParamsType, FunctionOutputType, Resources, Invokes, StreamInvokes, EmitList, QueueInvokes>>

beforeGuard? ​

optional beforeGuard?: Record<string, SubscriptionBeforeGuardHook<S, FunctionPayloadType, FunctionParamsType, Resources, Invokes, StreamInvokes, EmitList, QueueInvokes>>

transformInput? ​

optional transformInput?: object

transformInput.transformFunction ​

transformFunction: SubscriptionTransformInputHook<S, TransformInputPayload, TransformInputParams, FunctionPayloadType, FunctionParamsType>

transformInput.transformInputSchema ​

transformInputSchema: Schema

transformInput.transformParameterSchema ​

transformParameterSchema: Schema

transformOutput? ​

optional transformOutput?: object

transformOutput.transformFunction ​

transformFunction: SubscriptionTransformOutputHook<S, FinalFunctionOutputType, FunctionParamsType, TransformOutputHookOutput>

transformOutput.transformOutputSchema ​

transformOutputSchema: Schema

invokes ​

invokes: Invokes

Defined in: core/types/subscription/SubscriptionDefinition.ts:133

messageType? ​

optional messageType?: EBMessageType

Defined in: core/types/subscription/SubscriptionDefinition.ts:74

filter for message type

metadata ​

metadata: MetadataType

Defined in: core/types/subscription/SubscriptionDefinition.ts:44

the metadata of the subscription

principalId? ​

optional principalId?: PrincipalId

Defined in: core/types/subscription/SubscriptionDefinition.ts:80

filter for principal id

queueInvokes ​

queueInvokes: QueueInvokes

Defined in: core/types/subscription/SubscriptionDefinition.ts:136

receiver? ​

optional receiver?: object

Defined in: core/types/subscription/SubscriptionDefinition.ts:67

filter for messages consumed by given receiver

instanceId? ​

optional instanceId?: InstanceId

serviceName? ​

optional serviceName?: string

serviceTarget? ​

optional serviceTarget?: string

serviceVersion? ​

optional serviceVersion?: string

sender? ​

optional sender?: object

Defined in: core/types/subscription/SubscriptionDefinition.ts:60

filter for messages produced by given sender

instanceId? ​

optional instanceId?: InstanceId

serviceName? ​

optional serviceName?: string

serviceTarget? ​

optional serviceTarget?: string

serviceVersion? ​

optional serviceVersion?: string

streamInvokes ​

streamInvokes: StreamInvokes

Defined in: core/types/subscription/SubscriptionDefinition.ts:134

subscriptionDescription ​

subscriptionDescription: string

Defined in: core/types/subscription/SubscriptionDefinition.ts:42

the description of the subscription

subscriptionName ​

subscriptionName: string

Defined in: core/types/subscription/SubscriptionDefinition.ts:40

the name of the subscription

tenantId? ​

optional tenantId?: TenantId

Defined in: core/types/subscription/SubscriptionDefinition.ts:82

filter for tenant id