https://github.com/farwayer/wscl
Simple WebSocket wrapper with some extra features
https://github.com/farwayer/wscl
reconnect socket websocket websocket-client ws wss
Last synced: 9 months ago
JSON representation
Simple WebSocket wrapper with some extra features
- Host: GitHub
- URL: https://github.com/farwayer/wscl
- Owner: farwayer
- Created: 2019-05-22T14:06:31.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-02-19T03:29:37.000Z (over 1 year ago)
- Last Synced: 2025-10-07T11:03:08.521Z (9 months ago)
- Topics: reconnect, socket, websocket, websocket-client, ws, wss
- Language: JavaScript
- Homepage:
- Size: 5.91 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
## wscl
[](https://www.npmjs.com/package/wscl)
Simple WebSocket wrapper with some extra features:
- auto reconnect with exponential backoff strategy
- wait connection before sending messages
Lib is small. Its size [limited](https://github.com/ai/size-limit)
to **644 bytes** (with all deps, minified and brotlied).
## How to use
```shell
yarn add wscl
```
```js
import {Client, events} from 'wscl'
const wsc = new Client({
url: 'wss://echo.websocket.org',
})
wsc.on(events.Open, console.log)
wsc.on(events.Close, console.log)
wsc.on(events.Message, console.log) // will be called with data not event
wsc.on(events.Error, console.log) // will be called with error not event
// you can send message before connect
wsc.send("message")
await wsc.connect()
console.log(wsc.connected)
wsc.close("reason")
```