UNPKG

@collabs/ws-server

Version:

Collabs WebSocket server

github.com/composablesys/collabs/tree/master/ws-server

composablesys/collabs

14 lines (7 loc) • 1.02 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# @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)