gbenm/ipc-shell

A wrapper for IPC objects

IPC Shell

Vea la página para más información.

Es una envoltura para objetos que realizan la comunicación entre procesos, en el estado inicial, está configurado para funcionar con los IPC de electron, este comportamiento puede cambiar sobreescribiendo las funciones _getArgsFromOn e _ipcNodeSend.

Como usar

Importe IPCNodeRegister y registre el IPC:

import { ipcMain } from "electron";
import { IPCNodeRegister } from "ipc-shell"

const ipc = IPCNodeRegister.register("main", ipcMain)

Nota: se usará IpcMain como el tipo de IPC, si fuera para el ipcRenderer debería usar IpcRenderer, para el ipc de win.webContents debería usar WebContents, hablando en términos de electronjs, en general usar la clase del IPC que registra.

Note que ahora ipc fue extendido. Colocando el tipo sería de la siguiente forma (por la inferencia de tipos lo de arriba está bien):

import { IpcMain, ipcMain } from "electron";
import { IPCNode, IPCNodeRegister } from "ipc-shell"

const ipc: IPCNode<IpcMain> = IPCNodeRegister.register("main", ipcMain)

A partir de ahora puede acceder en el mismo proceso a este IPC mediante su nombre:

// somewhere else

import { IpcMain } from "electron";
import { IPCNodeRegister } from "ipc-shell"

// using generic type (recommended)
const ipc = IPCNodeRegister.get<IpcMain>("main");

// using IPCNode type (import from ipc-shell)
const ipc: IPCNode<IpcMain> = IPCNodeRegister.get("main");

El hecho de que se agregue IpcMain es para que pueda seguir utilizando todos lo métodos y variables que este contenga más los extras, si no agrega el tipo únicamente podrá usar los de IPCNode.

Disclaimer

• This package use Object.assign().
• All in the IPCBaseNode interface is overwritten when it extends.

ipc-shell's Issues

Readable

Creo que podría crear un objecto interno _ipcNodeReadable que almacene un objeto Readable por ipc.

Funcionalidad

• Una sola instancia de Readable
• Al llamar readableStream(channel) se crea un Transform que sirve de filtro

IPCNodeError

IPCNodeError

Este es inservible ya que al pasar por el envio este pierde sus campos, por lo que la única forma que se tiene
para arreglar esto es lanzar un simple error (ya que esto es lo que llega al final).

Para mantener la clase lo que se puede hacer es lo siguiente:

1. Colocar una cadena especial para distinguir que es un error de IPC (por ejemplo un hash de 128 en hex)
2. Adjuntar después de la cadena especial un JSON con la información (después de aplicar JSON.stringify)
3. remover la huella y recuperar la información

Al final la clase de error debería de instanciarse como:

new IPCNodeError(info)

IPC Cache