Skip to content

PURISTA API


PURISTA API / @purista/core / QueueDefinitionBuilder

Class: QueueDefinitionBuilder

Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:9

Constructors

Constructor

new QueueDefinitionBuilder(queueName, queueDescription): QueueDefinitionBuilder

Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:26

Parameters

queueName

string

queueDescription

string

Returns

QueueDefinitionBuilder

Methods

addParameterSchema()

addParameterSchema(schema): QueueDefinitionBuilder

Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:36

Parameters

schema

Schema

Returns

QueueDefinitionBuilder


addPayloadSchema()

addPayloadSchema(schema): QueueDefinitionBuilder

Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:31

Parameters

schema

Schema

Returns

QueueDefinitionBuilder


addWorkerDefinition()

addWorkerDefinition(...workers): QueueDefinitionBuilder

Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:82

Parameters

workers

...QueueWorkerDefinition[]

Returns

QueueDefinitionBuilder


getDefinition()

getDefinition(): Promise<QueueDefinition>

Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:87

Returns

Promise<QueueDefinition>


markAsDeprecated()

markAsDeprecated(): QueueDefinitionBuilder

Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:69

Returns

QueueDefinitionBuilder


setBeforeEnqueueTransform()

setBeforeEnqueueTransform(transform): QueueDefinitionBuilder

Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:49

Parameters

transform

QueueTransformHook

Returns

QueueDefinitionBuilder


setBeforeExecuteTransform()

setBeforeExecuteTransform(transform): QueueDefinitionBuilder

Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:54

Parameters

transform

QueueTransformHook

Returns

QueueDefinitionBuilder


setDeadLetterOptions()

setDeadLetterOptions(options): QueueDefinitionBuilder

Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:59

Parameters

options
emitEvent?

boolean

eventName?

string

queueName?

string

Returns

QueueDefinitionBuilder


setLifecycleConfig()

setLifecycleConfig(config): QueueDefinitionBuilder

Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:41

Parameters

config

Partial<QueueLifecycleConfig>

Returns

QueueDefinitionBuilder


setQueueBridgeConfig()

setQueueBridgeConfig(config): QueueDefinitionBuilder

Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:74

Parameters

config

Partial<DefinitionQueueBridgeConfig>

Returns

QueueDefinitionBuilder


setTags()

setTags(tags): QueueDefinitionBuilder

Defined in: QueueDefinitionBuilder/QueueDefinitionBuilder.impl.ts:64

Parameters

tags

string[]

Returns

QueueDefinitionBuilder