Optional settings passed to
browserType.launch(). In addition to Playwright’s options the object may contain our own PlaywrightLaunchContext that enable additional features.
optionalconfig: Configuration = ...
Promise that resolves to Playwright’s
Launches headless browsers using Playwright pre-configured to work within the Apify platform. The function has the same return value as
browserType.launch(). See Playwright documentation for more details.
launchPlaywright()function alters the following Playwright options:
CRAWLEE_HEADLESSenvironment variable to the
headlessoption, unless it was already defined by the caller or
CRAWLEE_XVFBenvironment variable is set to
1. Note that Apify Actor cloud platform automatically sets
CRAWLEE_HEADLESS=1to all running actors.
proxyUrloption, validates it and adds it to
launchOptionsin a proper format. The proxy URL must define a port number and have one of the following schemes:
socks5://. If the proxy is HTTP (i.e. has the
http://scheme) and contains username or password, the
launchPlaywrightfunctions sets up an anonymous proxy HTTP to make the proxy work with headless Chrome. For more information, read the blog post about proxy-chain library.
To use this function, you need to have the Playwright NPM package installed in your project. When running on the Apify Platform, you can achieve that simply by using the
apify/actor-node-playwright-*base Docker image for your actor - see Apify Actor documentation for details.