Getting started

Get started with CadenceMQ by installing the core package and a driver, this example uses the same-process in-memory driver.

Installation

You can install CadenceMQ using your favorite package manager.

pnpm

pnpm add @cadence-mq/core @cadence-mq/driver-memory

npm

npm install @cadence-mq/core @cadence-mq/driver-memory

bun

bun add @cadence-mq/core @cadence-mq/driver-memory

yarn

yarn add @cadence-mq/core @cadence-mq/driver-memory

Usage

The CadenceMQ core package is the main package that you will use to create your jobs and schedule them, you’ll also need to install a driver to store your jobs.

index.ts

import { createCadence } from '@cadence-mq/core';
import { createMemoryDriver } from '@cadence-mq/driver-memory';

const driver = createMemoryDriver();
const cadence = createCadence({ driver });

// Register a task to be executed
cadence.registerTask({
  taskName: 'send-welcome-email',
  handler: async ({ data }) => {
    console.log(`Sending welcome email to ${data.email}`);
  },
});

// Create a worker to execute the jobs
const worker = cadence.createWorker({ workerId: '1' });
worker.start();

// Schedule a job to be executed as soon as possible
await cadence.scheduleJob({
  taskName: 'send-welcome-email',
  data: { email: 'test@test.com' },
});