docs
Javascript API

Init context

k6

k6/crypto

k6/data

k6/encoding

k6/execution

k6/html

k6/http

k6/metrics

k6/net/grpc

k6/ws

Error Codes

k6.ioapp.k6.io

No results for “”

Powered byAlgolia
⚠️ This is archived documentation for v0.34. Go to the latest version
Javascript API
k6/ws
Params

Params

suggest edits

Params is an object used by the WebSocket methods that generate WebSocket requests. Params contains request-specific options like headers that should be inserted into the request.

NameTypeDescription
Params.headersobjectObject with key-value pairs representing custom headers the user would like to add to the request.
Params.tagsobjectKey-value pairs where the keys are names of tags and the values are tag values. Response time metrics generated as a result of the request will have these tags added to them, allowing the user to filter out those results specifically, when looking at results data.

Example of custom metadata headers and tags

A k6 script that will make a WebSocket request with a custom header and tag results data with a specific tag

import ws from 'k6/ws';


export default function () {
  const url = 'ws://echo.websocket.org';
  const params = {
    headers: { 'X-MyHeader': 'k6test' },
    tags: { k6test: 'yes' },
  };
  const res = ws.connect(url, params, function (socket) {
    socket.on('open', function () {
      console.log('WebSocket connection established!');
      socket.close();
    });
  });
}