# @collabs/ws-server

> Collabs WebSocket server

Latest version **0.13.4** (published 2023-09-06) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @collabs/ws-server
pnpm add @collabs/ws-server
yarn add @collabs/ws-server
bun add @collabs/ws-server
```

Provides the command `collabs-ws-server`.

## Health

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

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

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.13.4 |
| Published | 2023-09-06 |
| First published | 2021-10-02 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 356.7 KB |
| Known vulnerabilities | 0 (+11 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 288 |
| Author | Collabs contributors |
| Maintainers | heathermiller, mweidner037 |
| Keywords | Collabs, collaboration, local-first, WebSocket |

## Links

- npm: https://www.npmjs.com/package/@collabs/ws-server
- Repository: https://github.com/composablesys/collabs
- Homepage: https://github.com/composablesys/collabs/tree/master/ws-server#readme
- Issues: https://github.com/composablesys/collabs/issues
- npm.io page: https://npm.io/package/@collabs/ws-server

## Dependencies (4)

- [ws](https://npm.io/package/ws.md) ^8.13.0
- [tslib](https://npm.io/package/tslib.md) ^2.0.1
- [@types/ws](https://npm.io/package/@types/ws.md) ^8.5.5
- [protobufjs](https://npm.io/package/protobufjs.md) ~6.9.0

## 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

- 0.13.4 (latest) — 2023-09-06
- 0.13.3 — 2023-08-30
- 0.13.2 — 2023-08-29
- 0.13.1 — 2023-08-14
- 0.13.0 — 2023-08-14
- 0.12.0 — 2023-07-15
- 0.11.1 — 2023-06-24
- 0.11.0 — 2023-06-22
- 0.10.2 — 2023-04-22
- 0.10.1 — 2023-04-22
- 0.10.0 — 2023-04-19
- 0.9.1 — 2023-04-05
- 0.9.0 — 2023-04-02
- 0.8.1 — 2023-02-23
- 0.8.0 — 2023-02-20
- … 11 more at https://npm.io/package/@collabs/ws-server/versions

## README

# @collabs/ws-server

Part of the Collabs library. Main package: [@collabs/collabs](https://www.npmjs.com/package/@collabs/collabs).

**@collabs/ws-server** contains [WebSocketNetworkServer](https://collabs.readthedocs.io/en/latest/api/ws-server/classes/WebSocketNetworkServer.html). It listens to connections from [@collabs/ws-client](https://www.npmjs.com/package/@collabs/ws-client) clients and syncs updates between them. You can also configure it to store updates persistently and to authenticate clients.

This package also provides the `collabs-ws-server` command. It starts a WebSocketNetworkServer on `$PORT` (default: 3001) and `$HOST` (default: localhost) with in-memory storage and no authentication. This is useful for getting started with a Collabs app; see our [app template](https://github.com/composablesys/collabs-template-app) for an example.

## Docs

[Providers overview](https://collabs.readthedocs.io/en/latest/guide/providers.html)

[API](https://collabs.readthedocs.io/en/latest/api/ws-server)

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