Skip to content
bunqueue

Installation

Requirements

  • Bun v1.0 or later

Install from npm

Terminal window
bun add bunqueue

Install from source

Terminal window
git clone https://github.com/egeominotti/bunQ.git
cd bunQ
bun install
bun run build

Verify Installation

Embedded Mode

import { Queue } from 'bunqueue/client';


const queue = new Queue('test');
console.log('bunqueue is working!');

Server Mode

Terminal window
bunqueue --version

TypeScript Support

bunqueue is written in TypeScript and includes full type definitions:

import type {
  Job,
  JobOptions,
  WorkerOptions,
  StallConfig,
  DlqConfig,
  DlqEntry
} from 'bunqueue/client';

Next Steps