Interface MockAlertApi

Mock implementation of @backstage/frontend-plugin-api#AlertApi for testing alert behavior.

Example

const alertApi = new MockAlertApi();
alertApi.post({ message: 'Test alert' });
expect(alertApi.getAlerts()).toHaveLength(1);

interface MockAlertApi {
    alert$(): Observable<AlertMessage>;
    clearAlerts(): void;
    getAlerts(): AlertMessage[];
    post(alert: AlertMessage): void;
    waitForAlert(
        predicate: (alert: AlertMessage) => boolean,
        timeoutMs?: number,
    ): Promise<AlertMessage>;
}

Implements

AlertApi

Index

Methods

alert$ clearAlerts getAlerts post waitForAlert

Methods

alert$

alert$(): Observable<AlertMessage>
Observe alerts posted by other parts of the application.

Returns Observable<AlertMessage>
Implementation of AlertApi.alert$
- Defined in packages/frontend-test-utils/src/apis/AlertApi/MockAlertApi.ts:42

clearAlerts

clearAlerts(): void
Clear all collected alerts.

Returns void
- Defined in packages/frontend-test-utils/src/apis/AlertApi/MockAlertApi.ts:64

getAlerts

getAlerts(): AlertMessage[]
Get all alerts that have been posted.

Returns AlertMessage[]
- Defined in packages/frontend-test-utils/src/apis/AlertApi/MockAlertApi.ts:57

post

post(alert: AlertMessage): void
Post an alert for handling by the application.
Parameters
- alert: AlertMessage
Returns void
Implementation of AlertApi.post
- Defined in packages/frontend-test-utils/src/apis/AlertApi/MockAlertApi.ts:37

waitForAlert

waitForAlert(
predicate: (alert: AlertMessage) => boolean,
timeoutMs?: number,
): Promise<AlertMessage>
Wait for an alert matching the given predicate.
Parameters
- predicate: (alert: AlertMessage) => boolean
  Function to test each alert
- timeoutMs: number = 2000
  Maximum time to wait in milliseconds
Returns Promise<AlertMessage>
Promise that resolves with the matching alert
- Defined in packages/frontend-test-utils/src/apis/AlertApi/MockAlertApi.ts:75