# @dartondox/websocket

> Websocket client library for dox framework

Latest version **1.0.14** (published 2023-08-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @dartondox/websocket
pnpm add @dartondox/websocket
yarn add @dartondox/websocket
bun add @dartondox/websocket
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.14 |
| Published | 2023-08-04 |
| First published | 2023-08-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Dox |
| Maintainers | necessarylion |
| Keywords | websocket, dox, client |

## Links

- npm: https://www.npmjs.com/package/@dartondox/websocket
- Repository: https://github.com/dartondox/dox-web-socket-client
- Homepage: https://github.com/dartondox/dox-web-socket-client#readme
- Issues: https://github.com/dartondox/dox-web-socket-client/issues
- npm.io page: https://npm.io/package/@dartondox/websocket

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.14 (latest) — 2023-08-04
- 1.0.13 — 2023-08-04
- 1.0.12 — 2023-08-04
- 1.0.11 — 2023-08-04
- 1.0.10 — 2023-08-04
- 1.0.9 — 2023-08-04
- 1.0.8 — 2023-08-04
- 1.0.7 — 2023-08-04
- 1.0.6 — 2023-08-04
- 1.0.5 — 2023-08-04
- 1.0.4 — 2023-08-04
- 1.0.3 — 2023-08-04
- 1.0.2 — 2023-08-04
- 1.0.1 — 2023-08-04
- 1.0.0 — 2023-08-02

## README

# Dox Websocket client

## Installation

##### Via cdn

```
https://cdn.jsdelivr.net/npm/@dartondox/websocket/dist/index.js
```

##### Via npm or yarn

```bash
$ npm install @dartondox/websocket
```
OR
```
$ yarn add @dartondox/websocket
```

## Usage

```js
import DoxWebsocket from '@dartondox/websocket';

const socket = DoxWebsocket('ws://127.0.0.1:3001/ws', {
  maxRetries: 18, retryAfter: 2000 
})

socket.onConnected(() => {
  console.log(socket.id)
})

socket.onError(() => {
  console.log('socket error')
})

socket.on('intro', (msg) => {
  console.log(msg)
})

socket.onClose(() => {
  console.log('socket closed')
})

function send() {
  socket.emit('intro', { data: message.value })
}
```

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