Skip to content
DocsGuidesReferenceBlog
Install
HomeDocsGuidesReferenceBlog
Install Bun v1.4.0
Reference
Modules/Bun/CronJob
  • M[Symbol.dispose]
  • Pcron
  • Mref
  • Mstop
  • Munref

Modules

  • Bun
  • bun:bundle
  • bun:ffi
  • bun:jsc
  • bun:sqlite
  • bun:test
  • Globals
  • node:assert
  • node:async_hooks
  • node:buffer
  • node:child_process
  • node:cluster
  • node:crypto
  • node:dgram
  • node:diagnostics_channel
  • node:dns
  • node:dns/promises
  • node:events
  • node:ffi
  • node:fs
  • node:fs/promises
  • node:http
  • node:http2
  • node:https
  • node:inspector
  • node:inspector/promises
  • node:module
  • node:net
  • node:os
  • node:path
  • node:perf_hooks
  • node:punycode
  • node:querystring
  • node:quic
  • node:readline
  • node:readline/promises
  • node:stream
  • node:stream/consumers
  • node:stream/iter
  • node:stream/promises
  • node:stream/web
  • node:string_decoder
  • node:test
  • node:test/reporters
  • node:timers/promises
  • node:tls
  • node:trace_events
  • node:tty
  • node:url
  • node:util
  • node:util/types
  • node:v8
  • node:vm
  • node:wasi
  • node:worker_threads
  • node:zlib
  • node:zlib/iter

interface

CronJob

interface CronJob

A handle to an in-process cron job returned by Bun.cron when called with a callback.

const job = Bun.cron("0 * * * *", async () => {
  await cleanupTempFiles();
});
// Later:
job.stop();
  • readonly cron: string

    The schedule expression this job was created with.

  • [Symbol.dispose](): void;
  • ref(): CronJob;

    Keep the process alive while this job is scheduled (default).

  • stop(): CronJob;

    Cancel this cron job. The callback will not fire again.

  • unref(): CronJob;

    Allow the process to exit even while this job is scheduled.