Skip to main content

Interface: MainStateApi

Defined in: preload/mainStateApi.ts:27

Properties​

getErrors​

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

Defined in: preload/mainStateApi.ts:28

Parameters​

limit?​

number

Returns​

Promise<MainStateErrorsResponse>

getMainState​

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

Defined in: preload/mainStateApi.ts:31

Parameters​

path?​

string

Returns​

Promise<MainStateIpcValue>

getMetrics​

getMetrics: () => Promise<MainStateIpcValue>;

Defined in: preload/mainStateApi.ts:32

Returns​

Promise<MainStateIpcValue>

getOperation​

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

Defined in: preload/mainStateApi.ts:33

Parameters​

operationId​

string

Returns​

Promise<MainStateIpcValue>

getOperations​

getOperations: () => Promise<MainStateIpcValue>;

Defined in: preload/mainStateApi.ts:36

Returns​

Promise<MainStateIpcValue>

listenToMainState​

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

Defined in: preload/mainStateApi.ts:37

Parameters​

path​

string

callback​

MainStateListener

Returns​

Promise<boolean>

setMainState​

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

Defined in: preload/mainStateApi.ts:41

Parameters​

path​

string

value​

MainStateIpcValue

options?​

Readonly<Record<string, MainStateIpcValue>>

Returns​

Promise<boolean>

subscribeToMainState​

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

Defined in: preload/mainStateApi.ts:46

Parameters​

path​

string

callback​

MainStateListener

Returns​

Promise<() => Promise<boolean>>

unlistenFromMainState​

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

Defined in: preload/mainStateApi.ts:50

Parameters​

path​

string

callback​

MainStateListener

Returns​

Promise<boolean>