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.

Documentation Grafana k6 JavaScript API k6/experimental websockets WebSocket WebSocket.onclose

WebSocket.onclose

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

Example

A k6 script that initiates a WebSocket connection, sends a ping, and closes it using onopen handler. The console should also log WebSocket connection closed from the onclose handler.

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();
  };

  ws.onclose = () => {
    console.log('WebSocket connection closed!');
  };
}

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