Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

DocumentationGrafana k6JavaScript APIk6/experimentalwebsocketsWebSocketWebSocket.send(data)

WebSocket.send(data)

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

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

Copy

JavaScript Copy

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

Copy

bash Copy

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