# @idio/websocket [![npm version](https://badge.fury.io/js/%40idio%2Fwebsocket.svg)](https://www.npmjs.com/package/@idio/websocket) `@idio/websocket` Establishes _WebSocket_ Connections Between Clients And The Server. ```sh yarn add @idio/websocket npm i @idio/websocket ``` ## Table Of Contents - [Table Of Contents](#table-of-contents) - [API](#api) - [`websocket(server, config=): !Object`](#websocketserver-httpserverconfig-websocketconfig-objectstring-sendmessage) * [`WebSocketConfig`](#type-websocketconfig) - [`sendMessage(event, message): void`](#sendmessageevent-stringmessage--void) - [Copyright](#copyright)

## API The package is available by importing its default function: ```js import websocket from '@idio/websocket' ```

## websocket(_{`server: !http.Server,`
`config=: !WebSocketConfig,`}): !Object Sets up a listener for the `UPGRADE` event on the server, and stores all connected clients in the client list. When clients disconnect, they are removed from this list. The list is a hash object where each key is the _accept key_ sent by the client, and values are the callback functions to send messages to those clients. - server* !http.Server: The server on which to setup the listener. - config !WebSocketConfig (optional): Additional configuration. __`WebSocketConfig`__: Options for the web socket protocol communication. | Name | Type | Description | Default | | --------- | ---------------------------------------------------- | ------------------------------------------------------ | ------- | | log | boolean | Whether to log on connect and disconnect. | `true` | | onMessage | (clientID: string, message: string) => void | The callback when a message is received from a client. | - | | onConnect | (clientID: string) => void | The callback when a client is connected. | - | _With the following client-side implementation:_ ```js /* eslint-env browser */ const ws = new WebSocket(`ws://${location.host}`, 'json') setInterval(() => { if (ws.readyState == ws.OPEN) ws.send('') }, 2000) ws.addEventListener('message', async event => { const { message, event: e } = JSON.parse(event.data) console.log('Received %s:', e, message) window.WSstatus.innerText = message ws.send(navigator.userAgent) }) ``` _the server can be setup to listen for connections._ ```jsx /* yarn example/ */ import core, { render } from '@idio/idio' import websocket from '@idio/websocket' (async () => { const { url, server } = await core({ static: { use: true, root: 'example/frontend', }, index(ctx) { ctx.body = render( Websocket Example

Hello World.

Server says: