electron-ipc-module
    Preparing search index...

    Type Alias TypedIpcMainInvokeEvent<TEmit>

    TypedIpcMainInvokeEvent: Omit<
        IpcMainInvokeEvent,
        "sender"
        | "senderFrame"
        | "signal",
    > & {
        sender: TypedWebContents<TEmit>;
        senderFrame: TypedWebFrameMain<TEmit> | null;
        signal: AbortSignal;
    }

    IpcMainInvokeEvent (for handle/handleOnce) with a typed sender and lifecycle signal.

    Type Parameters

    Type Declaration

    • sender: TypedWebContents<TEmit>
    • senderFrame: TypedWebFrameMain<TEmit> | null
    • Readonlysignal: AbortSignal

      Aborts when the WebContents that initiated this invocation is destroyed. Shared by every invocation from the same sender, and built on first read: reading it needs a global AbortController, so Electron 15 or newer.

      In a stream callback it is per invocation instead, and also aborts when the renderer cancels that stream.

    Settings
    Member Visibility