Class DirectIpcUtility<TMessageMap, TInvokeMap, TIdentifierStrings>

Utility process DirectIpc client Provides type-safe direct communication between utility processes and renderers

Type Parameters

TMessageMap extends EventMap = EventMap
Map of message channels to their handler function signatures (WITHOUT sender)
TInvokeMap extends InvokeMap = InvokeMap
Map of invoke channels to their handler function signatures (WITHOUT sender)
TIdentifierStrings extends string = string
Union of allowed identifier strings for type-safe identifier usage

Hierarchy (View Summary)

DirectIpcBase<
    TMessageMap,
    TInvokeMap,
    TIdentifierStrings,
    Electron.MessagePortMain,
>
- DirectIpcUtility

Constructors

constructor

new DirectIpcUtility<
    TMessageMap extends EventMap = EventMap,
    TInvokeMap extends InvokeMap = InvokeMap,
    TIdentifierStrings extends string = string,
>(
    options?: DirectIpcUtilityOptions<TIdentifierStrings>,
): DirectIpcUtility<TMessageMap, TInvokeMap, TIdentifierStrings>
Type Parameters
- TMessageMap extends EventMap = EventMap
  Map of message channels to their handler function signatures (WITHOUT sender)
- TInvokeMap extends InvokeMap = InvokeMap
  Map of invoke channels to their handler function signatures (WITHOUT sender)
- TIdentifierStrings extends string = string
  Union of allowed identifier strings for type-safe identifier usage
Parameters
- Optionaloptions: DirectIpcUtilityOptions<TIdentifierStrings>
Returns DirectIpcUtility<TMessageMap, TInvokeMap, TIdentifierStrings>
Overrides DirectIpcBase.constructor
- Defined in src/utility/DirectIpcUtility.ts:148

Properties

`Readonly`localEvents

localEvents: TypedEventEmitter<DirectIpcEventMap>

Local event emitter for lifecycle events

`Readonly`throttled

throttled: DirectIpcUtilityThrottled<
    TMessageMap,
    TInvokeMap,
    TIdentifierStrings,
>

Throttled message sending/receiving for high-frequency updates. Use this for lossy communication where only the latest value matters.

Example

// High-frequency position updates (throttled)
directIpc.throttled.send({ identifier: 'renderer' }, 'position-update', x, y)

// Important events (not throttled)
directIpc.send({ identifier: 'renderer' }, 'button-clicked')

Methods

addListener

addListener<E extends string | number | symbol>(
event: E,
listener: WithSender<TMessageMap>[E],
): this
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: WithSender<TMessageMap>[E]
Returns this
Inherited from DirectIpcBase.addListener
- Defined in src/common/DirectIpcTypes.ts:133

clearPendingInvokes

clearPendingInvokes(): void
Clean up all pending invokes (useful for testing or shutdown)

Returns void
Inherited from DirectIpcBase.clearPendingInvokes
- Defined in src/common/DirectIpcBase.ts:287

closeAllPorts

closeAllPorts(): void
Close all MessagePort connections

Returns void
Overrides DirectIpcBase.closeAllPorts
- Defined in src/utility/DirectIpcUtility.ts:201

emit

emit<Event extends string | number | symbol>(
event: Event | Event[],
...values: Parameters<WithSender<TMessageMap>[Event]>,
): boolean
Type Parameters
- Event extends string | number | symbol
Parameters
- event: Event | Event[]
- ...values: Parameters<WithSender<TMessageMap>[Event]>
Returns boolean
Inherited from DirectIpcBase.emit
- Defined in src/common/DirectIpcTypes.ts:142

eventNames

eventNames(): (string | symbol | keyof TMessageMap)[]
Returns (string | symbol | keyof TMessageMap)[]
Inherited from DirectIpcBase.eventNames
- Defined in src/common/DirectIpcTypes.ts:147

getDefaultTimeout

getDefaultTimeout(): number
Get the current default timeout

Returns number
Inherited from DirectIpcBase.getDefaultTimeout
- Defined in src/common/DirectIpcBase.ts:280

getMap

getMap(): DirectIpcTarget[]
Get the current array of all registered target processes

Returns DirectIpcTarget[]
Inherited from DirectIpcBase.getMap
- Defined in src/common/DirectIpcBase.ts:258

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from DirectIpcBase.getMaxListeners
- Defined in src/common/DirectIpcTypes.ts:152

getMyIdentifier

getMyIdentifier(): TIdentifierStrings | undefined
Get this process's identifier

Returns TIdentifierStrings | undefined
The identifier string or undefined if not set
Inherited from DirectIpcBase.getMyIdentifier
- Defined in src/common/DirectIpcBase.ts:266

getRegistrationState

getRegistrationState(): RegistrationState
Get current registration state

Returns RegistrationState
- Defined in src/utility/DirectIpcUtility.ts:728

handle

handle<T extends string | number | symbol>(
channel: T,
handler: WithSender<TInvokeMap>[T],
): void
Register a handler for invoke calls on a specific channel
Type Parameters
- T extends string | number | symbol
Parameters
- channel: T
- handler: WithSender<TInvokeMap>[T]
Returns void
Inherited from DirectIpcBase.handle
- Defined in src/common/DirectIpcBase.ts:237

invoke

invoke<K extends string | number | symbol>(
    target: Omit<
        TargetSelector<TIdentifierStrings>,
        "allIdentifiers" | "allUrls",
    >,
    channel: K,
    ...argsWithOptions: any[],
): Promise<Awaited<ReturnType<TInvokeMap[K]>>>
Invoke a handler on another process
Type Parameters
- K extends string | number | symbol
Parameters
- target: Omit<TargetSelector<TIdentifierStrings>, "allIdentifiers" | "allUrls">
- channel: K
- ...argsWithOptions: any[]
Returns Promise<Awaited<ReturnType<TInvokeMap[K]>>>
Overrides DirectIpcBase.invoke
- Defined in src/utility/DirectIpcUtility.ts:670

listenerCount

listenerCount<E extends string | number | symbol>(event: E): number
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
Returns number
Inherited from DirectIpcBase.listenerCount
- Defined in src/common/DirectIpcTypes.ts:150

listeners

listeners<E extends string | number | symbol>(
event: E,
): WithSender<TMessageMap>[E][]
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
Returns WithSender<TMessageMap>[E][]
Inherited from DirectIpcBase.listeners
- Defined in src/common/DirectIpcTypes.ts:149

off

off<E extends string | number | symbol>(
event: E,
listener: WithSender<TMessageMap>[E],
): this
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: WithSender<TMessageMap>[E]
Returns this
Inherited from DirectIpcBase.off
- Defined in src/common/DirectIpcTypes.ts:139

on

on<E extends string | number | symbol>(
event: E,
listener: WithSender<TMessageMap>[E],
): this
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: WithSender<TMessageMap>[E]
Returns this
Inherited from DirectIpcBase.on
- Defined in src/common/DirectIpcTypes.ts:134

once

once<E extends string | number | symbol>(
event: E,
listener: WithSender<TMessageMap>[E],
): this
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: WithSender<TMessageMap>[E]
Returns this
Inherited from DirectIpcBase.once
- Defined in src/common/DirectIpcTypes.ts:135

prependListener

prependListener<E extends string | number | symbol>(
event: E,
listener: WithSender<TMessageMap>[E],
): this
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: WithSender<TMessageMap>[E]
Returns this
Inherited from DirectIpcBase.prependListener
- Defined in src/common/DirectIpcTypes.ts:136

prependOnceListener

prependOnceListener<E extends string | number | symbol>(
event: E,
listener: WithSender<TMessageMap>[E],
): this
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: WithSender<TMessageMap>[E]
Returns this
Inherited from DirectIpcBase.prependOnceListener
- Defined in src/common/DirectIpcTypes.ts:137

rawListeners

rawListeners<E extends string | number | symbol>(
event: E,
): WithSender<TMessageMap>[E][]
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
Returns WithSender<TMessageMap>[E][]
Inherited from DirectIpcBase.rawListeners
- Defined in src/common/DirectIpcTypes.ts:148

removeAllListeners

removeAllListeners<E extends string | number | symbol>(event?: E): this
Type Parameters
- E extends string | number | symbol
Parameters
- Optionalevent: E
Returns this
Inherited from DirectIpcBase.removeAllListeners
- Defined in src/common/DirectIpcTypes.ts:140

removeHandler

removeHandler<T extends string | number | symbol>(channel: T): void
Remove a handler for a specific channel
Type Parameters
- T extends string | number | symbol
Parameters
- channel: T
Returns void
Inherited from DirectIpcBase.removeHandler
- Defined in src/common/DirectIpcBase.ts:250

removeListener

removeListener<E extends string | number | symbol>(
event: E,
listener: WithSender<TMessageMap>[E],
): this
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: WithSender<TMessageMap>[E]
Returns this
Inherited from DirectIpcBase.removeListener
- Defined in src/common/DirectIpcTypes.ts:141

send

send<K extends string | number | symbol>(
    target: TargetSelector<TIdentifierStrings>,
    message: K,
    ...args: Parameters<TMessageMap[K]>,
): Promise<void>
Send a message to another process
Type Parameters
- K extends string | number | symbol
Parameters
- target: TargetSelector<TIdentifierStrings>
- message: K
- ...args: Parameters<TMessageMap[K]>
Returns Promise<void>
Overrides DirectIpcBase.send
- Defined in src/utility/DirectIpcUtility.ts:524

setDefaultTimeout

setDefaultTimeout(ms: number): void
Set the default timeout for invoke calls
Parameters
- ms: number
Returns void
Inherited from DirectIpcBase.setDefaultTimeout
- Defined in src/common/DirectIpcBase.ts:273

setIdentifier

setIdentifier(identifier: TIdentifierStrings): void
Set this utility process's identifier
Parameters
- identifier: TIdentifierStrings
Returns void
- Defined in src/utility/DirectIpcUtility.ts:735

setMaxListeners

setMaxListeners(maxListeners: number): this
Parameters
- maxListeners: number
Returns this
Inherited from DirectIpcBase.setMaxListeners
- Defined in src/common/DirectIpcTypes.ts:153

`Static`instance

instance<
    TMessageMap extends EventMap = EventMap,
    TInvokeMap extends InvokeMap = InvokeMap,
    TProcessIdentifier extends string = string,
>(
    options?: DirectIpcUtilityOptions<TProcessIdentifier>,
): DirectIpcUtility<TMessageMap, TInvokeMap, TProcessIdentifier>
Get the singleton instance
Type Parameters
- TMessageMap extends EventMap = EventMap
- TInvokeMap extends InvokeMap = InvokeMap
- TProcessIdentifier extends string = string
Parameters
- Optionaloptions: DirectIpcUtilityOptions<TProcessIdentifier>
Returns DirectIpcUtility<TMessageMap, TInvokeMap, TProcessIdentifier>
- Defined in src/utility/DirectIpcUtility.ts:88

Class DirectIpcUtility<TMessageMap, TInvokeMap, TIdentifierStrings>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns DirectIpcUtility<TMessageMap, TInvokeMap, TIdentifierStrings>

Properties

ReadonlylocalEvents

Readonlythrottled

Example

Methods

addListener

Type Parameters

Parameters

Returns this

clearPendingInvokes

Returns void

closeAllPorts

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol | keyof TMessageMap)[]

getDefaultTimeout

Returns number

getMap

Returns DirectIpcTarget[]

getMaxListeners

Returns number

getMyIdentifier

Returns TIdentifierStrings | undefined

getRegistrationState

Returns RegistrationState

handle

Type Parameters

Parameters

Returns void

invoke

Type Parameters

Parameters

Returns Promise<Awaited<ReturnType<TInvokeMap[K]>>>

listenerCount

Type Parameters

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns WithSender<TMessageMap>[E][]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

prependListener

Type Parameters

Parameters

Returns this

prependOnceListener

Type Parameters

Parameters

Returns this

rawListeners

Type Parameters

Parameters

`Readonly`localEvents

`Readonly`throttled

`Static`instance