# @payello/module-websocket

> WebSocket module

Latest version **0.0.2** (published 2023-07-27) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install @payello/module-websocket
pnpm add @payello/module-websocket
yarn add @payello/module-websocket
bun add @payello/module-websocket
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2023-07-27 |
| First published | 2023-07-27 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 26.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Payello |
| Maintainers | payellodev |

## Links

- npm: https://www.npmjs.com/package/@payello/module-websocket
- npm.io page: https://npm.io/package/@payello/module-websocket

## Recent versions

- 0.0.2 (latest) — 2023-07-27
- 0.0.1 — 2023-07-27

## README

# Websocket Module
Example:

```ts
import { WebsocketCloseEvent } from "../events/WebsocketCloseEvent"
import { WebsocketMessageEvent } from "../events/WebsocketMessageEvent"
import { WebsocketClient } from "../WebsocketClient"

function fetch(request: Request) {
    // accept the websocket
    let ws = new WebsocketClient()

    // listener for message
    ws.addEventListener("message", (event: WebsocketMessageEvent) => {
        let dataAsJson = event.json
        console.log("received data")
        console.log(dataAsJson)
        event.client.cache.last_message = dataAsJson
        event.client.send("We received your data")
    })

    // listener for close
    ws.addEventListener("close", (event: WebsocketCloseEvent) => {
        console.log("websocket closed!")
    })

    // send some data (converted to json string)
    ws.send({ hello: "world" })

    // send the HTTP 101 Switching Protocols Response back to client
    return ws.response
}
```

---
_Source: https://npm.io/package/@payello/module-websocket · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
