Menu
Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/experimentalbreadcrumb arrow websocketsbreadcrumb arrow WebSocketbreadcrumb arrow WebSocket.close([code])
Open source

WebSocket.close([code])

Close the WebSocket connection.

ParameterTypeDescription
code (optional)numberWebSocket status code. (default: 1000) . See the list of supported close codes.

Example

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

JavaScript 
import { WebSocket } from 'k6/experimental/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 
$ docker run --detach --rm --name ws-echo-server -p 10000:8080 jmalloc/echo-server