Interface MockErrorApi

Mock implementation of the core-plugin-api#ErrorApi to be used in tests. Includes withForError and getErrors methods for error testing.

interface MockErrorApi {
    error$(): Observable<
        { context?: ErrorApiErrorContext; error: ErrorApiError },
    >;
    getErrors(): ErrorWithContext[];
    post(error: ErrorApiError, context?: ErrorApiErrorContext): void;
    waitForError(
        pattern: RegExp,
        timeoutMs?: number,
    ): Promise<ErrorWithContext>;
}

Implements

ErrorApi

Index

Methods

error$ getErrors post waitForError

Methods

error$

error$(): Observable<{ context?: ErrorApiErrorContext; error: ErrorApiError }>
Observe errors posted by other parts of the application.

Returns Observable<{ context?: ErrorApiErrorContext; error: ErrorApiError }>
Implementation of ErrorApi.error$
- Defined in packages/frontend-test-utils/src/apis/ErrorApi/MockErrorApi.ts:83

getErrors

getErrors(): ErrorWithContext[]
Returns ErrorWithContext[]
- Defined in packages/frontend-test-utils/src/apis/ErrorApi/MockErrorApi.ts:90

post

post(error: ErrorApiError, context?: ErrorApiErrorContext): void
Post an error for handling by the application.
Parameters
- error: ErrorApiError
- Optionalcontext: ErrorApiErrorContext
Returns void
Implementation of ErrorApi.post
- Defined in packages/frontend-test-utils/src/apis/ErrorApi/MockErrorApi.ts:66

waitForError

waitForError(pattern: RegExp, timeoutMs?: number): Promise<ErrorWithContext>
Parameters
- pattern: RegExp
- timeoutMs: number = 2000
Returns Promise<ErrorWithContext>
- Defined in packages/frontend-test-utils/src/apis/ErrorApi/MockErrorApi.ts:94