Kaizen
Browse modulesInsightsinsights/schedulingFunctions

Function: removeReportSchedule()

function removeReportSchedule(queue: ReportScheduleQueue, scheduleId: string): Promise<void>;

Defined in: server/insights/scheduling/report-schedule-queue.ts:130

Remove a schedule's repeating job. Idempotent: BullMQ returns false (not an error) when the scheduler id is already gone, so pausing an already-paused schedule, or deleting one whose scheduler never registered, is safe.

Parameters

ParameterType
queueReportScheduleQueue
scheduleIdstring

Returns

Promise<void>

On this page