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.📚

Browser class

suggest edits

The Browser class is the entry point for all your tests, and it is what interacts with the actual web browser via Chrome DevTools Protocol (CDP). It manages:

  • BrowserContext which is where you can set a variety of attributes to control the behavior of pages;
  • and Page which is where your rendered site is displayed.

A new Browser instance (hence a new browser process) can be created using the launch() method of the chromium module from 'k6/experimental/browser'.

MethodDescription
browser.close()Closes the browser and all of its pages (if any were opened).
browser.contexts()Lets you access all open BrowserContexts.
browser.isConnected
Indicates whether the CDP connection to the browser process is active or not.
browser.newContext([options])
Creates and returns a new BrowserContext.
browser.newPage([options])
Creates a new Page in a new BrowserContext and returns the page.
browser.on('disconnected')Detects the disconnected event from the browser application.
browser.version()Returns the browser application's version.

Example

import { chromium } from 'k6/experimental/browser';


export default async function () {
  const browser = chromium.launch();
  const context = browser.newContext();
  const page = context.newPage();


  try {
    await page.goto('https://test.k6.io/');
  } finally {
    page.close();
    browser.close();
  }
}