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:11

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:27

emitEvent?

optional emitEvent: boolean

eventName?

optional eventName: string

queueName?

optional queueName: string

---

deprecated

deprecated: boolean

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

---

description

description: string

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

---

lifecycle?

optional lifecycle: QueueLifecycleConfig

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

---

parameterSchema?

optional parameterSchema: ParamsSchema

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

---

payloadSchema?

optional payloadSchema: PayloadSchema

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

---

queueBridgeConfig

queueBridgeConfig: DefinitionQueueBridgeConfig

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

---

queueName

queueName: string

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

---

tags

tags: string[]

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

---

transformBeforeEnqueue?

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

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

---

transformBeforeExecute?

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

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

---

workers

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

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