A module with a better and standard API exists
The new k6/experimental/websockets API partially implements the WebSockets API living standard.
When possible, we recommend using the new API. It uses a global event loop for consistency with other k6 APIs and better performance.
Set up callback functions for various events on the WebSocket connection. Multiple handlers can be defined for the same event.
Parameter | Type | Description |
---|---|---|
event | string | The event name to define a callback for. |
callback | function | The function to call when the event happens. |
Event name | Description |
---|---|
open | Emitted when the connection is established |
message | Emitted when a message is received from the server. |
ping | Emitted when a ping is received from the server. The client will automatically send back a pong. |
pong | Emitted when a pong is received from the server. |
close | Emitted when the connection is closed by the client Socket.close() or when the server sends the close event with code status 1000 (normal closure). |
error | Emitted when an error occurs. Non-normal closure errors will be forwarded. |