- Introduction
- Quick start
- Philosophy
- Comparison
- Default behaviors
- Limitations
- Debugging runbook
- FAQ
- Mocking HTTP
- Mocking GraphQL
- Mocking WebSocket
- Integrations
- API
- CLI
- Best practices
- Recipes
Server events
You can intercept the following WebSocket events from the original server:
Event name | Description |
---|---|
open | Dispatched when the server connection has been established. |
message | Dispatched when the server is sending a message to the client. |
error | Dispatched when the connection error occurs. |
close | Dispatched when the server has closed the connection. |
You can listen to those events by adding a respective event listener to the server
object anywhere in your event handler:
api.addEventListener('connection', ({ server }) => {
server.connect()
server.addEventListener('message', () => {})
})
You must establish the server connection before you can listen to any server events.
Intercepting server events
The open
event
api.addEventListener('connection', ({ server }) => {
server.connect()
server.addEventListener('open', (event) => {
console.log('Server connection opened', event)
})
})
The `message event
api.addEventListener('connection', ({ server }) => {
server.connect()
server.addEventListener('message', (event) => {
console.log('Received message from the server', event)
})
})
The error
event
api.addEventListener('connection', ({ server }) => {
server.connect()
server.addEventListener('error', (event) => {
console.log('Server connection errored', event)
})
})
The close
event
api.addEventListener('connection', ({ server }) => {
server.connect()
server.addEventListener('close', (event) => {
console.log('Server connection was closed', event)
})
})