Interface: ElectronAPI

Defined in: shared/preloadApi.ts:18

Renderer-facing API exposed by the Electron preload script.

Hierarchy

View Summary

Extends

• ElectronApiDiagnosticsApi.ElectronAppInfoApi.ElectronClipboardApi.ElectronDevtoolsMenuApi.ElectronDialogApi.ElectronFileApi.ElectronFitBrowserApi.ElectronGyazoExternalApi.ElectronMainStateApi.ElectronMenuEventApi.ElectronPreloadEventApi.ElectronShellExternalApi.ElectronThemeApi

Properties

getChannelInfo

getChannelInfo: () => ChannelInfo;

Defined in: shared/preloadApiDomains.ts:53

Returns

ChannelInfo

Inherited from

ElectronApiDiagnosticsApi.getChannelInfo

---

validateAPI

validateAPI: () => boolean;

Defined in: shared/preloadApiDomains.ts:54

Returns

boolean

Inherited from

ElectronApiDiagnosticsApi.validateAPI

---

getAppVersion

getAppVersion: () => Promise<string>;

Defined in: shared/preloadApiDomains.ts:58

Returns

Promise<string>

Inherited from

ElectronAppInfoApi.getAppVersion

---

getChromeVersion

getChromeVersion: () => Promise<string>;

Defined in: shared/preloadApiDomains.ts:59

Returns

Promise<string>

Inherited from

ElectronAppInfoApi.getChromeVersion

---

getElectronVersion

getElectronVersion: () => Promise<string>;

Defined in: shared/preloadApiDomains.ts:60

Returns

Promise<string>

Inherited from

ElectronAppInfoApi.getElectronVersion

---

getLicenseInfo

getLicenseInfo: () => Promise<string>;

Defined in: shared/preloadApiDomains.ts:61

Returns

Promise<string>

Inherited from

ElectronAppInfoApi.getLicenseInfo

---

getNodeVersion

getNodeVersion: () => Promise<string>;

Defined in: shared/preloadApiDomains.ts:62

Returns

Promise<string>

Inherited from

ElectronAppInfoApi.getNodeVersion

---

getPlatformInfo

getPlatformInfo: () => Promise<PlatformInfo>;

Defined in: shared/preloadApiDomains.ts:63

Returns

Promise<PlatformInfo>

Inherited from

ElectronAppInfoApi.getPlatformInfo

---

writeClipboardPngDataUrl

writeClipboardPngDataUrl: (pngDataUrl: string) =>
 Promise<ClipboardResponsePayload>;

Defined in: shared/preloadApiDomains.ts:67

Parameters

pngDataUrl

string

Returns

Promise<ClipboardResponsePayload>

Inherited from

ElectronClipboardApi.writeClipboardPngDataUrl

---

writeClipboardText

writeClipboardText: (text: string) => Promise<ClipboardResponsePayload>;

Defined in: shared/preloadApiDomains.ts:70

Parameters

text

string

Returns

Promise<ClipboardResponsePayload>

Inherited from

ElectronClipboardApi.writeClipboardText

---

injectMenu

injectMenu: (
 theme?: DevtoolsInjectMenuTheme,
 fitFilePath?: DevtoolsInjectMenuFitFilePath
) => Promise<boolean>;

Defined in: shared/preloadApiDomains.ts:76

Parameters

theme?

DevtoolsInjectMenuTheme

fitFilePath?

DevtoolsInjectMenuFitFilePath

Returns

Promise<boolean>

Inherited from

ElectronDevtoolsMenuApi.injectMenu

---

openFile

openFile: () => Promise<string | null>;

Defined in: shared/preloadApiDomains.ts:87

Opens the native single-file FIT dialog; returns selected path or null when cancelled.

Returns

Promise<string | null>

Inherited from

ElectronDialogApi.openFile

---

openFileDialog

openFileDialog: () => Promise<string | null>;

Defined in: shared/preloadApiDomains.ts:89

Alias for openFile; returns selected path or null when cancelled.

Returns

Promise<string | null>

Inherited from

ElectronDialogApi.openFileDialog

---

openFolderDialog

openFolderDialog: () => Promise<string | null>;

Defined in: shared/preloadApiDomains.ts:94

Opens a folder picker dialog; returns selected folder path or null when cancelled.

Returns

Promise<string | null>

Inherited from

ElectronDialogApi.openFolderDialog

---

openOverlayDialog

openOverlayDialog: () => Promise<string[]>;

Defined in: shared/preloadApiDomains.ts:99

Opens the native multi-select overlay dialog; returns selected paths (possibly empty).

Returns

Promise<string[]>

Inherited from

ElectronDialogApi.openOverlayDialog

---

addRecentFile

addRecentFile: (filePath: string) => Promise<string[]>;

Defined in: shared/preloadApiDomains.ts:103

Parameters

filePath

string

Returns

Promise<string[]>

Inherited from

ElectronFileApi.addRecentFile

---

decodeFitFile

decodeFitFile: (arrayBuffer: ArrayBuffer) => Promise<FitDecodeResult>;

Defined in: shared/preloadApiDomains.ts:106

Parameters

arrayBuffer

ArrayBuffer

Returns

Promise<FitDecodeResult>

Inherited from

ElectronFileApi.decodeFitFile

---

parseFitFile

parseFitFile: (arrayBuffer: ArrayBuffer) => Promise<FitDecodeResult>;

Defined in: shared/preloadApiDomains.ts:107

Parameters

arrayBuffer

ArrayBuffer

Returns

Promise<FitDecodeResult>

Inherited from

ElectronFileApi.parseFitFile

---

readFile

readFile: (filePath: string) => Promise<ArrayBuffer>;

Defined in: shared/preloadApiDomains.ts:108

Parameters

filePath

string

Returns

Promise<ArrayBuffer>

Inherited from

ElectronFileApi.readFile

---

recentFiles

recentFiles: () => Promise<string[]>;

Defined in: shared/preloadApiDomains.ts:111

Returns

Promise<string[]>

Inherited from

ElectronFileApi.recentFiles

---

getFitBrowserFolder

getFitBrowserFolder: () => Promise<string | null>;

Defined in: shared/preloadApiDomains.ts:116

Get the persisted FIT browser folder (main process setting).

Returns

Promise<string | null>

Inherited from

ElectronFitBrowserApi.getFitBrowserFolder

---

isFitBrowserEnabled

isFitBrowserEnabled: () => Promise<FitBrowserEnabledResponse>;

Defined in: shared/preloadApiDomains.ts:117

Returns

Promise<FitBrowserEnabledResponse>

Inherited from

ElectronFitBrowserApi.isFitBrowserEnabled

---

listFitBrowserFolder

listFitBrowserFolder: (relPath?: string) => Promise<FitBrowserListFolderResult>;

Defined in: shared/preloadApiDomains.ts:119

List entries under the persisted FIT browser folder.

Parameters

relPath?

string

Returns

Promise<FitBrowserListFolderResult>

Inherited from

ElectronFitBrowserApi.listFitBrowserFolder

---

onFitBrowserEnabledChanged

onFitBrowserEnabledChanged: (callback: (enabled: boolean) => void) => () => void;

Defined in: shared/preloadApiDomains.ts:122

Parameters

callback

(enabled: boolean) => void

Returns

() => void

Inherited from

ElectronFitBrowserApi.onFitBrowserEnabledChanged

---

setFitBrowserEnabled

setFitBrowserEnabled: (enabled: boolean) => Promise<FitBrowserEnabledResponse>;

Defined in: shared/preloadApiDomains.ts:125

Parameters

enabled

boolean

Returns

Promise<FitBrowserEnabledResponse>

Inherited from

ElectronFitBrowserApi.setFitBrowserEnabled

---

setFitBrowserFolder

setFitBrowserFolder: (folderPath: string) => Promise<boolean>;

Defined in: shared/preloadApiDomains.ts:128

Parameters

folderPath

string

Returns

Promise<boolean>

Inherited from

ElectronFitBrowserApi.setFitBrowserFolder

---

onGyazoOAuthCallback

onGyazoOAuthCallback: (callback: (data: IpcResponsePayload) => void) => () => void;

Defined in: shared/preloadApiDomains.ts:134

Parameters

callback

(data: IpcResponsePayload) => void

Returns

() => void

Inherited from

ElectronGyazoExternalApi.onGyazoOAuthCallback

---

startGyazoServer

startGyazoServer: (port: number) => Promise<GyazoServerStartResult>;

Defined in: shared/preloadApiDomains.ts:137

Parameters

port

number

Returns

Promise<GyazoServerStartResult>

Inherited from

ElectronGyazoExternalApi.startGyazoServer

---

stopGyazoServer

stopGyazoServer: () => Promise<GyazoServerStopResult>;

Defined in: shared/preloadApiDomains.ts:140

Returns

Promise<GyazoServerStopResult>

Inherited from

ElectronGyazoExternalApi.stopGyazoServer

---

openExternal

openExternal: (url: string) => Promise<boolean>;

Defined in: shared/preloadApiDomains.ts:144

Parameters

url

string

Returns

Promise<boolean>

Inherited from

ElectronShellExternalApi.openExternal

---

getErrors

getErrors: (limit?: number) => Promise<MainStateErrorsResponse>;

Defined in: shared/preloadApiDomains.ts:150

Parameters

limit?

number

Returns

Promise<MainStateErrorsResponse>

Inherited from

ElectronMainStateApi.getErrors

---

getMainState

getMainState: (path?: string) => Promise<MainStateIpcValue>;

Defined in: shared/preloadApiDomains.ts:153

Parameters

path?

string

Returns

Promise<MainStateIpcValue>

Inherited from

ElectronMainStateApi.getMainState

---

getMetrics

getMetrics: () => Promise<MainStateIpcValue>;

Defined in: shared/preloadApiDomains.ts:154

Returns

Promise<MainStateIpcValue>

Inherited from

ElectronMainStateApi.getMetrics

---

getOperation

getOperation: (operationId: string) => Promise<MainStateIpcValue>;

Defined in: shared/preloadApiDomains.ts:155

Parameters

operationId

string

Returns

Promise<MainStateIpcValue>

Inherited from

ElectronMainStateApi.getOperation

---

getOperations

getOperations: () => Promise<MainStateIpcValue>;

Defined in: shared/preloadApiDomains.ts:158

Returns

Promise<MainStateIpcValue>

Inherited from

ElectronMainStateApi.getOperations

---

listenToMainState

listenToMainState: (path: string, callback: MainStateListener) =>
 Promise<boolean>;

Defined in: shared/preloadApiDomains.ts:159

Parameters

path

string

callback

MainStateListener

Returns

Promise<boolean>

Inherited from

ElectronMainStateApi.listenToMainState

---

setMainState

setMainState: (
 path: string,
 value: MainStateIpcValue,
 options?: Readonly<Record<string, MainStateIpcValue>>
) => Promise<boolean>;

Defined in: shared/preloadApiDomains.ts:163

Parameters

path

string

value

MainStateIpcValue

options?

Readonly<Record<string, MainStateIpcValue>>

Returns

Promise<boolean>

Inherited from

ElectronMainStateApi.setMainState

---

subscribeToMainState

subscribeToMainState: (path: string, callback: MainStateListener) =>
 Promise<() => Promise<boolean>>;

Defined in: shared/preloadApiDomains.ts:168

Parameters

path

string

callback

MainStateListener

Returns

Promise<() => Promise<boolean>>

Inherited from

ElectronMainStateApi.subscribeToMainState

---

unlistenFromMainState

unlistenFromMainState: (path: string, callback: MainStateListener) =>
 Promise<boolean>;

Defined in: shared/preloadApiDomains.ts:172

Parameters

path

string

callback

MainStateListener

Returns

Promise<boolean>

Inherited from

ElectronMainStateApi.unlistenFromMainState

---

checkForUpdates

checkForUpdates: () => void;

Defined in: shared/preloadApiDomains.ts:179

Returns

void

Inherited from

ElectronMenuEventApi.checkForUpdates

---

installUpdate

installUpdate: () => void;

Defined in: shared/preloadApiDomains.ts:180

Returns

void

Inherited from

ElectronMenuEventApi.installUpdate

---

onDecoderOptionsChanged

onDecoderOptionsChanged: (callback: (options: IpcResponsePayload) => void) => () => void;

Defined in: shared/preloadApiDomains.ts:181

Parameters

callback

(options: IpcResponsePayload) => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onDecoderOptionsChanged

---

onExportFile

onExportFile: (callback: (filePath: IpcResponsePayload) => void) => () => void;

Defined in: shared/preloadApiDomains.ts:184

Parameters

callback

(filePath: IpcResponsePayload) => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onExportFile

---

onMenuAbout

onMenuAbout: (callback: () => void) => () => void;

Defined in: shared/preloadApiDomains.ts:187

Parameters

callback

() => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onMenuAbout

---

onMenuCheckForUpdates

onMenuCheckForUpdates: (callback: () => void) => () => void;

Defined in: shared/preloadApiDomains.ts:188

Parameters

callback

() => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onMenuCheckForUpdates

---

onMenuExport

onMenuExport: (callback: () => void) => () => void;

Defined in: shared/preloadApiDomains.ts:189

Parameters

callback

() => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onMenuExport

---

onMenuKeyboardShortcuts

onMenuKeyboardShortcuts: (callback: () => void) => () => void;

Defined in: shared/preloadApiDomains.ts:190

Parameters

callback

() => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onMenuKeyboardShortcuts

---

onMenuOpenFile

onMenuOpenFile: (callback: () => void) => () => void;

Defined in: shared/preloadApiDomains.ts:191

Parameters

callback

() => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onMenuOpenFile

---

onMenuOpenOverlay

onMenuOpenOverlay: (callback: () => void) => () => void;

Defined in: shared/preloadApiDomains.ts:192

Parameters

callback

() => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onMenuOpenOverlay

---

onMenuPrint

onMenuPrint: (callback: () => void) => () => void;

Defined in: shared/preloadApiDomains.ts:193

Parameters

callback

() => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onMenuPrint

---

onMenuRestartUpdate

onMenuRestartUpdate: (callback: () => void) => () => void;

Defined in: shared/preloadApiDomains.ts:194

Parameters

callback

() => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onMenuRestartUpdate

---

onMenuSaveAs

onMenuSaveAs: (callback: () => void) => () => void;

Defined in: shared/preloadApiDomains.ts:195

Parameters

callback

() => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onMenuSaveAs

---

onOpenAccentColorPicker

onOpenAccentColorPicker: (callback: () => void) => () => void;

Defined in: shared/preloadApiDomains.ts:196

Parameters

callback

() => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onOpenAccentColorPicker

---

onOpenRecentFile

onOpenRecentFile: (callback: (filePath: string) => void) => () => void;

Defined in: shared/preloadApiDomains.ts:197

Parameters

callback

(filePath: string) => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onOpenRecentFile

---

onOpenSummaryColumnSelector

onOpenSummaryColumnSelector: (callback: () => void) => () => void;

Defined in: shared/preloadApiDomains.ts:198

Parameters

callback

() => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onOpenSummaryColumnSelector

---

onSetFontSize

onSetFontSize: (callback: (size: IpcResponsePayload) => void) => () => void;

Defined in: shared/preloadApiDomains.ts:199

Parameters

callback

(size: IpcResponsePayload) => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onSetFontSize

---

onSetHighContrast

onSetHighContrast: (callback: (mode: IpcResponsePayload) => void) => () => void;

Defined in: shared/preloadApiDomains.ts:200

Parameters

callback

(mode: IpcResponsePayload) => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onSetHighContrast

---

onSetTheme

onSetTheme: (callback: (theme: string) => void) => () => void;

Defined in: shared/preloadApiDomains.ts:203

Parameters

callback

(theme: string) => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onSetTheme

---

onShowNotification

onShowNotification: (callback: (...args: IpcResponsePayload[]) => void) => () => void;

Defined in: shared/preloadApiDomains.ts:204

Parameters

callback

(...args: IpcResponsePayload[]) => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onShowNotification

---

onUnloadFitFile

onUnloadFitFile: (callback: () => void) => () => void;

Defined in: shared/preloadApiDomains.ts:207

Parameters

callback

() => void

Returns

() => void

Inherited from

ElectronMenuEventApi.onUnloadFitFile

---

requestExport

requestExport: () => void;

Defined in: shared/preloadApiDomains.ts:208

Returns

void

Inherited from

ElectronMenuEventApi.requestExport

---

requestSaveAs

requestSaveAs: () => void;

Defined in: shared/preloadApiDomains.ts:209

Returns

void

Inherited from

ElectronMenuEventApi.requestSaveAs

---

sendThemeChanged

sendThemeChanged: (theme: string) => void;

Defined in: shared/preloadApiDomains.ts:210

Parameters

theme

string

Returns

void

Inherited from

ElectronMenuEventApi.sendThemeChanged

---

setFullScreen

setFullScreen: (flag: boolean) => void;

Defined in: shared/preloadApiDomains.ts:211

Parameters

flag

boolean

Returns

void

Inherited from

ElectronMenuEventApi.setFullScreen

---

onFileOpened?

optional onFileOpened?: (callback: (fileData: FitMessages, filePath: string) => void) => void;

Defined in: shared/preloadApiDomains.ts:216

Fired when a file is opened and parsed in main process.

Parameters

callback

(fileData: FitMessages, filePath: string) => void

Returns

void

Inherited from

ElectronPreloadEventApi.onFileOpened

---

notifyFitFileLoaded

notifyFitFileLoaded: (filePath: string | null) => void;

Defined in: shared/preloadApiDomains.ts:220

Notify main process of the currently loaded file (or null when cleared).

Parameters

filePath

string | null

Returns

void

Inherited from

ElectronPreloadEventApi.notifyFitFileLoaded

---

onUpdateEvent

onUpdateEvent: (eventName: UpdateEventName, callback: (...args: IpcResponsePayload[]) => void) => (() => void) | undefined;

Defined in: shared/preloadApiDomains.ts:221

Parameters

eventName

UpdateEventName

callback

(...args: IpcResponsePayload[]) => void

Returns

(() => void) | undefined

Inherited from

ElectronPreloadEventApi.onUpdateEvent

---

getTheme

getTheme: () => Promise<string>;

Defined in: shared/preloadApiDomains.ts:228

Returns

Promise<string>

Inherited from

ElectronThemeApi.getTheme