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

Documentation Grafana k6 JavaScript API websockets WebSocket WebSocket.close([code])

WebSocket.close([code])

Close the WebSocket connection.

Example

A k6 script that initiates a WebSocket connection and closes it using the onopen handler.

JavaScript Copy

import { WebSocket } from 'k6/websockets';

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

  ws.onopen = () => {
    ws.close();
    console.log('connection closed');
  };
}

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

Bash Copy

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