dgram-as-promised

dgram-as-promised

This module provides promisified version of standard dgram class. The API is the same as for standard dgram, except bind, close and send methods which return Promise object.

Requirements

This module requires ES6 with Node >= 6.

Installation

npm install dgram-as-promised

Additionally for Typescript:

npm install -D @types/node

Transpiling this module with own settings in tsconfig.json:

{
  "compilerOptions": {
    "paths": {
      "dgram-as-promised": ["node_modules/dgram-as-promised/src/dgram-as-promised"]
    }
  }
}

Usage

dgram-as-promised can be used like standard dgram module.

Example:

const dgramAsPromised = require('dgram-as-promised')

const socket = dgramAsPromised.createSocket('udp4')

const MEMBERSHIP = '224.0.0.1'
const PORT = 41234

const message = Buffer.from('ABCDEFGH')

Typescript:

import dgramAsPromised from 'dgram-as-promised'

const socket = dgramAsPromised.createSocket('udp4')

Method bind returns Promise object which resolves to address info when listening event is emitted.

const address = await socket.bind()
console.log(`Socket is listening on ${address.address}:${address.port}`)

socket.setBroadcast(true)
socket.setMulticastTTL(128)

socket.addMembership(MEMBERSHIP)
console.log('Membership is set')

Method send returns Promise object which is fulfilled when message has been sent.

const bytes = await socket.send(message, 0, message.length, PORT, MEMBERSHIP)
console.log(`Message is sent (${bytes} bytes)`)

Method close returns Promise object which resolves to number of bytes sent when close event is emitted.

await socket.close()
console.log('Socket is closed')

License

Copyright (c) 2016-2018 Piotr Roszatycki mailto:[e-mail]

MIT

Changelog

v2.0.0 2018-09-09

• Rewritten in Typescript.
• Requires Node >= 6.
• Additional dgram option for createSocket.