Skip to main content

Interface: AlertStore

Defined in: src/stores/alerts/useAlertStore.ts:106

Store contract for managing in-app alerts.

Propertiesโ€‹

alertsโ€‹

readonly alerts: StatusAlert[];

Defined in: src/stores/alerts/useAlertStore.ts:108

Ordered queue of active alerts (newest first).


clearAlertsโ€‹

readonly clearAlerts: () => void;

Defined in: src/stores/alerts/useAlertStore.ts:110

Removes all queued alerts.

Returnsโ€‹

void


clearToastsโ€‹

readonly clearToasts: () => void;

Defined in: src/stores/alerts/useAlertStore.ts:112

Removes all queued toasts.

Returnsโ€‹

void


dismissAlertโ€‹

readonly dismissAlert: (id: string) => void;

Defined in: src/stores/alerts/useAlertStore.ts:114

Removes a specific alert by identifier.

Parametersโ€‹

idโ€‹

string

Returnsโ€‹

void


dismissToastโ€‹

readonly dismissToast: (id: string) => void;

Defined in: src/stores/alerts/useAlertStore.ts:116

Removes a specific toast by identifier.

Parametersโ€‹

idโ€‹

string

Returnsโ€‹

void


enqueueAlertโ€‹

readonly enqueueAlert: (input: StatusAlertInput) => StatusAlert;

Defined in: src/stores/alerts/useAlertStore.ts:121

Enqueues a new alert and trims the queue to MAX_ALERT_QUEUE_LENGTH items.

Parametersโ€‹

inputโ€‹

StatusAlertInput

Returnsโ€‹

StatusAlert


enqueueToastโ€‹

readonly enqueueToast: (input: AppToastInput) => AppToast;

Defined in: src/stores/alerts/useAlertStore.ts:123

Enqueues a transient toast message.

Parametersโ€‹

inputโ€‹

AppToastInput

Returnsโ€‹

AppToast


toastsโ€‹

readonly toasts: AppToast[];

Defined in: src/stores/alerts/useAlertStore.ts:125

Ordered queue of transient toasts (newest first).