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.onmessage

WebSocket.onmessage

A handler for a WebSocket connection message event. For multiple, simultaneous event handlers, use WebSocket.addEventListener().

Example

A k6 script that initiates a WebSocket connection and sets up a handler for the message event.

JavaScript

Copy

JavaScript Copy

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

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

  ws.onmessage = (data) => {
    console.log('a message received');
    console.log(data);
    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