Schedule Methods - AdonisJS Scheduler

All schedule instances (returned by scheduler.command() and scheduler.call()) inherit from the BaseSchedule class, which provides methods for configuring frequency, timing, and behavior.

Configuration Methods

timezone()

Set the timezone for the schedule.

timezone(timezone: string): this

string

required

A valid timezone string (e.g., 'America/New_York', 'UTC', 'Asia/Tokyo')

Example

scheduler.command('reports:generate')
  .daily()
  .timezone('America/New_York')

tag()

Assign a tag to the schedule for grouping and filtering.

tag(tag: string): this

string

required

The tag name to assign to this schedule

Example

scheduler.command('emails:send')
  .everyMinute()
  .tag('email-queue')

immediate()

Run the schedule immediately when the worker starts, in addition to the scheduled times.

immediate(state?: boolean): this

boolean

default:"true"

Whether to run immediately on start. Pass false to disable

Example

scheduler.command('cache:warm')
  .daily()
  .immediate() // Runs on startup and then daily

skip()

Disable the schedule without removing it.

skip(state?: boolean): this

boolean

default:"true"

Whether to skip this schedule. Pass false to re-enable

Example

import env from '@adonisjs/core/services/env'

scheduler.command('maintenance:check')
  .hourly()
  .skip(env.get('NODE_ENV') === 'development')

withoutOverlapping()

Prevent the schedule from running if the previous execution is still in progress.

withoutOverlapping(expiresAt?: number): this

number

default:"3600000"

Lock expiration time in milliseconds (default: 1 hour). After this time, the lock is released even if the task is still running

Example

scheduler.command('db:backup')
  .daily()
  .withoutOverlapping(7200000) // 2 hours

Lifecycle Methods

before()

before(callback: () => Promise<void>): this

() => Promise<void>

required

An async callback function to execute before the schedule runs

Example

import logger from '@adonisjs/core/services/logger'

scheduler.command('reports:generate')
  .daily()
  .before(async () => {
    logger.info('Starting report generation...')
  })

after()

after(callback: () => Promise<void>): this

() => Promise<void>

required

An async callback function to execute after the schedule completes

Example

import logger from '@adonisjs/core/services/logger'

scheduler.command('reports:generate')
  .daily()
  .after(async () => {
    logger.info('Report generation completed')
  })

Frequency Methods - Every Second

everySecond()

Run the schedule every second.

everySecond(): this

Example

scheduler.call(() => console.log('Tick')).everySecond()

everySeconds()

Run the schedule every N seconds.

everySeconds(second: number): this

number

required

Number of seconds between executions (1-59)

Example

scheduler.command('check:status').everySeconds(30)

everyFiveSeconds()

Run the schedule every 5 seconds.

everyFiveSeconds(): this

everyTenSeconds()

Run the schedule every 10 seconds.

everyTenSeconds(): this

everyFifteenSeconds()

Run the schedule every 15 seconds.

everyFifteenSeconds(): this

everyThirtySeconds()

Run the schedule every 30 seconds.

everyThirtySeconds(): this

Frequency Methods - Every Minute

everyMinute()

Run the schedule every minute.

everyMinute(): this

Example

scheduler.command('queue:process').everyMinute()

everyMinutes()

Run the schedule every N minutes.

everyMinutes(minutes: number): this

number

required

Number of minutes between executions

Example

scheduler.command('cache:clear').everyMinutes(15)

everyTwoMinutes()

Run the schedule every 2 minutes.

everyTwoMinutes(): this

everyThreeMinutes()

Run the schedule every 3 minutes.

everyThreeMinutes(): this

everyFourMinutes()

Run the schedule every 4 minutes.

everyFourMinutes(): this

everyFiveMinutes()

Run the schedule every 5 minutes.

everyFiveMinutes(): this

everyTenMinutes()

Run the schedule every 10 minutes.

everyTenMinutes(): this

everyFifteenMinutes()

Run the schedule every 15 minutes.

everyFifteenMinutes(): this

everyThirtyMinutes()

Run the schedule every 30 minutes.

everyThirtyMinutes(): this

Frequency Methods - Hourly

hourly()

Run the schedule every hour at the start of the hour.

hourly(): this

Example

scheduler.command('logs:rotate').hourly()

hourlyAt()

Run the schedule every hour at a specific minute offset.

hourlyAt(offset: string | number | number[]): this

string | number | number[]

required

The minute(s) of the hour to run (0-59). Can be a single value or an array for multiple times

Example

scheduler.command('sync:data')
  .hourlyAt(15) // Runs at :15 past every hour

scheduler.command('check:health')
  .hourlyAt([0, 30]) // Runs at :00 and :30 of every hour

everyHours()

Run the schedule every N hours with an optional minute offset.

everyHours(hours: number, offset?: string | number | number[]): this

number

required

Number of hours between executions

string | number | number[]

default:"0"

The minute(s) of the hour to run

Example

scheduler.command('db:backup').everyHours(6, 30)

everyOddHour()

Run the schedule every odd hour (1, 3, 5, etc.).

everyOddHour(offset?: string | number | number[]): this

string | number | number[]

default:"0"

The minute(s) of the hour to run

everyTwoHours()

Run the schedule every 2 hours.

everyTwoHours(offset?: string | number | number[]): this

everyThreeHours()

Run the schedule every 3 hours.

everyThreeHours(offset?: string | number | number[]): this

everyFourHours()

Run the schedule every 4 hours.

everyFourHours(offset?: string | number | number[]): this

everyFiveHours()

Run the schedule every 5 hours.

everyFiveHours(offset?: string | number | number[]): this

everySixHours()

Run the schedule every 6 hours.

everySixHours(offset?: string | number | number[]): this

Frequency Methods - Daily

daily()

Run the schedule once a day at midnight.

daily(): this

Example

scheduler.command('reports:daily').daily()

dailyAt()

Run the schedule once a day at a specific time.

dailyAt(time: string): this

string

required

Time in 24-hour format (e.g., '14:30', '9:00')

Example

scheduler.command('backup:database').dailyAt('2:30')

at()

Alias for dailyAt().

at(time: string): this

twiceDaily()

Run the schedule twice a day at specified hours.

twiceDaily(first?: number, second?: number): this

number

default:"1"

First hour of the day (0-23)

number

default:"13"

Second hour of the day (0-23)

Example

scheduler.command('sync:users').twiceDaily(8, 20)

twiceDailyAt()

Run the schedule twice a day at specified hours with a minute offset.

twiceDailyAt(first?: number, second?: number, offset?: number): this

number

default:"1"

First hour of the day (0-23)

number

default:"13"

Second hour of the day (0-23)

number

default:"0"

Minute offset (0-59)

Example

scheduler.command('sync:users').twiceDailyAt(8, 20, 30) // 8:30 and 20:30

Frequency Methods - Weekly

weekdays()

Run the schedule on weekdays (Monday through Friday).

weekdays(): this

Example

scheduler.command('reports:business').dailyAt('9:00').weekdays()

weekends()

Run the schedule on weekends (Saturday and Sunday).

weekends(): this

mondays()

Run the schedule on Mondays.

mondays(): this

tuesdays()

Run the schedule on Tuesdays.

tuesdays(): this

wednesdays()

Run the schedule on Wednesdays.

wednesdays(): this

thursdays()

Run the schedule on Thursdays.

thursdays(): this

fridays()

Run the schedule on Fridays.

fridays(): this

saturdays()

Run the schedule on Saturdays.

saturdays(): this

sundays()

Run the schedule on Sundays.

sundays(): this

days()

Run the schedule on specific days of the week.

days(days: number | number[]): this

number | number[]

required

Day(s) of the week (0 = Sunday, 6 = Saturday). Can be a single day or an array

Example

import scheduler from '@adonisjs/scheduler/services/main'

scheduler.command('reports:weekly')
  .dailyAt('10:00')
  .days([scheduler.MONDAY, scheduler.WEDNESDAY, scheduler.FRIDAY])

weekly()

Run the schedule once a week on Sunday at midnight.

weekly(): this

weeklyOn()

Run the schedule once a week on a specific day and time.

weeklyOn(dayOfWeek?: number, time?: string): this

number

default:"1"

Day of the week (0-7, where 0 and 7 are Sunday)

string

default:"'0:0'"

Time in 24-hour format

Example

scheduler.command('reports:weekly').weeklyOn(1, '9:00') // Monday at 9:00

Frequency Methods - Monthly

monthly()

Run the schedule once a month on the first day at midnight.

monthly(): this

Example

scheduler.command('reports:monthly').monthly()

monthlyOn()

Run the schedule once a month on a specific day and time.

monthlyOn(dayOfMonth?: number, time?: string): this

number

default:"1"

Day of the month (1-31)

string

default:"'0:0'"

Time in 24-hour format

Example

scheduler.command('billing:process').monthlyOn(15, '3:00')

twiceMonthly()

Run the schedule twice a month on specific days.

twiceMonthly(first?: number, second?: number, time?: string): this

number

default:"1"

First day of the month (1-31)

number

default:"13"

Second day of the month (1-31)

string

default:"'0:0'"

Time in 24-hour format

Example

scheduler.command('invoices:send').twiceMonthly(1, 15, '9:00')

lastDayOfMonth()

Run the schedule on the last day of every month.

lastDayOfMonth(time?: string): this

string

default:"'0:0'"

Time in 24-hour format

Example

scheduler.command('reports:monthly').lastDayOfMonth('23:00')

quarterly()

Run the schedule once every quarter (January, April, July, October) on the first day at midnight.

quarterly(): this

Example

scheduler.command('reports:quarterly').quarterly()

yearly()

Run the schedule once a year on January 1st at midnight.

yearly(): this

Example

scheduler.command('reports:annual').yearly()

yearlyOn()

Run the schedule once a year on a specific date and time.

yearlyOn(month?: number, dayOfMonth?: number, time?: string): this

number

default:"1"

Month (1-12)

number

default:"1"

Day of the month (1-31)

string

default:"'0:0'"

Time in 24-hour format

Example

scheduler.command('license:renew').yearlyOn(12, 31, '23:59')

Advanced Methods

cron()

Define a custom cron expression for the schedule.

cron(expression: string): this

string

required

A cron expression with 6 fields: seconds minutes hours dayOfMonth month dayOfWeek

Example

scheduler.command('custom:task').cron('0 30 2 * * 1-5')
// Runs at 2:30 AM on weekdays

getExpression()

Get the current cron expression for the schedule.

getExpression(): string

Returns: The current cron expression as a string Example

const schedule = scheduler.command('test').everyMinute()
console.log(schedule.getExpression()) // '0 * * * * *'

Day Constants

You can use day constants for better readability when scheduling:

import scheduler from '@adonisjs/scheduler/services/main'

scheduler.command('reports:weekly')
  .weeklyOn(scheduler.MONDAY, '9:00')

scheduler.command('maintenance')
  .dailyAt('3:00')
  .days([scheduler.SATURDAY, scheduler.SUNDAY])

Available constants:

SUNDAY = 0
MONDAY = 1
TUESDAY = 2
WEDNESDAY = 3
THURSDAY = 4
FRIDAY = 5
SATURDAY = 6

​Configuration Methods

​timezone()

​tag()

​immediate()

​skip()

​withoutOverlapping()

​Lifecycle Methods

​before()

​after()

​Frequency Methods - Every Second

​everySecond()

​everySeconds()

​everyFiveSeconds()

​everyTenSeconds()

​everyFifteenSeconds()

​everyThirtySeconds()

​Frequency Methods - Every Minute

​everyMinute()

​everyMinutes()

​everyTwoMinutes()

​everyThreeMinutes()

​everyFourMinutes()

​everyFiveMinutes()

​everyTenMinutes()

​everyFifteenMinutes()

​everyThirtyMinutes()

​Frequency Methods - Hourly

​hourly()

​hourlyAt()

​everyHours()

​everyOddHour()

​everyTwoHours()

​everyThreeHours()

​everyFourHours()

​everyFiveHours()

​everySixHours()

​Frequency Methods - Daily

​daily()

​dailyAt()

​at()

​twiceDaily()

​twiceDailyAt()

​Frequency Methods - Weekly

​weekdays()

​weekends()

​mondays()

​tuesdays()

​wednesdays()

​thursdays()

​fridays()

​saturdays()

​sundays()

​days()

​weekly()

​weeklyOn()

​Frequency Methods - Monthly

​monthly()

​monthlyOn()

​twiceMonthly()

​lastDayOfMonth()

​quarterly()

​yearly()

​yearlyOn()

​Advanced Methods

​cron()

​getExpression()

​Day Constants

Configuration Methods

timezone()

tag()

immediate()

skip()

withoutOverlapping()

Lifecycle Methods

before()

after()

Frequency Methods - Every Second

everySecond()

everySeconds()

everyFiveSeconds()

everyTenSeconds()

everyFifteenSeconds()

everyThirtySeconds()

Frequency Methods - Every Minute

everyMinute()

everyMinutes()

everyTwoMinutes()

everyThreeMinutes()

everyFourMinutes()

everyFiveMinutes()

everyTenMinutes()

everyFifteenMinutes()

everyThirtyMinutes()

Frequency Methods - Hourly

hourly()

hourlyAt()

everyHours()

everyOddHour()

everyTwoHours()

everyThreeHours()

everyFourHours()

everyFiveHours()

everySixHours()

Frequency Methods - Daily

daily()

dailyAt()

at()

twiceDaily()

twiceDailyAt()

Frequency Methods - Weekly

weekdays()

weekends()

mondays()

tuesdays()

wednesdays()

thursdays()

fridays()

saturdays()

sundays()

days()

weekly()

weeklyOn()

Frequency Methods - Monthly

monthly()

monthlyOn()

twiceMonthly()

lastDayOfMonth()

quarterly()

yearly()

yearlyOn()

Advanced Methods

cron()

getExpression()

Day Constants