package
Virtual TCP sockets for the browser - a net module shim for the web
npm install net-webGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 1 packages.
40.8 kB
Includes dependencies.
Virtual TCP sockets for the browser. A shim for Node's net module that uses in-memory EventEmitters instead of real network connections.
Browsers can't open TCP sockets. This module provides a virtual socket layer that allows code written for Node's net module to work in the browser. When paired with http-web and hsync, you can run an HTTP server entirely in a browser tab.
npm install net-webconst net = require('net-web');
const server = net.createServer((socket) => {
console.log('Client connected');
socket.on('data', (data) => {
console.log('Received:', data);
socket.write('Echo: ' + data);
});
socket.on('close', () => {
console.log('Client disconnected');
});
});
server.listen(3000const net = require('net-web');
const socket = net.Socket();
socket.on('data', (data) => {
console.log('Server says:', data);
});
socket.connect(3000, 'localhost', () => {
socket.write('Hello server!');
});server.close(() => {
console.log('Server closed');
});net.createServer(connectionListener)Creates a virtual server. The connectionListener is called for each incoming connection with a socket object.
Returns a server object with:
listen(port) - Start listening on a virtual portclose([callback]) - Stop listening and clean upnet.Socket()Creates a virtual client socket.
Returns a socket object with:
connect(port, [host], [callback]) - Connect to a serverwrite(data) - Send data to the connected serverend() - Close the connectionon(event, callback) - Listen for events ('data', 'close')net.eventsThe shared EventEmitter used for routing connections. Exposed for advanced use cases.
net.serversMap of active servers by port. Exposed for debugging.
Instead of real TCP connections, net-web uses a shared EventEmitter to route data between sockets:
server.listen(port) registers a listener for socket_connect_{port} eventssocket.connect(port) emits a socket_connect_{port} eventsocket.write() emits data events on the paired socketsocket.end() emits close eventsAll communication is synchronous and in-memory. The "port" is just an identifier for matching clients to servers.
The module maintains global state via globalThis.nodeNetWeb so that multiple modules importing net-web share the same event bus. This allows http-web to communicate with hsync through the same virtual ports.
ISC