This is documentation for the next version of K6. For the latest stable release, go to the latest version.

Documentation Grafana k6 JavaScript API k6/experimental websockets WebSocket

WebSocket

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.

Returns

Example

A k6 script that initiates a WebSocket connection.

JavaScript

Copy

JavaScript Copy

import { WebSocket } from 'k6/experimental/websockets';

export default function () {
  const ws = new WebSocket('ws://localhost:10000');

  ws.onopen = () => {
    console.log('WebSocket connection established!');
    ws.close();
  };
}

The preceding example uses a WebSocket echo server, which you can run with the following command:

bash

Copy

bash Copy

$ docker run --detach --rm --name ws-echo-server -p 10000:8080 jmalloc/echo-server