Class DirectIpcBase<TMessageMap, TInvokeMap, TIdentifierStrings, TPort>`Abstract`

Abstract base class for DirectIpc implementations

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
TPort = MessagePort | Electron.MessagePortMain
Port type (MessagePort for renderer, MessagePortMain for utility)

Hierarchy (View Summary)

{
    addListener<E extends string | number | symbol>(
        event: E,
        listener: WithSender<TMessageMap>[E],
    ): this;
    emit<Event extends string | number | symbol>(
        event: Event | Event[],
        ...values: Parameters<WithSender<TMessageMap>[Event]>,
    ): boolean;
    eventNames(): (string | symbol | keyof TMessageMap)[];
    getMaxListeners(): number;
    listenerCount<E extends string | number | symbol>(event: E): number;
    listeners<E extends string | number | symbol>(
        event: E,
    ): WithSender<TMessageMap>[E][];
    off<E extends string | number | symbol>(
        event: E,
        listener: WithSender<TMessageMap>[E],
    ): this;
    on<E extends string | number | symbol>(
        event: E,
        listener: WithSender<TMessageMap>[E],
    ): this;
    once<E extends string | number | symbol>(
        event: E,
        listener: WithSender<TMessageMap>[E],
    ): this;
    prependListener<E extends string | number | symbol>(
        event: E,
        listener: WithSender<TMessageMap>[E],
    ): this;
    prependOnceListener<E extends string | number | symbol>(
        event: E,
        listener: WithSender<TMessageMap>[E],
    ): this;
    rawListeners<E extends string | number | symbol>(
        event: E,
    ): WithSender<TMessageMap>[E][];
    removeAllListeners<E extends string | number | symbol>(event?: E): this;
    removeListener<E extends string | number | symbol>(
        event: E,
        listener: WithSender<TMessageMap>[E],
    ): this;
    setMaxListeners(maxListeners: number): this;
}
- DirectIpcBase
  - DirectIpcRenderer
  - DirectIpcUtility

Constructors

constructor

new DirectIpcBase<
    TMessageMap extends EventMap = EventMap,
    TInvokeMap extends InvokeMap = InvokeMap,
    TIdentifierStrings extends string = string,
    TPort = MessagePortMain | MessagePort,
>(): DirectIpcBase<TMessageMap, TInvokeMap, TIdentifierStrings, TPort>
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
- TPort = MessagePortMain | MessagePort
  Port type (MessagePort for renderer, MessagePortMain for utility)
Returns DirectIpcBase<TMessageMap, TInvokeMap, TIdentifierStrings, TPort>
Overrides (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> })<TMessageMap>.constructor
- Defined in src/common/DirectIpcBase.ts:93

Properties

`Readonly`localEvents

localEvents: TypedEventEmitter<DirectIpcEventMap>

Local event emitter for lifecycle events

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 (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).addListener
- Defined in src/common/DirectIpcTypes.ts:133

clearPendingInvokes

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

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

`Abstract`closeAllPorts

closeAllPorts(): void
Close all MessagePort connections

Returns void
- Defined in src/common/DirectIpcBase.ts:143

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 (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).emit
- Defined in src/common/DirectIpcTypes.ts:142

eventNames

eventNames(): (string | symbol | keyof TMessageMap)[]
Returns (string | symbol | keyof TMessageMap)[]
Inherited from (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).eventNames
- Defined in src/common/DirectIpcTypes.ts:147

getDefaultTimeout

getDefaultTimeout(): number
Get the current default timeout

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

getMap

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

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

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).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
- Defined in src/common/DirectIpcBase.ts:266

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
- Defined in src/common/DirectIpcBase.ts:237

`Abstract`invoke

invoke<T extends string | number | symbol>(
    target: Omit<
        TargetSelector<TIdentifierStrings>,
        "allIdentifiers" | "allUrls",
    >,
    channel: T,
    ...args: any[],
): Promise<any>
Invoke a handler on a remote process
Type Parameters
- T extends string | number | symbol
Parameters
- target: Omit<TargetSelector<TIdentifierStrings>, "allIdentifiers" | "allUrls">
- channel: T
- ...args: any[]
Returns Promise<any>
- Defined in src/common/DirectIpcBase.ts:159

listenerCount

listenerCount<E extends string | number | symbol>(event: E): number
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
Returns number
Inherited from (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).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 (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).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 (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).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 (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).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 (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).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 (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).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 (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).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 (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).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 (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).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
- 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 (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).removeListener
- Defined in src/common/DirectIpcTypes.ts:141

`Abstract`send

send<T extends string | number | symbol>(
    target: TargetSelector<TIdentifierStrings>,
    message: T,
    ...args: TMessageMap[T] extends (...args: P) => any ? P : never,
): Promise<void>
Send a message to target(s) Base implementation handles common validation, subclasses override for specifics
Type Parameters
- T extends string | number | symbol
Parameters
- target: TargetSelector<TIdentifierStrings>
- message: T
- ...args: TMessageMap[T] extends (...args: P) => any ? P : never
Returns Promise<void>
- Defined in src/common/DirectIpcBase.ts:149

setDefaultTimeout

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

setMaxListeners

setMaxListeners(maxListeners: number): this
Parameters
- maxListeners: number
Returns this
Inherited from (EventEmitter as { new <TMessageMap extends EventMap>(): Prettify<TypedEventEmitter<WithSender<TMessageMap>>> }).setMaxListeners
- Defined in src/common/DirectIpcTypes.ts:153

Class DirectIpcBase<TMessageMap, TInvokeMap, TIdentifierStrings, TPort>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns DirectIpcBase<TMessageMap, TInvokeMap, TIdentifierStrings, TPort>

Properties

ReadonlylocalEvents

Methods

addListener

Type Parameters

Parameters

Returns this

clearPendingInvokes

Returns void

AbstractcloseAllPorts

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

handle

Type Parameters

Parameters

Returns void

Abstractinvoke

Type Parameters

Parameters

Returns Promise<any>

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

Returns WithSender<TMessageMap>[E][]

removeAllListeners

Type Parameters

Parameters

Returns this

Class DirectIpcBase<TMessageMap, TInvokeMap, TIdentifierStrings, TPort>`Abstract`

`Readonly`localEvents

`Abstract`closeAllPorts

`Abstract`invoke

`Abstract`send