Installation

Install OqronKit with your preferred package manager:

npm install oqronkit

Project Configuration

Create oqron.config.ts at the root of your project using defineConfig:

oqron.config.ts

import { defineConfig } from 'oqronkit'

export default defineConfig({
  project: 'my-app',
  environment: process.env.NODE_ENV, // 'development' | 'staging' | 'production'
})

Or pass the config inline when initializing:

index.ts

import {
  OqronKit,
  cronModule,
  scheduleModule,
  queueModule,
  workerModule,
} from 'oqronkit'

await OqronKit.init({
  config: {
    modules: [cronModule, scheduleModule, queueModule, workerModule],
    logger: { prettify: true },
  },
})

Logger Configuration

// Pretty logging for development
logger: { prettify: true }

// Disable logging entirely
logger: false

// Custom log level
logger: { level: 'warn' }

Admin UI Authentication

If you enable the built-in dashboard, configure auth with both username and password:

ui: {
  auth: {
    username: process.env.ADMIN_USER,
    password: process.env.ADMIN_PASS,
  }
}

Partial auth (only username or only password) is rejected at startup via Zod validation.

Module Selection

Only register the modules your application needs:

// API server — only pushes jobs, no processing
await OqronKit.init({
  config: { modules: [queueModule] },
})

// Worker server — only processes jobs
await OqronKit.init({
  config: { modules: [workerModule] },
})

// Full monolith — everything
await OqronKit.init({
  config: { modules: [cronModule, scheduleModule, queueModule, workerModule] },
})

Trigger Auto-Discovery

OqronKit auto-discovers job definitions from well-known directories. Place your cron(), schedule(), queue(), and worker() definitions in any of:

src/triggers/
src/jobs/
triggers/
jobs/

Or specify a custom path:

await OqronKit.init({
  config: {
    triggers: 'src/my-triggers', // Custom trigger directory
    modules: [cronModule, queueModule],
  },
})

Environment Isolation

OqronKit enforces strict environment isolation. A production worker will never accidentally claim development tasks. All keys are prefixed:

${project}:${environment}:${job_name}

Next Steps

Quick Start — Build your first queue in 2 minutes
Architecture — Understand the core design principles
Adapters — Deep-dive into adapter configuration

Installation

On this page