Typetron WebSockets

This library is used to easily listen and emit WebSockets action from the browser client to a Typetron app.

#### Installation

``bash
$ npm install @typetron/websockets
`

Note: you need to have a module loader in your app for this to work (webpack, rollup, babel, parcel, etc.)

#### Listening for actions

You can listen to a WebSocket action sent from the server using the _on('Action name')_ method like this on the socket
connection:

`ts
socket.on('actionName').subscribe(response => {
console.log('Backend response', response)
})
socket.on('user.update').subscribe(user => {
console.log('User updated', user)
})
`

The _on_ method will return an observable (see RxJS for more details) that you can use to subscribe
to.

#### Emitting actions

If you want to signal the server with an action or when you want to send some data to it, you can use the _emit('action
name', data)_ method:

`ts
socket.emit('actionName');
socket.emit('actionName', "my message here");
socket.emit('actionName', {my: {message: "here"}});
`

Be aware that if you are expecting a response from the backend, you need to subscribe to the same action (or the action
the server is emitting to) using the _.on_ method.

#### Emitting and listening for server response

If you want to make a single "request" to the server, meaning that you want to emit and wait for a response at the same
time, you can use the _request('action name', data?)_ method. This will essentially make an _emit_ and listen to its
response using the _on_ method for you:

`ts
const users = await socket.request('users.list')
const savedUser = await socket.request('users.save', {name: 'John'})
`

#### Message format of the WebSocket actions

The Typetron WebSocket server uses a specific message format when exchanging information between it and the clients.
These message have the following format:
_When sending a message:_

`json
{
"action": "action name",
"message": {
// optional
"body": "content sent to the controllers",
"parameters": [
"param1",
"param1"
]
// controller method parameters (optional)
}
}
`

_When receiving a message:_

`json
{
"action": "action name",
"status": "OK",
// or "Error",
"message": "backend response"
// optional
}
``