Parameters
string
required
The event ID to cancel the job runs for. This is returned when calling either
client.sendEvent() or
io.sendEvent().
const event = client.sendEvent({
name: "test.job",
});
// Some time later...
const res = await client.cancelRunsForEvent(event.id);
console.log(res.cancelledRunIds);
console.log(res.failedToCancelRunIds);
Instance methods
TriggerClient: cancelRunsForEvent() Instance Method
The cancelRunsForEvent() instance method will cancel all the job runs (yet to be executed) that are triggered by a given eventId.
Was this page helpful?