Interface ScheduleController

Controller returned by schedule() for managing a scheduled job.

interface ScheduleController {
    off(event: ScheduleEvent, handler: EventHandler): ScheduleController;
    on(event: ScheduleEvent, handler: EventHandler): ScheduleController;
    stop(): void;
}

Index

Methods

Methods

off

off(event: ScheduleEvent, handler: EventHandler): ScheduleController
Remove an event handler.
Parameters
- event: ScheduleEvent
- handler: EventHandler
Returns ScheduleController
- Defined in types.ts:65

on

on(event: ScheduleEvent, handler: EventHandler): ScheduleController
Register an event handler.
Parameters
- event: ScheduleEvent
- handler: EventHandler
Returns ScheduleController
- Defined in types.ts:63

stop

stop(): void
Stop the scheduled job. No further callbacks will fire.

Returns void
- Defined in types.ts:61