Skip to main content

Interface: StatusUpdateHandlerOptions

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:52

Configuration options for status update handler operations.

Remarks​

Defines the required dependencies and callbacks for managing status update subscriptions. All functions should be stable references to avoid unnecessary re-subscriptions.

Properties​

fullResyncSites()​

fullResyncSites: () => Promise<void>

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:60

Function to trigger full sync from backend.

Returns​

Promise<void>

Remarks​

Called when incremental updates fail or when a complete refresh is needed.

getSites()​

getSites: () => Site[]

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:68

Function to get current sites array.

Returns​

Site[]

Remarks​

Should return the current state of sites from the store.

onUpdate()?​

optional onUpdate: (update: StatusUpdate) => void

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:77

Optional callback for additional processing of updates.

Parameters​

update​

StatusUpdate

Returns​

void

Remarks​

Called before applying the update to the store. Can be used for logging or side effects.

setSites()​

setSites: (sites: Site[]) => void

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:85

Function to set sites array in store.

Parameters​

sites​

Site[]

Returns​

void

Remarks​

Should update the store with the new sites array.