Class JobQueue

constructor

• new JobQueue(bot: Bot): JobQueue

  Creates a new JobQueue instance.

  Parameters

  • bot: Bot

    The Bot client.

  Returns JobQueue

Readonlybot

OptionalerrorHandler

isRunning

_removeJob

• _removeJob(job: Job): void
  Internal

  Internal helper to remove a job from tracking and indexes.

  Parameters

  • job: Job

    Job instance to remove.

  Returns void

getJobsByChatId

• getJobsByChatId(chat_id: string | number): Job<unknown>[]

  Finds all jobs associated with a specific chat ID in O(1) time complexity.

  Parameters

  • chat_id: string | number

    Telegram chat ID.

  Returns Job<unknown>[]

  Array of matching Job instances.

  Example

  const chatJobs = app.scheduler.getJobsByChatId(123456);
  Copy

getJobsByName

• getJobsByName(name: string): Job<unknown>[]

  Finds all jobs matching a given name in O(1) time complexity.

  Parameters

  • name: string

    The job identifier name to filter by.

  Returns Job<unknown>[]

  Array of matching Job instances.

  Example

  const reminderJobs = app.scheduler.getJobsByName("daily_reminder");
  Copy

jobs

• jobs(): Job<unknown>[]

  Returns all active scheduled jobs currently managed by this queue.

  Returns Job<unknown>[]

  Array of active Job instances.

  Example

  const allJobs = app.scheduler.jobs();
  console.log(`Active jobs: ${allJobs.length}`);
  Copy

registerCallback

• registerCallback<Data = unknown>(
      name: string,
      callback: JobCallback<Data>,
  ): void

  Registers a named callback so persisted jobs can re-bind on application restart.

  Type Parameters

  • Data = unknown

  Parameters

  • name: string

    The job name.

  • callback: JobCallback<Data>

    The handler function.

  Returns void

restoreFromPersistedJobs

• restoreFromPersistedJobs(persistedList: PersistedJob[]): void

  Restores jobs from persistence using registered named callbacks.

  Parameters

  • persistedList: PersistedJob[]

    Array of stored PersistedJob records.

  Returns void

runDaily

• runDaily<Data = unknown>(
      callback: JobCallback<Data>,
      time: TimeOfDay,
      days?: number[],
      data?: Data,
      name?: string,
      chat_id?: string | number,
      user_id?: number,
  ): Job<Data>

  Schedules a job to run daily at a specified time and optional days of the week.

  Type Parameters

  • Data = unknown

  Parameters

  • callback: JobCallback<Data>

    The async function to execute.

  • time: TimeOfDay

    Specific hour, minute, and second of execution.

  • days: number[] = ...

    Array of weekday numbers (0 = Sunday, 6 = Saturday) when the job runs.

  • Optionaldata: Data

    Optional custom data payload.

  • Optionalname: string

    Optional job name.

  • Optionalchat_id: string | number

    Optional associated chat ID.

  • Optionaluser_id: number

    Optional associated user ID.

  Returns Job<Data>

  The created daily recurring Job instance.

runOnce

• runOnce<Data = unknown>(
      callback: JobCallback<Data>,
      when: number | Date,
      data?: Data,
      name?: string,
      chat_id?: string | number,
      user_id?: number,
  ): Job<Data>

  Schedules a one-off job to run after a specified duration or at a specific date.

  Type Parameters

  • Data = unknown

  Parameters

  • callback: JobCallback<Data>

    The async function to execute.

  • when: number | Date

    Number of seconds in the future or a Date object.

  • Optionaldata: Data

    Optional data payload passed to the job callback.

  • Optionalname: string

    Optional job name (defaults to anonymous identifier).

  • Optionalchat_id: string | number

    Optional associated chat ID.

  • Optionaluser_id: number

    Optional associated user ID.

  Returns Job<Data>

  The created Job instance.

runRepeating

• runRepeating<Data = unknown>(
      callback: JobCallback<Data>,
      interval: number,
      first?: number | Date,
      data?: Data,
      name?: string,
      chat_id?: string | number,
      user_id?: number,
  ): Job<Data>

  Schedules a recurring job that executes repeatedly at a fixed interval.

  Type Parameters

  • Data = unknown

  Parameters

  • callback: JobCallback<Data>

    The async function to execute.

  • interval: number

    Interval in seconds between executions.

  • Optionalfirst: number | Date

    Optional delay (seconds) or Date before the first run.

  • Optionaldata: Data

    Optional custom data payload.

  • Optionalname: string

    Optional job name.

  • Optionalchat_id: string | number

    Optional associated chat ID.

  • Optionaluser_id: number

    Optional associated user ID.

  Returns Job<Data>

  The created recurring Job instance.

runRRule

• runRRule<Data = unknown>(
      callback: JobCallback<Data>,
      options: RunRRuleOptions<Data>,
  ): Job<Data> | null

  Schedules a job using an RFC 5545 Recurrence Rule (RRule) with full Timezone support.

  Type Parameters

  • Data = unknown

  Parameters

  • callback: JobCallback<Data>

    The async function to execute.

  • options: RunRRuleOptions<Data>

    Configuration options specifying rrule, timezone, data, and job metadata.

  Returns Job<Data> | null

  The created recurring Job instance, or null if the rule cannot generate future occurrences.

  Example

  // Run every Monday, Wednesday, Friday at 9:00 AM in Vietnam timezone:
  app.scheduler.runRRule(
    async (context) => {
      await context.bot.sendMessage({ chat_id: 123456, text: "Morning team update!" });
    },
    {
      rrule: "FREQ=WEEKLY;BYDAY=MO,WE,FR;BYHOUR=9;BYMINUTE=0",
      timezone: "Asia/Ho_Chi_Minh",
    }
  );
  Copy

start

• start(): void

  Starts the job queue and activates all scheduled jobs.

  Returns void

stop

• stop(): void

  Stops the job queue and cancels all pending timeouts.

  Returns void

toPersistedJobs

• toPersistedJobs(): PersistedJob[]

  Serializes all active jobs into PersistedJob descriptors for persistence.

  Returns PersistedJob[]

  Array of PersistedJob records.