Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add mocking limitations #927

Merged
merged 1 commit into from
Feb 5, 2025
Merged

docs: add mocking limitations #927

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/electron-apis/mocking-apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

The service allows for mocking of Electron API functionality via a [Vitest](https://vitest.dev/)-like interface.

## Limitations

You can only mock Electron APIs available in the main process, no other mocking is supported.
Due to the internal use of an IPC bridge, the service does not currently support mocking of Electron APIs that manage IPC channels, e.g. `ipcMain`.

## Browser Utility Methods

### `mock`
Expand Down