@dyst-no/worker

A simple TypeScript library providing helper functions for scheduling background workers in Node.js applications.

Install with:

bun add @dyst-no/worker

Features

Cron Scheduler

Schedule workers to run on cron expressions with built-in error handling and optional startup execution.

import { cronScheduler, CronExpression } from '@dyst-no/worker';

// Run every hour
await cronScheduler({
  name: 'hourly-cleanup',
  cronExpression: CronExpression.EVERY_HOUR,
  worker: async () => {
    // Your worker logic here
  },
  runOnStartUp: true
});

Work Scheduler

A flexible scheduler that supports:

• PostgreSQL pub/sub topic listening
• Recurring execution with minimum intervals
• Startup execution
• Optional logging

import { workScheduler } from '@dyst-no/worker';

// Run on PostgreSQL notifications and at least every 5 minutes
await workScheduler({
  name: 'data-processor',
  postgres: {
    client: postgresClient,
    topics: ['data-updated']
  },
  atLeastEveryMs: 5 * 60 * 1000, // 5 minutes
  worker: async () => {
    // Your worker logic here
  },
  logger: pinoLogger
});

Releasing

Run the Release GitHub Actions workflow and choose one of:

• patch for fixes and small non-breaking changes
• minor for new backward-compatible features
• major for breaking changes

The release flow builds, typechecks, updates CHANGELOG.md from commit messages since the previous tag, creates a release commit and tag, and publishes to npm.

You can also run releases locally:

bun run release:patch
bun run release:minor
bun run release:major