https://github.com/korkje/wsi

Asynchronously iterate WebSockets
https://github.com/korkje/wsi

deno iterator typescript websocket

Last synced: about 2 months ago
JSON representation

Asynchronously iterate WebSockets

• Host: GitHub
• URL: https://github.com/korkje/wsi
• Owner: korkje
• License: mit
• Created: 2023-08-07T20:59:26.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-04T11:43:22.000Z (about 2 years ago)
• Last Synced: 2025-03-28T17:24:39.969Z (about 1 year ago)
• Topics: deno, iterator, typescript, websocket
• Language: TypeScript
• Homepage:
• Size: 17.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

          
# wsi [![JSR](https://jsr.io/badges/@korkje/wsi)](https://jsr.io/@korkje/wsi)

Asynchronously iterate over `WebSocket` events.

```ts

import iterable from "jsr:@korkje/wsi";

const socket = new WebSocket("wss://echo.websocket.events");

for await (const data of iterable(socket)) {

    console.log(data);

    socket.send("hello");

}

```

Also exports `open` and `closed`, which create `Promise`s that resolve when the socket opens/closes.

```ts

import iterable, { open } from "jsr:@korkje/wsi";

const socket = new WebSocket("wss://echo.websocket.events");

await open(socket); // Socket is open

socket.send("hello");

for await (const data of iterable(socket)) {

    console.log(data);

    socket.send("hello");

}

```