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/execution

k6/experimental

browser
redis
timers
tracing
websockets
webcrypto

k6/html

parseHTML( src )
Element
Selection

k6/http

asyncRequest( method, url, [body], [params] )
batch( requests )
cookieJar()
del( url, [body], [params] )
file( data, [filename], [contentType] )
get( url, [params] )
head( 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 )
url`url`
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 )
Params
Socket

Error Codes

k6.ioapp.k6.io

No results for “”

Powered byAlgolia
⚠️ This documentation is outdated. Please visit grafana.com for the latest k6 documentation.📚

WebSocket.onmessage

suggest edits

A handler for a WebSocket connection message event. For multiple, simultaneous event handlers, use WebSocket.addEventListener().

Example

A k6 script that initiates a WebSocket connection and sets up a handler for the message event.

example-websocket-onmessage.js
import { WebSocket } from 'k6/experimental/websockets';


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


  ws.onmessage = (data) => {
    console.log('a message received');
    console.log(data);
    ws.close();
  };
}

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

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