io.unregisterInterval()

io.unregisterInterval() allows you to unregister a DynamicSchedule that was previously registered with io.registerInterval().

This has been deprecated in favor of DynamicSchedule.unregister

Parameters

cacheKey · string · required

Should be a stable and unique cache key inside the run(). See resumability for more information.

dynamicSchedule · DynamicSchedule · required

A DynamicSchedule that will trigger any Jobs it’s attached to on a regular interval.

id · string · required

A unique id for the interval. This is used to identify and unregister the interval later.

Returns

A Promise with the following shape:

ok · boolean · required

Whether the interval was successfully unregistered.

Request

client.defineJob({
id: "unregister-job",
name: "Unregister dynamic schedule",
version: "0.1.1",
trigger: eventTrigger({
  name: "schedule.unregister",
  schema: z.object({
    id: z.string(),
  }),
}),
run: async (payload, io, ctx) => {
  //unregisters a DynamicSchedule with an interval 
  await io.unregisterInterval("❌📆", dynamicSchedule, payload.id);
},
});