Menu
Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/wsbreadcrumb arrow Socketbreadcrumb arrow Socket.close([code])
Open source

Socket.close([code])

Note

A module with a better and standard API exists.

The new k6/experimental/websockets API partially implements the WebSockets API living standard.

When possible, we recommend using the new API. It uses a global event loop for consistency with other k6 APIs and better performance.

Close the WebSocket connection.

ParameterTypeDescription
code (optional)numberWebSocket status code. (default: 1001)

Example

JavaScript 
import ws from 'k6/ws';

export default function () {
  const url = 'ws://echo.websocket.org';
  const response = ws.connect(url, null, function (socket) {
    socket.on('open', function () {
      socket.close();
    });
  });
}