@gluonjs/reactivity / packages/reactivity/src / invalidateJob

Function: invalidateJob()

invalidateJob(job): void

Parameters

job

SchedulerJob

Returns

void

Example

Remove a scheduled job before its flush phase when newer state makes the queued work obsolete:

import {
  invalidateJob,
  nextTick,
  queueJob,
  queuePostFlushCallback,
  queuePreFlushCallback,
  type EffectFlush,
  type FlushPhase,
  type SchedulerJob,
  type SchedulerJobOptions,
} from '@gluonjs/reactivity';

const order: string[] = [];
const cancelled: SchedulerJob = () => order.push('cancelled');
const update: SchedulerJob = () => order.push('update');
const phase: FlushPhase = 'update';
const flush: EffectFlush = 'post';
const options: SchedulerJobOptions = { phase, id: 10 };
queuePreFlushCallback(() => order.push('pre'));
queueJob(update, options);
queueJob(cancelled);
invalidateJob(cancelled);
queuePostFlushCallback(() => order.push(flush));
await nextTick();
console.log(order); // ['pre', 'update', 'post']