@forinda/kickjs-cron

Production-grade cron job scheduling with pluggable backends.

@Cron

function Cron(
  expression: string,
  options?: {
    description?: string
    timezone?: string
    runOnInit?: boolean
  },
): MethodDecorator

getCronJobs

function getCronJobs(target: any): CronJobMeta[]

interface CronJobMeta {
  expression: string
  handlerName: string
  description?: string
  timezone?: string
  runOnInit?: boolean
}

CronScheduler

interface CronScheduler {
  schedule(
    expression: string,
    callback: () => void | Promise<void>,
    options?: { timezone?: string },
  ): any
  stop(handle: any): void
  stopAll(): void
}

CronerScheduler

class CronerScheduler implements CronScheduler {
  constructor(cronerModule?: { Cron: any } | any)
  init(): Promise<void>
}

Requires croner peer dependency.

IntervalScheduler

class IntervalScheduler implements CronScheduler {}

Zero-dependency fallback using setInterval.

CronAdapter

class CronAdapter implements AppAdapter {
  constructor(options: CronAdapterOptions)
}

interface CronAdapterOptions {
  services: any[]
  enabled?: boolean
  scheduler?: CronScheduler
}