PollingConfig

Defined in: packages/core/src/data/polling-manager.ts:30

Configuration for a polling subscription.

Remarks

The polling manager ensures non-overlapping execution by waiting for each tick to complete before scheduling the next one. This prevents concurrent execution of the same polling task.

Example

const polling = new PollingManager();

polling.start('vehicles', {
  interval: 5000,
  onTick: async () => {
    const data = await fetch('/api/vehicles');
    updateMap(data);
  },
  onError: (error) => console.error(error),
  immediate: true,
  pauseWhenHidden: true,
});

Properties

Property	Type	Description	Defined in
immediate?	boolean	Execute immediately on start (default: false)	packages/core/src/data/polling-manager.ts:41
interval	number	Polling interval in milliseconds (minimum 1000ms)	packages/core/src/data/polling-manager.ts:32
onError?	(error) => void	Error handler for tick failures	packages/core/src/data/polling-manager.ts:38
onTick	() => Promise<void>	Function to execute on each tick	packages/core/src/data/polling-manager.ts:35
pauseWhenHidden?	boolean	Pause polling when document is hidden (default: true)	packages/core/src/data/polling-manager.ts:44