https://github.com/litert/websocket.js

The WebSocket implementation written in TypeScript, for Node.JS
https://github.com/litert/websocket.js

websocket

Last synced: 3 months ago
JSON representation

The WebSocket implementation written in TypeScript, for Node.JS

• Host: GitHub
• URL: https://github.com/litert/websocket.js
• Owner: litert
• License: apache-2.0
• Created: 2023-11-03T02:30:39.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2026-03-31T03:50:17.000Z (3 months ago)
• Last Synced: 2026-03-31T05:52:37.557Z (3 months ago)
• Topics: websocket
• Language: TypeScript
• Homepage: https://litert.org/projects/websocket.js/
• Size: 576 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# LiteRT/WebSocket

[![Strict TypeScript Checked](https://badgen.net/badge/TS/Strict "Strict TypeScript Checked")](https://www.typescriptlang.org)

[![npm version](https://img.shields.io/npm/v/@litert/websocket.svg?colorB=brightgreen)](https://www.npmjs.com/package/@litert/websocket "Stable Version")

[![License](https://img.shields.io/npm/l/@litert/websocket.svg?maxAge=2592000?style=plastic)](https://github.com/litert/websocket.js/blob/master/LICENSE)

[![GitHub issues](https://img.shields.io/github/issues/litert/websocket.js.svg)](https://github.com/litert/websocket.js/issues)

[![GitHub Releases](https://img.shields.io/github/release/litert/websocket.js.svg)](https://github.com/litert/websocket.js/releases "Stable Release")

The WebSocket implementation written in TypeScript, for Node.JS.

## Installation

```sh

npm i @litert/websocket --save

```

## Usage

- [HTTP Demo](./src/examples/http/)

- [HTTPS Demo](./src/examples/https/)

## Requirements

- Node.js v18.x (Or newer)

- TypeScript v5.0.x (Or newer)

## Documentation

- [en-US](https://litert.org/projects/websocket.js/)

    - [Quick Start](https://litert.org/projects/websocket.js/guides/quick-start.html)

    - [FAQ](https://litert.org/projects/websocket.js/guides/faq.html)

    - [API Reference](https://litert.org/projects/websocket.js/api/)

## License

This library is published under [Apache-2.0](./LICENSE) license.