nexus
AdaptersNode IPC

Runtime Compatibility

Runtime and platform requirements for the Node IPC adapter.

@nexus-js/node-ipc uses filesystem Unix sockets through node:net, with node:path, node:os, and node:fs/promises for address and socket management.

EnvironmentUsage boundary
Node on LinuxPrimary runtime and documented test path.
Other Unix-like systemsRequire compatible filesystem Unix sockets; verify the daemon/client workflow on your target platform.
BunRepository CI does not verify Bun compatibility.
Browser bundlesNot supported; use a browser adapter instead.
ElectronUse for a local Unix socket daemon/client workflow, not as a replacement for Electron main/renderer IPC.

The transport uses neither child_process.fork() nor Bun.spawn({ ipc }) channels, and does not pass socket handles. Their serialization differences do not apply to this adapter.

The public address type reserves an abstract socket form; the documented and tested path uses filesystem sockets. See Addressing.

Edit this page on GitHub