Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dex4er/js-dgram-as-promised
Promisify dgram module
https://github.com/dex4er/js-dgram-as-promised
hacktoberfest
Last synced: about 2 months ago
JSON representation
Promisify dgram module
- Host: GitHub
- URL: https://github.com/dex4er/js-dgram-as-promised
- Owner: dex4er
- License: mit
- Created: 2016-07-30T23:56:56.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-08T22:53:57.000Z (3 months ago)
- Last Synced: 2024-10-12T08:32:48.737Z (2 months ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/dgram-as-promised
- Size: 140 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# dgram-as-promised
[](https://github.com/dex4er/js-dgram-as-promised)
[](https://github.com/dex4er/js-dgram-as-promised/actions/workflows/ci.yaml)
[](https://github.com/dex4er/js-dgram-as-promised/actions/workflows/trunk.yaml)
[](https://coveralls.io/github/dex4er/js-dgram-as-promised)
[](https://www.npmjs.com/package/dgram-as-promised)
This module provides promisified version of the standard
[dgram](https://nodejs.org/api/dgram.html) class. The API is the same as for
standard `dgram`, except `bind`, `close` and `send` methods which return
[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
object.
## Requirements
This module requires ES2021 with Node >= 16.
## Installation
```shell
npm install dgram-as-promised
```
_Additionally for Typescript:_
```shell
npm install -D @types/node
```
## Usage
`dgram-as-promised` can be used similarly to the standard `dgram` module.
_Example:_
```js
import DgramAsPromised from "dgram-as-promised"
const socket = DgramAsPromised.createSocket("udp4")
const MEMBERSHIP = "224.0.0.1"
const PORT = 41234
const message = Buffer.from("ABCDEFGH")
```
### bind
Method `bind` returns `Promise` object which resolves to address info when
`listening` event is emitted.
```js
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")
```
### send
Method `send` returns `Promise` object which is fulfilled when the message
has been sent.
```js
const bytes = await socket.send(message, 0, message.length, PORT, MEMBERSHIP)
console.log(`Message is sent (${bytes} bytes)`)
```
### recv
Method `recv` returns `Promise` object which resolves to the object with `msg`
and `rinfo` properties as from `message` event or resolves to `undefined` when
the socket is already closed.
It throws an error if a timeout occurs and it was set by `setTimeout` method.
```js
const packet = await socket.recv()
if (packet) {
console.log(`Received message: ${packet.msg.toString()}`)
console.log(`Received ${packet.rinfo.size} bytes`)
}
```
### close
Method `close` returns `Promise` object which resolves when `close` event is
emitted or the socket is already closed.
```js
await socket.close()
console.log("Socket is closed")
```
### setTimeout
```js
socket = socket.setTimeout(ms)
```
Set the timeout used by `recv` method for the idle socket and after this
timeout, the `recv` method will reject a Promise with a timeout error.
After the error, the socket is not closed and calling another `recv` method
will reset the timeout.
The method returns this object.
_Example:_
```js
socket.setTimeout(1000)
await socket.recv()
```
### iterate
Method `iterate` and the socket object returns an asynchronous iterator which
will call `recv` method until the socket is closed.
```js
for await (const packet of socket) {
console.info(packet.msg.toString())
// Close socket if Ctrl-D is in the message
if (packet.msg.indexOf(4) !== -1) {
await socket.close()
}
}
```
### destroy
Method `destroy` cleans internal listeners.
```js
socket = socket.destroy()
```
The method returns this object.
## License
Copyright (c) 2016-2024 Piotr Roszatycki
[MIT](https://opensource.org/licenses/MIT)