Class: MainProcessState

Defined in: utils/state/integration/mainProcessStateManager.ts:193

Constructors

Constructor

new MainProcessState(): MainProcessState;

Defined in: utils/state/integration/mainProcessStateManager.ts:214

Returns

MainProcessState

Properties

data

data: MainProcessStateData;

Defined in: utils/state/integration/mainProcessStateManager.ts:194

---

listeners

listeners: Map<string, Set<StateListener>>;

Defined in: utils/state/integration/mainProcessStateManager.ts:196

---

middleware

middleware: (change: StateChange) => void | StateChange[];

Defined in: utils/state/integration/mainProcessStateManager.ts:198

Parameters

change

StateChange

Returns

void | StateChange

---

devMode

devMode: boolean;

Defined in: utils/state/integration/mainProcessStateManager.ts:200

---

_ipcHandlersRegistered

_ipcHandlersRegistered: boolean;

Defined in: utils/state/integration/mainProcessStateManager.ts:202

---

ipcSubscriptions

ipcSubscriptions: Map<string, () => void>;

Defined in: utils/state/integration/mainProcessStateManager.ts:204

---

operationCleanupTimers

operationCleanupTimers: Map<string, Timeout>;

Defined in: utils/state/integration/mainProcessStateManager.ts:206

---

senderCleanupRegistered

senderCleanupRegistered: Set<number>;

Defined in: utils/state/integration/mainProcessStateManager.ts:208

---

_senderFallbackIds

_senderFallbackIds: WeakMap<object, number>;

Defined in: utils/state/integration/mainProcessStateManager.ts:210

---

_nextSenderFallbackId

_nextSenderFallbackId: number;

Defined in: utils/state/integration/mainProcessStateManager.ts:212

Methods

addError()

addError(error:
  | string
  | Error, context?: LooseRecord): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:286

Parameters

error

| string | Error

context?

LooseRecord = {}

Returns

void

---

cleanupEventHandlers()

cleanupEventHandlers(): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:309

Clean up all event handlers

Returns

void

---

completeOperation()

completeOperation(operationId: string, result?: LooseRecord): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:335

Parameters

operationId

string

result?

LooseRecord = {}

Returns

void

---

failOperation()

failOperation(operationId: string, error:
  | string
  | Error): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:388

Parameters

operationId

string

error

| string | Error

Returns

void

---

get()

get(path: string): unknown;

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

Parameters

path

string

Returns

unknown

---

getByPath()

getByPath(obj: unknown, path: string): unknown;

Defined in: utils/state/integration/mainProcessStateManager.ts:453

Parameters

obj

unknown

path

string

Returns

unknown

---

getDevInfo()

getDevInfo(): {
  errors: number;
  eventHandlers: number;
  listeners: string[];
  operations: string[];
  state: MainProcessStateData;
  uptime: number;
};

Defined in: utils/state/integration/mainProcessStateManager.ts:485

Returns

{
  errors: number;
  eventHandlers: number;
  listeners: string[];
  operations: string[];
  state: MainProcessStateData;
  uptime: number;
}

errors

errors: number;

eventHandlers

eventHandlers: number;

listeners

listeners: string[];

operations

operations: string[];

state

state: MainProcessStateData;

uptime

uptime: number;

---

getSenderId()

getSenderId(sender: unknown): number;

Defined in: utils/state/integration/mainProcessStateManager.ts:510

Parameters

sender

unknown

Returns

number

---

getSerializableMetrics()

getSerializableMetrics(): Record<string, unknown>;

Defined in: utils/state/integration/mainProcessStateManager.ts:539

Convert metrics to a safe, IPC-serializable shape.

Returns

Record<string, unknown>

---

listen()

listen(path: string, callback: StateListener): () => void;

Defined in: utils/state/integration/mainProcessStateManager.ts:576

Parameters

path

string

callback

StateListener

Returns

Unsubscribe

() => void

---

makeSerializable()

makeSerializable(data: unknown): MainStateIpcValue;

Defined in: utils/state/integration/mainProcessStateManager.ts:609

Parameters

data

unknown

Returns

MainStateIpcValue

---

makeSubscriptionKey()

makeSubscriptionKey(sender: unknown, path: string): string;

Defined in: utils/state/integration/mainProcessStateManager.ts:672

Parameters

sender

unknown

path

string

Returns

string

---

notifyChange()

notifyChange(change: StateChange): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:684

Parameters

change

StateChange

Returns

void

---

notifyRenderers()

notifyRenderers(channel: string, data: unknown): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:729

Parameters

channel

string

data

unknown

Returns

void

---

recordMetric()

recordMetric(
   metric: string,
   value: unknown,
   metadata?: LooseRecord
): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:778

Parameters

metric

string

value

unknown

metadata?

LooseRecord = {}

Returns

void

---

registerEventHandler()

registerEventHandler(
   emitter: {
  off?: (event: string, handler: (...args: IpcHandlerArgs) => void) => void;
  on?: (event: string, handler: (...args: IpcHandlerArgs) => void) => void;
  removeListener?: (event: string, handler: (...args: IpcHandlerArgs) => void) => void;
},
   event: string,
   handler: (...args: IpcHandlerArgs) => void,
   handlerId?: string
): string;

Defined in: utils/state/integration/mainProcessStateManager.ts:820

Parameters

emitter

off?

(event: string, handler: (...args: IpcHandlerArgs) => void) => void

on?

(event: string, handler: (...args: IpcHandlerArgs) => void) => void

removeListener?

(event: string, handler: (...args: IpcHandlerArgs) => void) => void

event

string

handler

(...args: IpcHandlerArgs) => void

handlerId?

string

Returns

string

---

registerSenderCleanup()

registerSenderCleanup(sender: unknown): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:850

Ensure we clean up any subscriptions when a renderer/webContents is destroyed.

Parameters

sender

unknown

Returns

void

---

removeOperation()

removeOperation(operationId: string): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:889

Parameters

operationId

string

Returns

void

---

set()

set(
   path: string,
   value: unknown,
   options?: LooseRecord
): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:916

Parameters

path

string

value

unknown

options?

LooseRecord = {}

Returns

void

---

setByPath()

setByPath(
   obj: LooseRecord,
   path: string,
   value: unknown
): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:944

Parameters

obj

LooseRecord

path

string

value

unknown

Returns

void

---

setupIPCHandlers()

setupIPCHandlers(): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:980

Set up IPC handlers for renderer communication

Returns

void

---

startOperation()

startOperation(operationId: string, operationData?: LooseRecord): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:1301

Parameters

operationId

string

operationData?

LooseRecord = {}

Returns

void

---

unregisterEventHandler()

unregisterEventHandler(handlerId: string): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:1324

Parameters

handlerId

string

Returns

void

---

update()

update(updates: Record<string, unknown>, options?: LooseRecord): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:1352

Parameters

updates

Record<string, unknown>

options?

LooseRecord = {}

Returns

void

---

updateOperation()

updateOperation(operationId: string, updates: LooseRecord): void;

Defined in: utils/state/integration/mainProcessStateManager.ts:1389

Parameters

operationId

string

updates

LooseRecord

Returns

void