nest-udp2ws-adapter

A Nest WebSocket adapter for relaying UDP packets to ws server

Installation

To begin using it, we first install the required dependency.

$ npm install --save @nestjs/websockets nest-udp2ws-adapter ws
$ npm install --save-dev @types/ws

Getting started

Once the installation is complete, we can set up the adapter using useWebSocketAdapter() method:

const app = await NestFactory.create(AppModule);
app.useWebSocketAdapter(new Udp2wsAdapter(app, {
  type: 'udp4',
  port: 41234,
}));

The second argument of the Udp2wsAdapter constructor is an options object. This object may consist of seven members:

type	Either udp4 or udp6 (default: udp4)
port	Destination port
address	Destination host name or IP address
socketOptions	dgram.SocketOptions (read more here)
bindOptions	dgram.BindOptions (read more here)
multicastAddress	The IP multicast group address
multicastInterface	The local IP address associated with a network interface

Example

A working example is available here.

License

MIT