electron-ipc-module
    Preparing search index...

    Variable stream

    stream: <TArgs extends any[] = any[], TYield = any>(
        fn: IpcStreamHandler<TArgs, TYield, IpcEventMap>,
    ) => CloneableChannel<StreamDef<TArgs, TYield, IpcEventMap>, TArgs, TYield>

    Type Declaration

      • <TArgs extends any[] = any[], TYield = any>(
            fn: IpcStreamHandler<TArgs, TYield, IpcEventMap>,
        ): CloneableChannel<StreamDef<TArgs, TYield, IpcEventMap>, TArgs, TYield>
      • Register a streaming channel: every value the returned (async) iterable yields is sent to the renderer as one chunk, in order.

        event.signal is per invocation here, and aborts when the renderer cancels the stream or its WebContents is destroyed. Either way the iterator's return() runs, so a generator's finally blocks execute.

        Type Parameters

        • TArgs extends any[] = any[]
        • TYield = any

        Parameters

        Returns CloneableChannel<StreamDef<TArgs, TYield, IpcEventMap>, TArgs, TYield>