Runnable WebSocket Example

The canonical runnable example lives in examples/basic. It uses the default socket-store envelope:

{ "key": "talk", "data": { "name": "Browser", "message": "Hello" } }

Run From A Clean Checkout

Install dependencies:

npm install

Start the local WebSocket server:

npm run example:server

Expected server output:

socket-store example server listening on ws://localhost:3030

In a second terminal, start the browser client:

npm run example:client

Open the Vite URL printed by the client command.

Expected Flow

The browser connects to ws://localhost:3030, then the example server sends:

{ "key": "status", "data": { "connected": true } }

The status topic updates the connection text in the browser. The server also sends an initial talk topic message:

{
  "key": "talk",
  "data": {
    "name": "Server",
    "message": "Welcome. Send a message to see topic state update."
  }
}

Type a message in the input and submit the form. The browser calls store.send(...) with a talk envelope, the server broadcasts that envelope to connected clients, and the talk topic snapshot appends the message to the list.

Cleanup

Stop both terminals with Ctrl + C.

The example does not persist state or write runtime files. Stopping the server closes client WebSocket connections, releases port 3030, and causes the browser client to enter its onClose state.

Verification

The example client is type-checked by the repository lint script:

npm run example:typecheck