PURISTA

Appearance

PURISTA API

PURISTA API / @purista/core / QueueDefinition

Type Alias: QueueDefinition<PayloadSchema, ParamsSchema, Resources, Invokes, StreamInvokes> ​

QueueDefinition<PayloadSchema, ParamsSchema, Resources, Invokes, StreamInvokes> = object

Defined in: core/types/queue/QueueDefinition.ts:14

Type Parameters ​

PayloadSchema ​

PayloadSchema extends Schema = Schema

ParamsSchema ​

ParamsSchema extends Schema = Schema

Resources ​

Resources extends Record<string, unknown> = EmptyObject

Invokes ​

Invokes extends InvokeList = EmptyObject

StreamInvokes ​

StreamInvokes extends StreamInvokeList = EmptyObject

Properties ​

deadLetter? ​

optional deadLetter?: object

Defined in: core/types/queue/QueueDefinition.ts:33

queueName? ​

optional queueName?: string

deprecated ​

deprecated: boolean

Defined in: core/types/queue/QueueDefinition.ts:26

description ​

description: string

Defined in: core/types/queue/QueueDefinition.ts:22

executionProfile? ​

optional executionProfile?: QueueLongRunningExecutionProfile

Defined in: core/types/queue/QueueDefinition.ts:28

lifecycle? ​

optional lifecycle?: QueueLifecycleConfig

Defined in: core/types/queue/QueueDefinition.ts:27

parameterSchema? ​

optional parameterSchema?: ParamsSchema

Defined in: core/types/queue/QueueDefinition.ts:24

payloadSchema? ​

optional payloadSchema?: PayloadSchema

Defined in: core/types/queue/QueueDefinition.ts:23

queueBridgeConfig ​

queueBridgeConfig: DefinitionQueueBridgeConfig

Defined in: core/types/queue/QueueDefinition.ts:31

queueName ​

queueName: string

Defined in: core/types/queue/QueueDefinition.ts:21

resultPolicy? ​

optional resultPolicy?: QueueResultPolicy

Defined in: core/types/queue/QueueDefinition.ts:29

schedules? ​

optional schedules?: ScheduleDefinition[]

Defined in: core/types/queue/QueueDefinition.ts:30

tags ​

tags: string[]

Defined in: core/types/queue/QueueDefinition.ts:25

transformBeforeEnqueue? ​

optional transformBeforeEnqueue?: QueueTransformHook<ServiceClass, Infer<PayloadSchema>, Infer<ParamsSchema>, Resources>

Defined in: core/types/queue/QueueDefinition.ts:36

transformBeforeExecute? ​

optional transformBeforeExecute?: QueueTransformHook<ServiceClass, Infer<PayloadSchema>, Infer<ParamsSchema>, Resources>

Defined in: core/types/queue/QueueDefinition.ts:37

workers ​

workers: QueueWorkerDefinition<PayloadSchema, ParamsSchema, Resources, Invokes, StreamInvokes>[]

Defined in: core/types/queue/QueueDefinition.ts:32