Class RecurringTask

Base class for recurring tasks, which are supposed to be executed at a certain weekday & time each week.

Hierarchy

Constructors

constructor

Properties

arguments hour minute runner weekday

Methods

run shouldRunAtTime

Constructors

constructor

  • Creates a new recurring task, which will always get run at the specified day & time.

    Parameters

    • weekday: Weekday

      Weekday on which the task should run

    • hour: number

      Hour which the task should run

    • minute: number

      Minute which the task should run

    • runner: TaskExecutor

      Function to execute

    • Optional functionArguments: unknown[]

      Array of additional parameters to pass to the runner function

    Returns RecurringTask

Properties

Private Readonly arguments

arguments: unknown[]

Private Readonly hour

hour: number

Private Readonly minute

minute: number

Private Readonly runner

runner: TaskExecutor

Private Readonly weekday

weekday: Weekday

Methods

run

  • Runs this recurring task and catches exceptions.

    Parameters

    • client: Client<boolean>

      Client to run the task with

    Returns Promise<void>

shouldRunAtTime

  • Checks whether this task should be executed at the given time

    Returns

    Whether the task should be executed

    Parameters

    • time: DateTime

      Time to check against

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc