Skip to main content

MainProcessStateClient

FitFileViewer - API Documentation v30.0.1

FitFileViewer - API Documentation / utils/state/integration/mainProcessStateClient / MainProcessStateClient

Class: MainProcessStateClient

Defined in: utils/state/integration/mainProcessStateClient.ts:174

Renderer-side interface to state held in the Electron main process.

Constructors​

Constructor​

new MainProcessStateClient(__namedParameters?: MainProcessStateClientOptions): MainProcessStateClient

Defined in: utils/state/integration/mainProcessStateClient.ts:184

Parameters​

__namedParameters?​

MainProcessStateClientOptions = {}

Returns​

MainProcessStateClient

Properties​

_isInitialized​

private _isInitialized: boolean = false

Defined in: utils/state/integration/mainProcessStateClient.ts:175

_electronApiScope​

private readonly _electronApiScope: RendererElectronApiScope | undefined

Defined in: utils/state/integration/mainProcessStateClient.ts:177

_listeners​

private readonly _listeners: Map<string, Set<(change: StateChangeEvent) => void>>

Defined in: utils/state/integration/mainProcessStateClient.ts:179

Methods​

_init()​

private _init(): void

Defined in: utils/state/integration/mainProcessStateClient.ts:191

Returns​

void

get()​

get(path?: MainProcessStateReadablePath): Promise<MainStateIpcValue>

Defined in: utils/state/integration/mainProcessStateClient.ts:216

Gets a value from main process state.

Parameters​

path?​

MainProcessStateReadablePath

Returns​

Promise<MainStateIpcValue>

Throws​

Error when the preload state bridge is unavailable or the IPC call fails.

getDiagnostics()​

getDiagnostics(): Promise<{ errors: MainStateIpcValue[]; metrics: MainStateIpcValue; operations: Record<string, Operation>; }>

Defined in: utils/state/integration/mainProcessStateClient.ts:236

Gets diagnostic state from the main process state manager.

Returns​

Promise<{ errors: MainStateIpcValue[]; metrics: MainStateIpcValue; operations: Record<string, Operation>; }>

getErrors()​

getErrors(limit?: number): Promise<MainStateIpcValue[]>

Defined in: utils/state/integration/mainProcessStateClient.ts:260

Gets recent state-manager errors.

Parameters​

limit?​

number = 50

Returns​

Promise<MainStateIpcValue[]>

Throws​

Error when the preload state bridge is unavailable or the IPC call fails.

getGyazoServerState()​

getGyazoServerState(): Promise<{ port: number | null; server: MainStateIpcValue; }>

Defined in: utils/state/integration/mainProcessStateClient.ts:275

Gets the current Gyazo server state from main process state.

Returns​

Promise<{ port: number | null; server: MainStateIpcValue; }>

getLoadedFilePath()​

getLoadedFilePath(): Promise<string | null>

Defined in: utils/state/integration/mainProcessStateClient.ts:288

Gets the currently loaded FIT file path.

Returns​

Promise<string | null>

getMainWindow()​

getMainWindow(): Promise<MainStateIpcValue>

Defined in: utils/state/integration/mainProcessStateClient.ts:293

Gets the serialized main window reference from state.

Returns​

Promise<MainStateIpcValue>

getMetrics()​

getMetrics(): Promise<MainStateIpcValue>

Defined in: utils/state/integration/mainProcessStateClient.ts:303

Gets performance metrics from the main process state manager.

Returns​

Promise<MainStateIpcValue>

Throws​

Error when the preload state bridge is unavailable or the IPC call fails.

getOperation()​

getOperation(operationId: string): Promise<MainStateIpcValue>

Defined in: utils/state/integration/mainProcessStateClient.ts:323

Gets the status of a specific operation.

Parameters​

operationId​

string

Returns​

Promise<MainStateIpcValue>

Throws​

Error when the preload state bridge is unavailable or the IPC call fails.

getOperations()​

getOperations(): Promise<Record<string, MainStateIpcValue>>

Defined in: utils/state/integration/mainProcessStateClient.ts:343

Gets all tracked operations from the main process state manager.

Returns​

Promise<Record<string, MainStateIpcValue>>

Throws​

Error when the preload state bridge is unavailable or the IPC call fails.

isAvailable()​

isAvailable(): boolean

Defined in: utils/state/integration/mainProcessStateClient.ts:358

Checks whether the preload state bridge is available.

Returns​

boolean

listen()​

listen(path: MainProcessStateListenPath, callback: (change: StateChangeEvent) => void): Promise<() => void>

Defined in: utils/state/integration/mainProcessStateClient.ts:369

Listens for changes to a specific main-process state path.

Parameters​

path​

MainProcessStateListenPath

callback​

(change: StateChangeEvent) => void

Returns​

Promise<() => void>

Throws​

TypeError when callback is not a function.

Throws​

Error when the preload state bridge is unavailable or the IPC call fails.

set()​

set(path: MainProcessStateWritablePath, value: MainStateIpcValue, options?: MainStateSetOptions): Promise<boolean>

Defined in: utils/state/integration/mainProcessStateClient.ts:405

Sets a value in renderer-writable main process state.

Parameters​

path​

MainProcessStateWritablePath

value​

MainStateIpcValue

options?​

MainStateSetOptions = {}

Returns​

Promise<boolean>

Throws​

Error when the preload state bridge is unavailable or the IPC call fails.

setLoadedFilePath()​

setLoadedFilePath(filePath: string | null): Promise<boolean>

Defined in: utils/state/integration/mainProcessStateClient.ts:438

Sets or clears the currently loaded FIT file path.

Parameters​

filePath​

string | null

Returns​

Promise<boolean>

requireElectronAPI()​

private requireElectronAPI(): MainStateElectronAPI

Defined in: utils/state/integration/mainProcessStateClient.ts:442

Returns​

MainStateElectronAPI

getElectronAPI()​

private getElectronAPI(): MainStateElectronAPI | null

Defined in: utils/state/integration/mainProcessStateClient.ts:451

Returns​

MainStateElectronAPI | null