Menu

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

Open source

WebSocket.send(data)

Send data through the connection. You can use JSON.stringify to convert a JSON or JavaScript values to a JSON string.

ParameterTypeDescription
datastring / ArrayBuffer / Blob / ArrayBufferViewThe data to send.

Example

A k6 script that demonstrates how to add an event listener for the open WebSocket connection event sends a message and closes the connection.

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

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

  ws.onopen = () => {
    ws.send('lorem ipsum');
    ws.close();
  };
}

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

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