@gluonjs/reactivity / packages/reactivity/src / EffectOptions

Interface: EffectOptions

Properties

flush?

readonly optional flush?: EffectFlush

id?

readonly optional id?: number

lazy?

readonly optional lazy?: boolean

onError?

readonly optional onError?: ReactivityErrorHandler

onSchedule?

readonly optional onSchedule?: () => void

Returns

void

onStop?

readonly optional onStop?: () => void

Returns

void

onTrack?

readonly optional onTrack?: (event) => void

Parameters

event

EffectDebuggerEvent

Returns

void

onTrigger?

readonly optional onTrigger?: (event) => void

Parameters

event

EffectDebuggerEvent

Returns

void

Example

Configure effect scheduling, stop behavior, error handling, and development dependency-debug callbacks:

import {
  batch,
  effect,
  nextTick,
  ref,
  stop,
  untracked,
  type EffectDebuggerEvent,
  type EffectOptions,
  type ReactiveEffectRunner,
  type TrackOperation,
  type TriggerOperation,
} from '@gluonjs/reactivity';

const count = ref(0);
const debugEvents: EffectDebuggerEvent[] = [];
const options: EffectOptions = {
  onTrack: (event) => debugEvents.push(event),
  onTrigger: (event) => debugEvents.push(event),
};
const runner: ReactiveEffectRunner<number> = effect(() => count.value, options);
batch(() => { count.value += 1; count.value += 1; });
const snapshot = untracked(() => count.value);
await nextTick();
stop(runner);
const track: TrackOperation = 'get';
const trigger: TriggerOperation = 'set';
console.log(snapshot, debugEvents.length, track, trigger);