Skip to content

Commit 7c23e99

Browse files
committed
docs: mark StopLoading channel and respective ElectronAPI function as deprecated
1 parent 21c9abb commit 7c23e99

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

src/shared/ipc-channels.ts

+3
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ export enum IpcChannel {
1212
ImportFileConvertAndLoad = 'import-file-convert-and-load',
1313
OpenLink = 'open-link',
1414
SaveFile = 'save-file',
15+
/**
16+
* @deprecated see https://github.com/opossum-tool/OpossumUI/issues/2812
17+
*/
1518
StopLoading = 'stop-loading',
1619
GetUserSettings = 'get-user-settings',
1720
SetUserSettings = 'set-user-settings',

src/shared/shared-types.ts

+3
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,9 @@ export interface ElectronAPI {
268268
) => Promise<boolean>;
269269
exportFile: (args: ExportArgsType) => void;
270270
saveFile: (saveFileArgs: SaveFileArgs) => void;
271+
/**
272+
* @deprecated see https://github.com/opossum-tool/OpossumUI/issues/2812
273+
*/
271274
stopLoading: () => void;
272275
on: (channel: AllowedFrontendChannels, listener: Listener) => () => void;
273276
getUserSetting: <T extends keyof UserSettings>(

0 commit comments

Comments
 (0)