xque

A redis-based job queue library written in typescript that supports retries, job priorities and expiration.

Usage

Create a producer and enqueue jobs:

import { createProducer } from 'xque';

const producer = await createProducer({ redisConfig: { host: 'localhost', port: 6379, db: 0 });

const jobId = await producer.enqueue('myQueue', { message: 'hello' }, { expiry: 3600, priority: 1 });
const jobId2 = await producer.enqueue('myQueue', { message: 'world' }, { expiry: 7200, priority: 2 });

await producer.stop();

Create a consumer and consume jobs from a queue:

import { createConsumer } from 'xque';

const consumer = await createConsumer({ redisConfig: { host: 'localhost', port: 6379, db: 0 }, queueName: 'myQueue' });

process.on('SIGTERM', () => {
  consumer.stop();
});

await consumer.run(async (job) => {
  console.log('Processing job', job);
});

Key prefix

Set ioredis' keyPrefix on redisConfig to isolate multiple xque deployments sharing the same redis database. The prefix is applied to every redis key, including those built inside xque's Lua scripts. A producer and consumer must use the same keyPrefix to see each other's jobs.

const redisConfig = { host: 'localhost', port: 6379, db: 0, keyPrefix: 'myapp:' };

const producer = await createProducer({ redisConfig });
const consumer = createConsumer({ redisConfig, queueName: 'myQueue' });

// Redis keys become e.g. myapp:xque:jobs, myapp:xque:queue:myQueue, ...

Semantic Versioning

xque is using Semantic Versioning: SemVer

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mrkamel/xque-ts

License

The library is available as open source under the terms of the MIT License.