Creates a WebSocket instance for connection to a remote host.
The following events can close the connection:
- remote host close event.
- WebSocket.close().
- k6 VU interruption based on test configuration or CLI commands.
Parameter | Type | Description |
---|---|---|
url | string | The URL to which to connect (e.g. "ws://localhost:10000"). |
protocols | array | Not yet implemented, reserved for the future use. |
params | object | Params object containing additional request parameters. |
Returns
Type | Description |
---|---|
WebSocket | An instance of WebSocket object. |
Example
A k6 script that initiates a WebSocket connection.
example-websocket.js
The preceding example uses a WebSocket echo server, which you can run with the following command: