Skip to main content

JobQueueOptions

JobQueueOptions​

@vendure/corevendure-config.ts

Options related to the built-in job queue.

Signature
interface JobQueueOptions {
    jobQueueStrategy?: JobQueueStrategy;
    jobBufferStorageStrategy?: JobBufferStorageStrategy;
    activeQueues?: string[];
    prefix?: string;
}

jobQueueStrategy​

property
JobQueueStrategy
default:
<a href='/reference/typescript-api/job-queue/in-memory-job-queue-strategy#inmemoryjobqueuestrategy'>InMemoryJobQueueStrategy</a>

Defines how the jobs in the queue are persisted and accessed.

jobBufferStorageStrategy​

property
JobBufferStorageStrategy

activeQueues​

property
string[]

Defines the queues that will run in this process. This can be used to configure only certain queues to run in this process. If its empty all queues will be run. Note: this option is primarily intended to apply to the Worker process. Jobs will always get published to the queue regardless of this setting, but this setting determines whether they get processed or not.

prefix​

property
v1.5.0
string

Prefixes all job queue names with the passed string. This is useful with multiple deployments in cloud environments using services such as Amazon SQS or Google Cloud Tasks.

For example, we might have a staging and a production deployment in the same account/project and each one will need its own task queue. We can achieve this with a prefix.