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

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 is archived documentation for v0.43. Go to the latest version

launch([options])

suggest edits

Launches a new browser process.

ParameterTypeDefaultDescription
argsstring[]nullExtra command line arguments to include when launching browser process. See this link for a list of Chromium arguments. Note that arguments should not start with -- (see the example).
debugbooleanfalseAll CDP messages and internal fine grained logs will be logged if set to true.
devtoolsbooleanfalseOpen up developer tools in the browser by default.
envstring[]nullEnvironment variables to set before launching browser process.
executablePathstringnullOverride search for browser executable in favor of specified absolute path.
headlessbooleantrueShow browser GUI or not.
ignoreDefaultArgsstring[]nullIgnore any of the default arguments included when launching browser process.
proxystringnullSpecify to set browser's proxy configuration.
slowMostringnullSlow down input actions and navigation by the specified time e.g. '500ms'.
timeoutstring'30s'Default timeout to use for various actions and navigation.

Default arguments

List of default arguments included when launching the browser process. You can pass one or more of the arguments to the ignoreDefaultArgs field when launching a browser for the ones you want to ignore.

note

The starting '--' have been omitted from the argument names in these lists.

ArgumentValueDescription
disable-background-networkingtrueDisables several subsystems which run network requests in the background. This is used during network performance testing to avoid measurement noise.
enable-featuresNetworkService,
NetworkServiceInProcess		Comma-separated list of feature names to enable.
disable-background-timer-throttlingtrueDisables task throttling of timer tasks from background pages.
disable-backgrounding-occluded-windowstrueDisables backgrounding renders for occluded windows. Done for tests to avoid nondeterministic behavior.
disable-breakpadtrueDisables the crash reporting.
disable-component-extensions
-with-background-pages		trueDisables default component extensions with background pages. Useful for performance tests where these pages may interfere with results.
disable-default-appstrueDisables the installation of default apps on the first run. This is used during automated testing.
disable-dev-shm-usagetrueThe /dev/shm partition is too small in certain VM environments, causing Chrome to fail or crash. This flag provides a work-around for this issue (a temporary directory will always be used to create anonymous shared memory files).
disable-extensionstrueDisables extensions.
disable-featuresImprovedCookieControls,
LazyFrameLoading,
GlobalMediaControls,
DestroyProfileOnBrowserClose,
MediaRouter,
AcceptCHFrame		Comma-separated list of feature names to disable.
disable-hang-monitortrueSuppresses hang monitor dialogs in renderer processes. This may allow slow unload handlers on a page to prevent the tab from closing, but the Task Manager can be used to terminate the offending process in this case.
disable-ipc-flooding-protectiontrueDisables the IPC flooding protection. It is activated by default. Some javascript functions can be used to flood the browser process with IPC. This protection limits the rate at which they can be used.
disable-popup-blockingtrueDisables pop-up blocking.
disable-prompt-on-reposttrueUsually, when the user attempts to navigate to a page that was the result of a post request, the browser prompts to make sure that's the intention of the user. This switch may be used to disable that check during automated testing.
disable-renderer-backgroundingtruePrevents renderer process backgrounding when set.
force-color-profilesrgbForces all monitors to be treated as though they have the specified color profile. Accepted values are "srgb" and "generic-rgb" (currently used by Mac layout tests) and "color-spin-gamma24" (used by layout tests).
metrics-recording-onlytrueEnables the recording of metrics reports but disables reporting. This executes all the code that a normal client would use for reporting, except the report is dropped rather than sent to the server. This is useful for finding issues in the metrics code during UI and performance tests.
no-first-runtrueSkips the "First Run" tasks, whether or not it's the first run, and the "What's New" page. This does not drop the "First Run" sentinel and thus doesn't prevent "First Run" from occurring the next time Chromium is launched without this flag. It also does not update the last "What's New" milestone, so it does not prevent "What's New" from occurring the next time Chromium is launched without this flag.
enable-automationtrueEnables indication that the browser is controlled by automation.
password-storebasicSpecifies which encryption storage backend to use. The possible values are kwallet, kwallet5, gnome, gnome-keyring, gnome-libsecret, and basic. Any other value will lead to Chromium detecting the best backend automatically.
use-mock-keychaintrueUses mock keychain on Mac to prevent the blocking permissions dialog about: "Chrome wants to use your confidential information stored in your keychain."
no-service-autoruntrueDisables the service process from adding itself as an autorun process. This does not delete existing autorun registrations, it just prevents the service from registering a new one.
no-startup-windowtrueDoes not automatically open a browser window on startup (used when launching Chrome for the purpose of hosting background apps).
no-default-browser-checktrueDisables the default browser check. Useful for UI/browser tests where we want to avoid having the default browser info-bar displayed.
no-sandboxtrueDisables the sandbox for all process types that are normally sandboxed. Meant to be used as a browser-level switch for testing purposes only.
headlesstrue/falseRun in headless mode, i.e., without a UI or display server dependencies. Set by launch options (default true).
auto-open-devtools-for-tabstrue/falseThis flag makes Chrome auto-open the DevTools window for each tab. It is intended to be used by developers and automation, not to require user interaction for opening DevTools. Set by launch options (default false).
window-size800,600Sets the initial window size. Provided as string in the format "800,600".

Additionally if headless mode is set to true in launch options, the following arguments are also set:

ArgumentValueDescription
hide-scrollbarstruePrevents creating scrollbars for web content. Useful for taking consistent screenshots.
mute-audiotrueMutes audio sent to the audio device so it is not audible during automated testing.
blink-settingsprimaryHoverType=2,availableHoverTypes=2,
primaryPointerType=4,availablePointerTypes=4		Sets blink settings. Format is <name>[=<value>],<name>[=<value>],... The names are declared in settings.json5 from chromium project. For boolean type, use "true", "false", or omit '=<value>' part to set to true. For enum type, use the int value of the enum value.

Returns

TypeDescription
objectBrowser object

Example

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


export default async function () {
  const browser = chromium.launch({
    args: ['show-property-changed-rects'],
    debug: true,
    devtools: true,
    executablePath: '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
    headless: false,
    slowMo: '500ms',
    timeout: '30s',
  });
  const context = browser.newContext();
  const page = context.newPage();


  try {
    await page.goto('http://whatsmyuseragent.org/');
    page.screenshot({ path: `example-chromium.png` });
  } finally {
    page.close();
    browser.close();
  }
}