Function createIpcHelpers

Returns {
    handle<TArgs extends any[] = any[], TResult = any>(
        fn: IpcHandler<TArgs, TResult, TEmit>,
    ): CloneableChannel<HandlerDef<TArgs, TResult, TEmit>, TArgs, TResult>;
    handleOnce<TArgs extends any[] = any[], TResult = any>(
        fn: IpcHandler<TArgs, TResult, TEmit>,
    ): CloneableChannel<HandlerDef<TArgs, TResult, TEmit>, TArgs, TResult>;
    listen<TArgs extends any[] = any[], TResult = any>(
        fn: IpcListener<TArgs, TResult, TEmit>,
    ): CloneableChannel<ListenerDef<TArgs, TResult, TEmit>, TArgs, unknown>;
    listenOnce<TArgs extends any[] = any[], TResult = any>(
        fn: IpcListener<TArgs, TResult, TEmit>,
    ): CloneableChannel<ListenerDef<TArgs, TResult, TEmit>, TArgs, unknown>;
}

• handle: function

  • handle<TArgs extends any[] = any[], TResult = any>(
        fn: IpcHandler<TArgs, TResult, TEmit>,
    ): CloneableChannel<HandlerDef<TArgs, TResult, TEmit>, TArgs, TResult>

    Register a request/response channel via ipcMain.handle.

    Type Parameters

    • TArgs extends any[] = any[]
    • TResult = any

    Parameters

    • fn: IpcHandler<TArgs, TResult, TEmit>

    Returns CloneableChannel<HandlerDef<TArgs, TResult, TEmit>, TArgs, TResult>

• handleOnce: function

  • handleOnce<TArgs extends any[] = any[], TResult = any>(
        fn: IpcHandler<TArgs, TResult, TEmit>,
    ): CloneableChannel<HandlerDef<TArgs, TResult, TEmit>, TArgs, TResult>

    Register a one-shot request/response channel via ipcMain.handleOnce.

    Scoped to the process, not a window: ipcMain is global, so the first caller from any window consumes the handler and every later invoke — including from other windows — rejects with "No handler registered". Use handle for anything a multi-window app can call more than once.

    Type Parameters

    • TArgs extends any[] = any[]
    • TResult = any

    Parameters

    • fn: IpcHandler<TArgs, TResult, TEmit>

    Returns CloneableChannel<HandlerDef<TArgs, TResult, TEmit>, TArgs, TResult>

• listen: function

  • listen<TArgs extends any[] = any[], TResult = any>(
        fn: IpcListener<TArgs, TResult, TEmit>,
    ): CloneableChannel<ListenerDef<TArgs, TResult, TEmit>, TArgs, unknown>

    Register a fire-and-forget channel via ipcMain.on.

    Type Parameters

    • TArgs extends any[] = any[]
    • TResult = any

    Parameters

    • fn: IpcListener<TArgs, TResult, TEmit>

    Returns CloneableChannel<ListenerDef<TArgs, TResult, TEmit>, TArgs, unknown>

• listenOnce: function

  • listenOnce<TArgs extends any[] = any[], TResult = any>(
        fn: IpcListener<TArgs, TResult, TEmit>,
    ): CloneableChannel<ListenerDef<TArgs, TResult, TEmit>, TArgs, unknown>

    Register a one-shot fire-and-forget channel via ipcMain.once.

    Process-scoped like handleOnce: the first message from any window consumes the listener, and later sends are silently ignored.

    Type Parameters

    • TArgs extends any[] = any[]
    • TResult = any

    Parameters

    • fn: IpcListener<TArgs, TResult, TEmit>

    Returns CloneableChannel<ListenerDef<TArgs, TResult, TEmit>, TArgs, unknown>