docs

Init context

open( filePath, [mode] )

k6

check( val, sets, [tags] )
fail( [err] )
group( name, fn )
randomSeed( int )
sleep( t )

k6/crypto

createHash( algorithm )
createHMAC( algorithm, secret )
hmac( algorithm, secret, data, outputEncoding )
md4( input, outputEncoding )
md5( input, outputEncoding )
randomBytes( int )
ripemd160( input, outputEncoding )
sha1( input, outputEncoding )
sha256( input, outputEncoding )
sha384( input, outputEncoding )
sha512( input, outputEncoding )
sha512_256( input, outputEncoding )
sha512_224( input, outputEncoding )
Hasher

k6/data

SharedArray

k6/encoding

b64decode( input, [encoding], [format] )
b64encode( input, [encoding] )

k6/html

parseHTML( src )
Element
Selection

k6/http

batch( requests )
cookieJar()
del( url, [body], [params] )
file( data, [filename], [contentType] )
get( url, [params] )
options( url, [body], [params] )
patch( url, [body], [params] )
post( url, [body], [params] )
put( url, [body], [params] )
request( method, url, [body], [params] )
setResponseCallback( callback )
expectedStatuses( statuses )
CookieJar
FileData
Params
Response

k6/metrics

Counter
Gauge
Rate
Trend

k6/net/grpc

Client
Params
Response
Constants

k6/ws

connect( url, params, callback )
Socket

Error Codes

k6.ioapp.k6.io

No results for “”

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

Params

suggest edits

Params is an object used by the gRPC methods that generate RPC 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.
Params.timeoutnumberRequest timeout to use. Default timeout is 60 seconds ("60s").

Example of custom metadata headers and tags

import grpc from 'k6/net/grpc';


const client = new grpc.Client();
client.load([], 'route_guide.proto');


export default function () {
  const req = {
    latitude: 410248224,
    longitude: -747127767,
  };
  const params = {
    headers: { 'x-my-header': 'k6test' },
    tags: { k6test: 'yes' },
  };
  const response = client.invoke('main.RouteGuide/GetFeature', req, params);
}