Skip to main content

MainProcessStateClient

FitFileViewer - API Documentation v29.4.0

FitFileViewer - API Documentation / mainProcessStateClient / MainProcessStateClient

Class: MainProcessStateClient

Defined in: utils/state/integration/mainProcessStateClient.js:27

Main Process State Client - Renderer-side interface to main process state

Constructors​

Constructor​

new MainProcessStateClient(): MainProcessStateClient

Defined in: utils/state/integration/mainProcessStateClient.js:28

Returns​

MainProcessStateClient

Properties​

_listeners​

_listeners: Map<string, Set<Function>>

Defined in: utils/state/integration/mainProcessStateClient.js:30

_isInitialized​

_isInitialized: boolean

Defined in: utils/state/integration/mainProcessStateClient.js:33

Methods​

_init()​

private _init(): void

Defined in: utils/state/integration/mainProcessStateClient.js:42

Initialize the client

Returns​

void

get()​

get(path?: string): Promise<any>

Defined in: utils/state/integration/mainProcessStateClient.js:68

Get a value from main process state

Parameters​

path?​

string

Optional path to specific state property

Returns​

Promise<any>

getDiagnostics()​

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

Defined in: utils/state/integration/mainProcessStateClient.js:85

Get diagnostic information

Returns​

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

getErrors()​

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

Defined in: utils/state/integration/mainProcessStateClient.js:100

Get recent errors

Parameters​

limit?​

number = 50

Maximum number of errors to retrieve

Returns​

Promise<ErrorEntry[]>

getGyazoServerState()​

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

Defined in: utils/state/integration/mainProcessStateClient.js:117

Get the Gyazo server state

Returns​

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

getLoadedFilePath()​

getLoadedFilePath(): Promise<string | null>

Defined in: utils/state/integration/mainProcessStateClient.js:127

Get the currently loaded FIT file path

Returns​

Promise<string | null>

getMainWindow()​

getMainWindow(): Promise<any>

Defined in: utils/state/integration/mainProcessStateClient.js:135

Get the main window reference

Returns​

Promise<any>

getMetrics()​

getMetrics(): Promise<Metrics>

Defined in: utils/state/integration/mainProcessStateClient.js:143

Get performance metrics

Returns​

Promise<Metrics>

getOperation()​

getOperation(operationId: string): Promise<Operation | null>

Defined in: utils/state/integration/mainProcessStateClient.js:161

Get the status of a specific operation

Parameters​

operationId​

string

Operation identifier

Returns​

Promise<Operation | null>

getOperations()​

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

Defined in: utils/state/integration/mainProcessStateClient.js:178

Get all operations

Returns​

Promise<Record<string, Operation>>

isAvailable()​

isAvailable(): boolean

Defined in: utils/state/integration/mainProcessStateClient.js:195

Check if the client is properly initialized

Returns​

boolean

listen()​

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

Defined in: utils/state/integration/mainProcessStateClient.js:205

Listen for changes to a specific state path

Parameters​

path​

string

Path to listen to

callback​

(change: StateChangeEvent) => void

Callback for state changes

Returns​

Promise<() => void>

Unsubscribe function

set()​

set(path: string, value: any, options?: Object): Promise<boolean>

Defined in: utils/state/integration/mainProcessStateClient.js:243

Set a value in main process state (restricted to allowed paths) Allowed paths: 'loadedFitFilePath', 'operations.*'

Parameters​

path​

string

Path to the state property

value​

any

Value to set

options?​

Object = {}

Optional metadata

Returns​

Promise<boolean>

True if successful

setLoadedFilePath()​

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

Defined in: utils/state/integration/mainProcessStateClient.js:268

Set the currently loaded FIT file path

Parameters​

filePath​

File path or null to clear

string | null

Returns​

Promise<boolean>