Sudpee NPM | npm.io

                  __                           
                 /\ \                          
  ____  __  __   \_\ \  _____      __     __   
 /',__\/\ \/\ \  /'_` \/\ '__`\  /'__`\ /'__`\ 
/\__, `\ \ \_\ \/\ \L\ \ \ \L\ \/\  __//\  __/ 
\/\____/\ \____/\ \___,_\ \ ,__/\ \____\ \____\
 \/___/  \/___/  \/__,_ /\ \ \/  \/____/\/____/
                          \ \_\                
                           \/_/

Simple UDP for node.

Features

Sending and receiving unicast/broadcast messages via UDP
Automatically stringifies and parses sent and received JSON
CLI Tool

Documentation

Usage

Receving Data

const receiver = await sudpee.receive((message, info) => {}, [port], [address])

message received message (if string is JSON, it is automatically parsed to JSON)

info

{
  receiverAddress: string,
  receiverPort: number,
  senderAddress: string,
  senderPort: number,
  size: number,
}

port on which port to listen for data (default: 2020)
address on which address to listen for data (default: 0.0.0.0)
receiver.finish() close underlying socket
receiver.on('error', err => {}) callback for errors from the receiver

Sending Data

await sudpee.send(message, [port], [address])

message the message to be sent
port to which port to send (default: 2020)
address to which address to send (default=broadcast: 255.255.255.255)

Basic Example

import * as sudpee from 'sudpee';

(async () => {
  // receive UDP broadcast on port 3000
  await sudpee.receive(msg => console.log(msg), 3000)
  // send UDP broadcast to port 3000
  sudpee.send('Hello World', 3000)  
})()

$ Hello World

Advanced Example

import * as sudpee from 'sudpee';

(async () => {
  const end = 3

  const receiver = await sudpee.receive((msg, info) => {
    console.log('message: ', msg, `from: ${info.senderAddress}:${info.senderPort}`)
    // automatically parses JSON
    // .finish() closes the underlying socket
    if (msg.counter === end) receiver.finish()
  }, 3000, '192.168.1.23')

  receiver.on('error', err => console.error(err))

  for (let i = 1; i <= end; i++) {
    // automatically stringifies JSON
    await sudpee.send({ counter: i }, 3000, '192.168.1.23')
  }
})()

$ message:  { counter: 1 } from: 192.168.1.23:37357
$ message:  { counter: 2 } from: 192.168.1.23:58838
$ message:  { counter: 3 } from: 192.168.1.23:34600