Skip to main content

JobScheduleEvents

JobScheduleEvents: object

Job notification events.

Type declaration​

job()​

job: (event: JobData) => void

Raised at a job's regularly-scheduled time.

Parameters​

ParameterType
eventJobData

Returns​

void

Example​

import
{
  jobScheduler,
  JobData,
  JobScheduleEvent,
}
from '@rootsdk/server-app'

function subscribe()
{
  jobScheduler.addListener(JobScheduleEvent.Job, handleJobEvent);
}

const handleJobEvent = (event: JobData) =>
{
  const jobScheduleId: string = event.jobScheduleId;
  const resourceId:    string = event.resourceId;
  const tag:           string = event.tag || 'No tag';
  const jobTime:       Date   = event.jobTime;

  //...
};

job.missed()​

missed: (event: JobData) => void

Raised if your server wasn't available at the regularly-scheduled event time.

Parameters​
ParameterType
eventJobData
Returns​

void

Example​
import
{
  jobScheduler,
  JobData,
  JobScheduleEvent,
}
from '@rootsdk/server-app'

function subscribe()
{
  jobScheduler.addListener(JobScheduleEvent.JobMissed, handleJobMissedEvent);
}

const handleJobMissedEvent = (event: JobData) =>
{
  const jobScheduleId: string = event.jobScheduleId;
  const resourceId:    string = event.resourceId;
  const tag:           string = event.tag || 'No tag';
  const jobTime:       Date   = event.jobTime;

  // ...
};