Skip to main content

FileQueueParameters

@webda/fs


Class: FileQueueParameters

Defined in: fs/src/filequeue.service.ts:9

Configuration parameters for the filesystem-backed FIFO queue.

Extends​

  • QueueParameters

Constructors​

Constructor​

new FileQueueParameters(): FileQueueParameters

Returns​

FileQueueParameters

Inherited from​

QueueParameters.constructor

Properties​

expire?​

optional expire?: number

Defined in: fs/src/filequeue.service.ts:15

Number of seconds before dropping message

Default​

30

folder​

folder: string

Defined in: fs/src/filequeue.service.ts:19

Where to store the queue


maxConsumers​

maxConsumers: number

Defined in: core/lib/queues/queueservice.d.ts:37

Max number of queue consumers Queue will auto increase to this max number if queue is loaded and it will decrease to just one consumer if no messages are available

Default​

10

Inherited from​

QueueParameters.maxConsumers


type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

QueueParameters.type


workerDelayer?​

optional workerDelayer?: WaitDelayerDefinition

Defined in: core/lib/queues/queueservice.d.ts:24

Delayer between two failed attempts to process messages

Inherited from​

QueueParameters.workerDelayer


workerParallelism​

workerParallelism: boolean

Defined in: core/lib/queues/queueservice.d.ts:29

Define if worker should process multi message received in //

Default​

true

Inherited from​

QueueParameters.workerParallelism

Methods​

default()​

default(): void

Defined in: fs/src/filequeue.service.ts:22

Set default expiration to 30 seconds and convert to milliseconds.

Returns​

void


load()​

load(params?): this

Defined in: core/lib/services/serviceparameters.d.ts:18

Load raw parameters by assigning them onto this instance

Parameters​

params?​

any

the service parameters

Returns​

this

this for chaining

Inherited from​

QueueParameters.load


update()​

update(params, delta): this

Defined in: core/lib/services/serviceparameters.d.ts:25

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

QueueParameters.update


with()​

with(callback): this

Defined in: core/lib/services/serviceparameters.d.ts:31

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

QueueParameters.with