ElectronMainStateApi

FitFileViewer - API Documentation v30.0.1

---

FitFileViewer - API Documentation / shared/preloadApiDomains / ElectronMainStateApi

Interface: ElectronMainStateApi

Defined in: shared/preloadApiDomains.ts:149

Extended by

• ElectronAPI

Properties

getErrors

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

Defined in: shared/preloadApiDomains.ts:150

Parameters

limit?

number

Returns

Promise<MainStateErrorsResponse>

---

getMainState

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

Defined in: shared/preloadApiDomains.ts:153

Parameters

path?

string

Returns

Promise<MainStateIpcValue>

---

getMetrics

getMetrics: () => Promise<MainStateIpcValue>

Defined in: shared/preloadApiDomains.ts:154

Returns

Promise<MainStateIpcValue>

---

getOperation

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

Defined in: shared/preloadApiDomains.ts:155

Parameters

operationId

string

Returns

Promise<MainStateIpcValue>

---

getOperations

getOperations: () => Promise<MainStateIpcValue>

Defined in: shared/preloadApiDomains.ts:158

Returns

Promise<MainStateIpcValue>

---

listenToMainState

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

Defined in: shared/preloadApiDomains.ts:159

Parameters

path

string

callback

MainStateListener

Returns

Promise<boolean>

---

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>

---

subscribeToMainState

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

Defined in: shared/preloadApiDomains.ts:168

Parameters

path

string

callback

MainStateListener

Returns

Promise<() => Promise<boolean>>

---

unlistenFromMainState

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

Defined in: shared/preloadApiDomains.ts:172

Parameters

path

string

callback

MainStateListener

Returns

Promise<boolean>