# simple-ws

> A reconnect-able websocket client

Latest version **1.0.1** (published 2019-01-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-ws
pnpm add simple-ws
yarn add simple-ws
bun add simple-ws
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-01-12 |
| First published | 2019-01-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | FAN YINGHAO |
| Maintainers | fanyinghao |
| Keywords | websocket, reconnect |

## Links

- npm: https://www.npmjs.com/package/simple-ws
- Repository: https://github.com/fanyinghao/js-websocket-client
- Homepage: https://github.com/fanyinghao/js-websocket-client#readme
- Issues: https://github.com/fanyinghao/js-websocket-client/issues
- npm.io page: https://npm.io/package/simple-ws

## Dependencies (1)

- [ws](https://npm.io/package/ws.md) ^6.1.2

## Recent versions

- 1.0.1 (latest) — 2019-01-12
- 1.0.0 — 2019-01-11

## README

# simple-ws

[![NPM](https://img.shields.io/npm/v/simple-ws.svg)](https://www.npmjs.com/package/simple-ws)

A reconnect-able websocket client

# Example

```javascript
const { WebSocket } = require("simple-ws");

WebSocket.init({
  url: "wss://aaa.com",
  options: {
    headers: {
      Origin: "https://aaa.com",
      Authorization: "xxxx"
    }
  },
  onOpen: e => {
    console.log("Connected to server.");
  },
  onClose: e => {
    console.log(e);
  },
  onMessage: msg => {
    console.log(msg);
  },
  onError: e => {
    console.log(e);
  },
  onMessage: msg => {
    console.log(msg);
  }
});

WebSocket.send("ping");

WebSocket.close();
```

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