An open API service indexing awesome lists of open source software.

https://github.com/lararosekelley/wslib

Lightweight, thoroughly tested WebSocket client with features like automatic reconnection
https://github.com/lararosekelley/wslib

javascript typescript websocket websocket-client ws

Last synced: 3 months ago
JSON representation

Lightweight, thoroughly tested WebSocket client with features like automatic reconnection

Awesome Lists containing this project

README

          

# WebSocket Client

> Lightweight, thoroughly tested WebSocket client with features like automatic reconnection

---

[![npm version](https://badge.fury.io/js/wslib.svg)](https://badge.fury.io/js/wslib)
[![build status](https://travis-ci.org/tylucaskelley/wslib.svg?branch=master)](https://travis-ci.org/tylucaskelley/wslib)
[![coverage status](https://coveralls.io/repos/github/tylucaskelley/wslib/badge.svg?branch=master)](https://coveralls.io/github/tylucaskelley/wslib?branch=master)

## Installation

Install with `yarn`:

```bash
$ yarn add wslib
```

Or, `npm` if you prefer:

```bash
$ npm install --save wslib
```

## Usage

Import the client and create a new instance:

```js
import { WebSocketClient } from 'wslib';
```

## Documentation

See the full documentation [here](https://wslib.tlk.codes).

## License

MIT License. See [LICENSE](./LICENSE) file for details.