Class default

Special kind of Recurring Task that only gets executed in weeks, where lectures are held

Hierarchy

RecurringTask
- default

Index

Constructors

Properties

lookAheadDays kitDates

Methods

run shouldRunAtTime

Constructors

constructor

new default(weekday: Weekday, hour: number, minute: number, runner: TaskExecutor, functionArguments?: unknown[], lookAheadDays?: number): default
Creates a new recurring task, which will always get run at the specified day & time and when the day has lectures.
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
- Optional lookAheadDays: number
  
  Days to check in advance for being a day with lectures
Returns default
Overrides RecurringTask.constructor
- Defined in lib/tasks/universityDayRecurringtask.ts:25

Properties

`Private` lookAheadDays

lookAheadDays: number

`Static` `Private` kitDates

kitDates: default = ...

Methods

run

run(client: Client<boolean>): Promise<void>
Runs this recurring task and catches exceptions.
Parameters
- client: Client<boolean>
  
  Client to run the task with
Returns Promise<void>
Inherited from RecurringTask.run
- Defined in lib/tasks/recurringtask.ts:56

shouldRunAtTime

shouldRunAtTime(time: DateTime): boolean
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
Overrides RecurringTask.shouldRunAtTime
- Defined in lib/tasks/universityDayRecurringtask.ts:34

Generated using TypeDoc