# nest-udp-adapter

> A Nest UDP adapter based on @nestjs/websockets

Latest version **0.1.0** (published 2023-09-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install nest-udp-adapter
pnpm add nest-udp-adapter
yarn add nest-udp-adapter
bun add nest-udp-adapter
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2023-09-28 |
| First published | 2023-09-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 106.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Chun-Kai Wang |
| Maintainers | chunkai1312 |
| Keywords | nest, nestjs, udp, udp-adapter |

## Links

- npm: https://www.npmjs.com/package/nest-udp-adapter
- npm.io page: https://npm.io/package/nest-udp-adapter

## Recent versions

- 0.1.0 (latest) — 2023-09-28

## README

# nest-udp-adapter

[![NPM version][npm-image]][npm-url]

> A Nest UDP adapter based on @nestjs/websockets

## Installation

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

```bash
$ npm install --save @nestjs/websockets nest-udp-adapter 
```

## Getting started

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

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

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

<table>
  <tr>
    <td><code>type</code></td>
    <td>Either <code>udp4</code> or <code>udp6</code> (default: <code>udp4</code>)</td>
  </tr>
  <tr>
    <td><code>port</code></td>
    <td>Destination port</td>
  </tr>
  <tr>
    <td><code>address</code></td>
    <td>Destination host name or IP address</td>
  </tr>
  <tr>
    <td><code>socketOptions</code></td>
    <td>dgram.SocketOptions (read more 
      <a
        href="https://nodejs.org/api/dgram.html#dgramcreatesocketoptions-callback"
        rel="nofollow"
        target="blank"
        >here</a
      >)</td>
  </tr>
  <tr>
    <td><code>bindOptions</code></td>
    <td>dgram.BindOptions (read more 
      <a
        href="https://nodejs.org/api/dgram.html#socketbindoptions-callback"
        rel="nofollow"
        target="blank"
        >here</a
      >)</td>
  </tr>
  <tr>
    <td><code>multicastAddress</code></td>
    <td>The IP multicast group address</td>
  </tr>
  <tr>
    <td><code>multicastInterface</code></td>
    <td>The local IP address associated with a network interface</td>
  </tr>
</table>

## Example

A working example is available [here](https://github.com/fugle-dev/nest-udp-adapter/tree/master/example).

## License

[MIT](LICENSE)

[npm-image]: https://img.shields.io/npm/v/nest-udp-adapter.svg
[npm-url]: https://npmjs.com/package/nest-udp-adapter

---
_Source: https://npm.io/package/nest-udp-adapter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._