PollingManager

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

Manages polling intervals for data refresh.

Remarks

Features:

• Independent intervals per subscription
• Visibility-aware (pause when tab hidden)
• Tracks tick count and error count
• Non-overlapping execution (waits for tick to complete)
• Pause/resume functionality
• Manual trigger support

The polling manager automatically pauses polling when the document becomes hidden (unless pauseWhenHidden is false) and resumes when visible again.

Example

const polling = new PollingManager();

// Start polling
polling.start('data-refresh', {
  interval: 10000,
  onTick: async () => {
    await fetchAndUpdateData();
  },
  immediate: true,
});

// Pause temporarily
polling.pause('data-refresh');

// Resume
polling.resume('data-refresh');

// Trigger immediately
await polling.triggerNow('data-refresh');

// Stop completely
polling.stop('data-refresh');

Constructors

Constructor

new PollingManager(): PollingManager

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

Returns

PollingManager

Methods

destroy()

destroy(): void

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

Clean up all resources and stop all polling.

Returns

void

Remarks

Should be called when the polling manager is no longer needed. After calling destroy, the polling manager should not be used.

Example

polling.destroy();

---

getActiveIds()

getActiveIds(): string[]

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

Get all active polling subscription IDs.

Returns

string[]

Array of subscription IDs

Example

const ids = polling.getActiveIds();
console.log(`Active pollers: ${ids.join(', ')}`);

---

getState()

getState(id): PollingState | null

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

Get the current state of a polling subscription.

Parameters

Parameter	Type	Description
id	string	Subscription identifier

Returns

PollingState | null

Current state or null if not found

Example

const state = polling.getState('layer-1');
if (state) {
  console.log(`Ticks: ${state.tickCount}, Errors: ${state.errorCount}`);
}

---

has()

has(id): boolean

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

Check if a polling subscription exists.

Parameters

Parameter	Type	Description
id	string	Subscription identifier

Returns

boolean

True if the subscription exists

Example

if (polling.has('layer-1')) {
  polling.pause('layer-1');
}

---

pause()

pause(id): void

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

Pause a polling subscription without stopping it.

Parameters

Parameter	Type	Description
id	string	Subscription identifier

Returns

void

Remarks

Paused subscriptions can be resumed with resume. The subscription maintains its state while paused.

Example

polling.pause('layer-1');

---

pauseAll()

pauseAll(): void

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

Pause all active polling subscriptions.

Returns

void

Example

polling.pauseAll();

---

resume()

resume(id): void

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

Resume a paused polling subscription.

Parameters

Parameter	Type	Description
id	string	Subscription identifier

Returns

void

Example

polling.resume('layer-1');

---

resumeAll()

resumeAll(): void

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

Resume all paused polling subscriptions.

Returns

void

Example

polling.resumeAll();

---

setInterval()

setInterval(id, interval): void

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

Update the interval for an active polling subscription.

Parameters

Parameter	Type	Description
id	string	Subscription identifier
interval	number	New interval in milliseconds (minimum 1000ms)

Returns

void

Throws

Error if the subscription doesn’t exist

Remarks

The new interval takes effect after the current tick completes.

Example

polling.setInterval('layer-1', 10000);

---

start()

start(id, config): void

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

Start a new polling subscription.

Parameters

Parameter	Type	Description
id	string	Unique identifier for the subscription
config	PollingConfig	Polling configuration

Returns

void

Throws

Error if a subscription with the same ID already exists

Example

polling.start('layer-1', {
  interval: 5000,
  onTick: async () => {
    await updateLayerData();
  },
});

---

stop()

stop(id): void

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

Stop a polling subscription and clean up resources.

Parameters

Parameter	Type	Description
id	string	Subscription identifier

Returns

void

Example

polling.stop('layer-1');

---

stopAll()

stopAll(): void

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

Stop all polling subscriptions.

Returns

void

Example

polling.stopAll();

---

triggerNow()

triggerNow(id): Promise<void>

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

Trigger an immediate execution of the polling tick.

Parameters

Parameter	Type	Description
id	string	Subscription identifier

Returns

Promise<void>

Promise that resolves when the tick completes

Throws

Error if the subscription doesn’t exist

Remarks

This does not affect the regular polling schedule. The next scheduled tick will still occur at the expected time.

Example

await polling.triggerNow('layer-1');