Interface PlaywrightService

Since

0.1.0

interface PlaywrightService {
    connectCDP: (
        cdpUrl: string,
        options?: ConnectOverCDPOptions,
    ) => Effect<PlaywrightBrowserService, PlaywrightError>;
    connectCDPScoped: (
        cdpUrl: string,
        options?: ConnectOverCDPOptions,
    ) => Effect<PlaywrightBrowserService, PlaywrightError, Scope>;
    launch: (
        browserType: BrowserType,
        options?: LaunchOptions,
    ) => Effect<PlaywrightBrowserService, PlaywrightError>;
    launchPersistentContext: (
        browserType: BrowserType,
        userDataDir: string,
        options?: {
            acceptDownloads?: boolean;
            args?: string[];
            baseURL?: string;
            bypassCSP?: boolean;
            channel?: string;
            chromiumSandbox?: boolean;
            clientCertificates?: {
                cert?: Buffer<ArrayBufferLike>;
                certPath?: string;
                key?: Buffer<ArrayBufferLike>;
                keyPath?: string;
                origin: string;
                passphrase?: string;
                pfx?: Buffer<ArrayBufferLike>;
                pfxPath?: string;
            }[];
            colorScheme?: "light"
            | "dark"
            | "no-preference"
            | null;
            contrast?: "no-preference" | "more" | null;
            deviceScaleFactor?: number;
            downloadsPath?: string;
            env?: { [key: string]: string | undefined };
            executablePath?: string;
            extraHTTPHeaders?: { [key: string]: string };
            firefoxUserPrefs?: { [key: string]: string | number | boolean };
            forcedColors?: "none" | "active" | null;
            geolocation?: { accuracy?: number; latitude: number; longitude: number };
            handleSIGHUP?: boolean;
            handleSIGINT?: boolean;
            handleSIGTERM?: boolean;
            hasTouch?: boolean;
            headless?: boolean;
            httpCredentials?: {
                origin?: string;
                password: string;
                send?: "unauthorized" | "always";
                username: string;
            };
            ignoreDefaultArgs?: boolean
            | string[];
            ignoreHTTPSErrors?: boolean;
            isMobile?: boolean;
            javaScriptEnabled?: boolean;
            locale?: string;
            logger?: Logger;
            offline?: boolean;
            permissions?: string[];
            proxy?: {
                bypass?: string;
                password?: string;
                server: string;
                username?: string;
            };
            recordHar?: {
                content?: "embed"
                | "omit"
                | "attach";
                mode?: "full" | "minimal";
                omitContent?: boolean;
                path: string;
                urlFilter?: string | RegExp;
            };
            recordVideo?: { dir: string; size?: { height: number; width: number } };
            reducedMotion?: "reduce" | "no-preference" | null;
            screen?: { height: number; width: number };
            serviceWorkers?: "block" | "allow";
            slowMo?: number;
            strictSelectors?: boolean;
            timeout?: number;
            timezoneId?: string;
            tracesDir?: string;
            userAgent?: string;
            videoSize?: { height: number; width: number };
            videosPath?: string;
            viewport?: { height: number; width: number } | null;
        },
    ) => Effect<PlaywrightBrowserContextService, PlaywrightError>;
    launchPersistentContextScoped: (
        browserType: BrowserType,
        userDataDir: string,
        options?: {
            acceptDownloads?: boolean;
            args?: string[];
            baseURL?: string;
            bypassCSP?: boolean;
            channel?: string;
            chromiumSandbox?: boolean;
            clientCertificates?: {
                cert?: Buffer<ArrayBufferLike>;
                certPath?: string;
                key?: Buffer<ArrayBufferLike>;
                keyPath?: string;
                origin: string;
                passphrase?: string;
                pfx?: Buffer<ArrayBufferLike>;
                pfxPath?: string;
            }[];
            colorScheme?: "light"
            | "dark"
            | "no-preference"
            | null;
            contrast?: "no-preference" | "more" | null;
            deviceScaleFactor?: number;
            downloadsPath?: string;
            env?: { [key: string]: string | undefined };
            executablePath?: string;
            extraHTTPHeaders?: { [key: string]: string };
            firefoxUserPrefs?: { [key: string]: string | number | boolean };
            forcedColors?: "none" | "active" | null;
            geolocation?: { accuracy?: number; latitude: number; longitude: number };
            handleSIGHUP?: boolean;
            handleSIGINT?: boolean;
            handleSIGTERM?: boolean;
            hasTouch?: boolean;
            headless?: boolean;
            httpCredentials?: {
                origin?: string;
                password: string;
                send?: "unauthorized" | "always";
                username: string;
            };
            ignoreDefaultArgs?: boolean
            | string[];
            ignoreHTTPSErrors?: boolean;
            isMobile?: boolean;
            javaScriptEnabled?: boolean;
            locale?: string;
            logger?: Logger;
            offline?: boolean;
            permissions?: string[];
            proxy?: {
                bypass?: string;
                password?: string;
                server: string;
                username?: string;
            };
            recordHar?: {
                content?: "embed"
                | "omit"
                | "attach";
                mode?: "full" | "minimal";
                omitContent?: boolean;
                path: string;
                urlFilter?: string | RegExp;
            };
            recordVideo?: { dir: string; size?: { height: number; width: number } };
            reducedMotion?: "reduce" | "no-preference" | null;
            screen?: { height: number; width: number };
            serviceWorkers?: "block" | "allow";
            slowMo?: number;
            strictSelectors?: boolean;
            timeout?: number;
            timezoneId?: string;
            tracesDir?: string;
            userAgent?: string;
            videoSize?: { height: number; width: number };
            videosPath?: string;
            viewport?: { height: number; width: number } | null;
        },
    ) => Effect<PlaywrightBrowserContextService, PlaywrightError, Scope>;
    launchScoped: (
        browserType: BrowserType,
        options?: LaunchOptions,
    ) => Effect<PlaywrightBrowserService, PlaywrightError, Scope>;
}

Index

Properties

connectCDP connectCDPScoped launch launchPersistentContext launchPersistentContextScoped launchScoped

Properties

connectCDP

connectCDP: (
cdpUrl: string,
options?: ConnectOverCDPOptions,
) => Effect<PlaywrightBrowserService, PlaywrightError>

Connects to a browser instance via Chrome DevTools Protocol (CDP).

Unlike connectCDPScoped, this method does not close the connection when the scope is closed. It is the caller's responsibility to manage the connection's lifecycle.

If you want to close the connection using a scope simply add a finalizer:

import { Effect } from "effect";
import { Playwright } from "effect-playwright";

const program = Effect.gen(function* () {
  const playwright = yield* Playwright;
  const browser = yield* playwright.connectCDP(cdpUrl);
  yield* Effect.addFinalizer(() => browser.close.pipe(Effect.ignore));
});

await Effect.runPromise(program);

Type Declaration

- (
  cdpUrl: string,
  options?: ConnectOverCDPOptions,
  ): Effect<PlaywrightBrowserService, PlaywrightError>
- Parameters
  - cdpUrl: string
    The CDP URL to connect to.
  - Optionaloptions: ConnectOverCDPOptions
    Optional options for connecting to the CDP URL.
  Returns Effect<PlaywrightBrowserService, PlaywrightError>

Since

0.1.0

connectCDPScoped

connectCDPScoped: (
cdpUrl: string,
options?: ConnectOverCDPOptions,
) => Effect<PlaywrightBrowserService, PlaywrightError, Scope>

Connects to a browser instance via Chrome DevTools Protocol (CDP) managed by a Scope.

This method automatically closes the connection when the scope is closed.

Note that closing a CDP connection does not close the browser instance itself, only the CDP connection.

import { Effect } from "effect";
import { Playwright } from "effect-playwright";

const program = Effect.gen(function* () {
  const playwright = yield* Playwright;
  const browser = yield* playwright.connectCDPScoped(cdpUrl);
  // Connection will be closed automatically when scope closes
});

await Effect.runPromise(program);

Type Declaration

- (
  cdpUrl: string,
  options?: ConnectOverCDPOptions,
  ): Effect<PlaywrightBrowserService, PlaywrightError, Scope>
- Parameters
  - cdpUrl: string
    The CDP URL to connect to.
  - Optionaloptions: ConnectOverCDPOptions
    Optional options for connecting to the CDP URL.
  Returns Effect<PlaywrightBrowserService, PlaywrightError, Scope>

Since

0.1.1

launch

launch: (
browserType: BrowserType,
options?: LaunchOptions,
) => Effect<PlaywrightBrowserService, PlaywrightError>

Launches a new browser instance.

It is the caller's responsibility to manage the browser's lifecycle and close it when no longer needed. For automatic scope-based management, use launchScoped instead.

import { Effect } from "effect";
import { Playwright } from "effect-playwright";
import { chromium } from "playwright-core";

const program = Effect.gen(function* () {
  const browser = yield* Playwright.launch(chromium);
  // ... use browser ...
  yield* browser.close;
});

await Effect.runPromise(program);

Type Declaration

- (
  browserType: BrowserType,
  options?: LaunchOptions,
  ): Effect<PlaywrightBrowserService, PlaywrightError>
- Parameters
  - browserType: BrowserType
    The browser type to launch (e.g. chromium, firefox, webkit).
  - Optionaloptions: LaunchOptions
    Optional launch options.
  Returns Effect<PlaywrightBrowserService, PlaywrightError>

Since

0.1.0

launchPersistentContext

launchPersistentContext: (
    browserType: BrowserType,
    userDataDir: string,
    options?: {
        acceptDownloads?: boolean;
        args?: string[];
        baseURL?: string;
        bypassCSP?: boolean;
        channel?: string;
        chromiumSandbox?: boolean;
        clientCertificates?: {
            cert?: Buffer<ArrayBufferLike>;
            certPath?: string;
            key?: Buffer<ArrayBufferLike>;
            keyPath?: string;
            origin: string;
            passphrase?: string;
            pfx?: Buffer<ArrayBufferLike>;
            pfxPath?: string;
        }[];
        colorScheme?: "light"
        | "dark"
        | "no-preference"
        | null;
        contrast?: "no-preference" | "more" | null;
        deviceScaleFactor?: number;
        downloadsPath?: string;
        env?: { [key: string]: string | undefined };
        executablePath?: string;
        extraHTTPHeaders?: { [key: string]: string };
        firefoxUserPrefs?: { [key: string]: string | number | boolean };
        forcedColors?: "none" | "active" | null;
        geolocation?: { accuracy?: number; latitude: number; longitude: number };
        handleSIGHUP?: boolean;
        handleSIGINT?: boolean;
        handleSIGTERM?: boolean;
        hasTouch?: boolean;
        headless?: boolean;
        httpCredentials?: {
            origin?: string;
            password: string;
            send?: "unauthorized" | "always";
            username: string;
        };
        ignoreDefaultArgs?: boolean
        | string[];
        ignoreHTTPSErrors?: boolean;
        isMobile?: boolean;
        javaScriptEnabled?: boolean;
        locale?: string;
        logger?: Logger;
        offline?: boolean;
        permissions?: string[];
        proxy?: {
            bypass?: string;
            password?: string;
            server: string;
            username?: string;
        };
        recordHar?: {
            content?: "embed"
            | "omit"
            | "attach";
            mode?: "full" | "minimal";
            omitContent?: boolean;
            path: string;
            urlFilter?: string | RegExp;
        };
        recordVideo?: { dir: string; size?: { height: number; width: number } };
        reducedMotion?: "reduce" | "no-preference" | null;
        screen?: { height: number; width: number };
        serviceWorkers?: "block" | "allow";
        slowMo?: number;
        strictSelectors?: boolean;
        timeout?: number;
        timezoneId?: string;
        tracesDir?: string;
        userAgent?: string;
        videoSize?: { height: number; width: number };
        videosPath?: string;
        viewport?: { height: number; width: number } | null;
    },
) => Effect<PlaywrightBrowserContextService, PlaywrightError>

Launches a persistent browser context.

Unlike launchPersistentContextScoped, this method does not close the context automatically when scope is closed. You are responsible for closing it.

This launches a browser with a persistent profile under userDataDir and returns the single persistent context for that browser.

Closing this context also closes the underlying browser process.

import { Effect } from "effect";
import { Playwright } from "effect-playwright";
import { chromium } from "playwright-core";

const program = Effect.gen(function* () {
  const playwright = yield* Playwright;
  const context = yield* playwright.launchPersistentContext(
    chromium,
    "./.playwright-profile",
  );

  const page = yield* context.newPage;
  yield* page.goto("https://example.com");

  // Closes the persistent context and browser process.
  yield* context.close;
});

await Effect.runPromise(program);

If you call this non-scoped variant inside a scope, add a finalizer for cleanup:

const program = Effect.gen(function* () {
  const playwright = yield* Playwright;
  const context = yield* playwright.launchPersistentContext(
    chromium,
    "./.playwright-profile",
  );

  yield* Effect.addFinalizer(() => context.close.pipe(Effect.ignore));
});

await Effect.runPromise(program.pipe(Effect.scoped));

Type Declaration

- (
      browserType: BrowserType,
      userDataDir: string,
      options?: {
          acceptDownloads?: boolean;
          args?: string[];
          baseURL?: string;
          bypassCSP?: boolean;
          channel?: string;
          chromiumSandbox?: boolean;
          clientCertificates?: {
              cert?: Buffer<ArrayBufferLike>;
              certPath?: string;
              key?: Buffer<ArrayBufferLike>;
              keyPath?: string;
              origin: string;
              passphrase?: string;
              pfx?: Buffer<ArrayBufferLike>;
              pfxPath?: string;
          }[];
          colorScheme?: "light"
          | "dark"
          | "no-preference"
          | null;
          contrast?: "no-preference" | "more" | null;
          deviceScaleFactor?: number;
          downloadsPath?: string;
          env?: { [key: string]: string | undefined };
          executablePath?: string;
          extraHTTPHeaders?: { [key: string]: string };
          firefoxUserPrefs?: { [key: string]: string | number | boolean };
          forcedColors?: "none" | "active" | null;
          geolocation?: { accuracy?: number; latitude: number; longitude: number };
          handleSIGHUP?: boolean;
          handleSIGINT?: boolean;
          handleSIGTERM?: boolean;
          hasTouch?: boolean;
          headless?: boolean;
          httpCredentials?: {
              origin?: string;
              password: string;
              send?: "unauthorized" | "always";
              username: string;
          };
          ignoreDefaultArgs?: boolean
          | string[];
          ignoreHTTPSErrors?: boolean;
          isMobile?: boolean;
          javaScriptEnabled?: boolean;
          locale?: string;
          logger?: Logger;
          offline?: boolean;
          permissions?: string[];
          proxy?: {
              bypass?: string;
              password?: string;
              server: string;
              username?: string;
          };
          recordHar?: {
              content?: "embed"
              | "omit"
              | "attach";
              mode?: "full" | "minimal";
              omitContent?: boolean;
              path: string;
              urlFilter?: string | RegExp;
          };
          recordVideo?: { dir: string; size?: { height: number; width: number } };
          reducedMotion?: "reduce" | "no-preference" | null;
          screen?: { height: number; width: number };
          serviceWorkers?: "block" | "allow";
          slowMo?: number;
          strictSelectors?: boolean;
          timeout?: number;
          timezoneId?: string;
          tracesDir?: string;
          userAgent?: string;
          videoSize?: { height: number; width: number };
          videosPath?: string;
          viewport?: { height: number; width: number } | null;
      },
  ): Effect<PlaywrightBrowserContextService, PlaywrightError>
- Parameters
  - browserType: BrowserType
    The browser type to launch (e.g. chromium, firefox, webkit).
  - userDataDir: string
    Directory used for persistent browser profile data. Pass "" for a temporary profile directory.
  - Optionaloptions: {
        acceptDownloads?: boolean;
        args?: string[];
        baseURL?: string;
        bypassCSP?: boolean;
        channel?: string;
        chromiumSandbox?: boolean;
        clientCertificates?: {
            cert?: Buffer<ArrayBufferLike>;
            certPath?: string;
            key?: Buffer<ArrayBufferLike>;
            keyPath?: string;
            origin: string;
            passphrase?: string;
            pfx?: Buffer<ArrayBufferLike>;
            pfxPath?: string;
        }[];
        colorScheme?: "light"
        | "dark"
        | "no-preference"
        | null;
        contrast?: "no-preference" | "more" | null;
        deviceScaleFactor?: number;
        downloadsPath?: string;
        env?: { [key: string]: string | undefined };
        executablePath?: string;
        extraHTTPHeaders?: { [key: string]: string };
        firefoxUserPrefs?: { [key: string]: string | number | boolean };
        forcedColors?: "none" | "active" | null;
        geolocation?: { accuracy?: number; latitude: number; longitude: number };
        handleSIGHUP?: boolean;
        handleSIGINT?: boolean;
        handleSIGTERM?: boolean;
        hasTouch?: boolean;
        headless?: boolean;
        httpCredentials?: {
            origin?: string;
            password: string;
            send?: "unauthorized" | "always";
            username: string;
        };
        ignoreDefaultArgs?: boolean
        | string[];
        ignoreHTTPSErrors?: boolean;
        isMobile?: boolean;
        javaScriptEnabled?: boolean;
        locale?: string;
        logger?: Logger;
        offline?: boolean;
        permissions?: string[];
        proxy?: {
            bypass?: string;
            password?: string;
            server: string;
            username?: string;
        };
        recordHar?: {
            content?: "embed"
            | "omit"
            | "attach";
            mode?: "full" | "minimal";
            omitContent?: boolean;
            path: string;
            urlFilter?: string | RegExp;
        };
        recordVideo?: { dir: string; size?: { height: number; width: number } };
        reducedMotion?: "reduce" | "no-preference" | null;
        screen?: { height: number; width: number };
        serviceWorkers?: "block" | "allow";
        slowMo?: number;
        strictSelectors?: boolean;
        timeout?: number;
        timezoneId?: string;
        tracesDir?: string;
        userAgent?: string;
        videoSize?: { height: number; width: number };
        videosPath?: string;
        viewport?: { height: number; width: number } | null;
    }
    Optional persistent context launch options.
    - OptionalacceptDownloads?: boolean
      Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.
    - Optionalargs?: string[]
      NOTE Use custom browser args at your own risk, as some of them may break Playwright functionality.
      
      Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.
    - OptionalbaseURL?: string
      When using page.goto(url[, options]), page.route(url, handler[, options]), page.waitForURL(url[, options]), page.waitForRequest(urlOrPredicate[, options]), or page.waitForResponse(urlOrPredicate[, options]) it takes the base URL in consideration by using the URL() constructor for building the corresponding URL. Unset by default. Examples:
      
      baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
      
      baseURL: http://localhost:3000/foo/ and navigating to ./bar.html results in http://localhost:3000/foo/bar.html
      
      baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html
    - OptionalbypassCSP?: boolean
      Toggles bypassing page's Content-Security-Policy. Defaults to false.
    - Optionalchannel?: string
      Browser distribution channel.
      
      Use "chromium" to opt in to new headless mode.
      
      Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or "msedge-canary" to use branded Google Chrome and Microsoft Edge.
    - OptionalchromiumSandbox?: boolean
      Enable Chromium sandboxing. Defaults to false.
    - OptionalclientCertificates?: {
          cert?: Buffer<ArrayBufferLike>;
          certPath?: string;
          key?: Buffer<ArrayBufferLike>;
          keyPath?: string;
          origin: string;
          passphrase?: string;
          pfx?: Buffer<ArrayBufferLike>;
          pfxPath?: string;
      }[]
      TLS Client Authentication allows the server to request a client certificate and verify it.
      
      Details
      
      An array of client certificates to be used. Each certificate object must have either both certPath and keyPath, a single pfxPath, or their corresponding direct value equivalents (cert and key, or pfx). Optionally, passphrase property should be provided if the certificate is encrypted. The origin property should be provided with an exact match to the request origin that the certificate is valid for.
      
      Client certificate authentication is only active when at least one client certificate is provided. If you want to reject all client certificates sent by the server, you need to provide a client certificate with an origin that does not match any of the domains you plan to visit.
      
      NOTE When using WebKit on macOS, accessing localhost will not pick up client certificates. You can make it work by replacing localhost with local.playwright.
    - OptionalcolorScheme?: "light" | "dark" | "no-preference" | null
      Emulates prefers-colors-scheme media feature, supported values are 'light' and 'dark'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'light'.
    - Optionalcontrast?: "no-preference" | "more" | null
      Emulates 'prefers-contrast' media feature, supported values are 'no-preference', 'more'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'no-preference'.
    - OptionaldeviceScaleFactor?: number
      Specify device scale factor (can be thought of as dpr). Defaults to 1. Learn more about emulating devices with device scale factor.
    - OptionaldownloadsPath?: string
      If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed.
    - Optionalenv?: { [key: string]: string | undefined }
    - OptionalexecutablePath?: string
      Path to a browser executable to run instead of the bundled one. If executablePath is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.
    - OptionalextraHTTPHeaders?: { [key: string]: string }
      An object containing additional HTTP headers to be sent with every request. Defaults to none.
    - OptionalfirefoxUserPrefs?: { [key: string]: string | number | boolean }
      Firefox user preferences. Learn more about the Firefox user preferences at about:config.
      
      You can also provide a path to a custom policies.json file via PLAYWRIGHT_FIREFOX_POLICIES_JSON environment variable.
    - OptionalforcedColors?: "none" | "active" | null
      Emulates 'forced-colors' media feature, supported values are 'active', 'none'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'none'.
    - Optionalgeolocation?: { accuracy?: number; latitude: number; longitude: number }
      Optionalaccuracy?: number
      Non-negative accuracy value. Defaults to 0.
      
      latitude: number
      Latitude between -90 and 90.
      
      longitude: number
      Longitude between -180 and 180.
    - OptionalhandleSIGHUP?: boolean
      Close the browser process on SIGHUP. Defaults to true.
    - OptionalhandleSIGINT?: boolean
      Close the browser process on Ctrl-C. Defaults to true.
    - OptionalhandleSIGTERM?: boolean
      Close the browser process on SIGTERM. Defaults to true.
    - OptionalhasTouch?: boolean
      Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.
    - Optionalheadless?: boolean
      Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to true.
    - OptionalhttpCredentials?: {
          origin?: string;
          password: string;
          send?: "unauthorized" | "always";
          username: string;
      }
      Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.
      
      Optionalorigin?: string
      Restrain sending http credentials on specific origin (scheme://host:port).
      
      password: string
      Optionalsend?: "unauthorized" | "always"
      This option only applies to the requests sent from corresponding APIRequestContext and does not affect requests sent from the browser. 'always' - Authorization header with basic authentication credentials will be sent with the each API request. 'unauthorized - the credentials are only sent when 401 (Unauthorized) response with WWW-Authenticate header is received. Defaults to 'unauthorized'.
      
      username: string
    - OptionalignoreDefaultArgs?: boolean | string[]
      If true, Playwright does not pass its own configurations args and only uses the ones from args. If an array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to false.
    - OptionalignoreHTTPSErrors?: boolean
      Whether to ignore HTTPS errors when sending network requests. Defaults to false.
    - OptionalisMobile?: boolean
      Whether the meta viewport tag is taken into account and touch events are enabled. isMobile is a part of device, so you don't actually need to set it manually. Defaults to false and is not supported in Firefox. Learn more about mobile emulation.
    - OptionaljavaScriptEnabled?: boolean
      Whether or not to enable JavaScript in the context. Defaults to true. Learn more about disabling JavaScript.
    - Optionallocale?: string
      Specify user locale, for example en-GB, de-DE, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules. Defaults to the system default locale. Learn more about emulation in our emulation guide.
    - Optionallogger?: Logger
      Logger sink for Playwright logging.
      
      Deprecated
      The logs received by the logger are incomplete. Please use tracing instead.
    - Optionaloffline?: boolean
      Whether to emulate network being offline. Defaults to false. Learn more about network emulation.
    - Optionalpermissions?: string[]
      A list of permissions to grant to all pages in this context. See browserContext.grantPermissions(permissions[, options]) for more details. Defaults to none.
    - Optionalproxy?: { bypass?: string; password?: string; server: string; username?: string }
      Network proxy settings.
      
      Optionalbypass?: string
      Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
      
      Optionalpassword?: string
      Optional password to use if HTTP proxy requires authentication.
      
      server: string
      Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.
      
      Optionalusername?: string
      Optional username to use if HTTP proxy requires authentication.
    - OptionalrecordHar?: {
          content?: "embed" | "omit" | "attach";
          mode?: "full" | "minimal";
          omitContent?: boolean;
          path: string;
          urlFilter?: string | RegExp;
      }
      Enables HAR recording for all pages into recordHar.path file. If not specified, the HAR is not recorded. Make sure to await browserContext.close([options]) for the HAR to be saved.
      
      Optionalcontent?: "embed" | "omit" | "attach"
      Optional setting to control resource content management. If omit is specified, content is not persisted. If attach is specified, resources are persisted as separate files or entries in the ZIP archive. If embed is specified, content is stored inline the HAR file as per HAR specification. Defaults to attach for .zip output files and to embed for all other file extensions.
      
      Optionalmode?: "full" | "minimal"
      When set to minimal, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to full.
      
      OptionalomitContent?: boolean
      Optional setting to control whether to omit request content from the HAR. Defaults to false. Deprecated, use content policy instead.
      
      path: string
      Path on the filesystem to write the HAR file to. If the file name ends with .zip, content: 'attach' is used by default.
      
      OptionalurlFilter?: string | RegExp
      A glob or regex pattern to filter requests that are stored in the HAR. When a baseURL via the context options was provided and the passed URL is a path, it gets merged via the new URL() constructor. Defaults to none.
    - OptionalrecordVideo?: { dir: string; size?: { height: number; width: number } }
      Enables video recording for all pages into recordVideo.dir directory. If not specified videos are not recorded. Make sure to await browserContext.close([options]) for videos to be saved.
      
      dir: string
      Path to the directory to put videos into.
      
      Optionalsize?: { height: number; width: number }
      Optional dimensions of the recorded videos. If not specified the size will be equal to viewport scaled down to fit into 800x800. If viewport is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.
      
      height: number
      Video frame height.
      
      width: number
      Video frame width.
    - OptionalreducedMotion?: "reduce" | "no-preference" | null
      Emulates 'prefers-reduced-motion' media feature, supported values are 'reduce', 'no-preference'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'no-preference'.
    - Optionalscreen?: { height: number; width: number }
      Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewport is set.
      
      height: number
      page height in pixels.
      
      width: number
      page width in pixels.
    - OptionalserviceWorkers?: "block" | "allow"
      Whether to allow sites to register Service workers. Defaults to 'allow'.
      
      'allow': Service Workers can be registered.
      
      'block': Playwright will block all registration of Service Workers.
    - OptionalslowMo?: number
      Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.
    - OptionalstrictSelectors?: boolean
      If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will throw when more than one element matches the selector. This option does not affect any Locator APIs (Locators are always strict). Defaults to false. See Locator to learn more about the strict mode.
    - Optionaltimeout?: number
      Maximum time in milliseconds to wait for the browser instance to start. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
    - OptionaltimezoneId?: string
      Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs. Defaults to the system timezone.
    - OptionaltracesDir?: string
      If specified, traces are saved into this directory.
    - OptionaluserAgent?: string
      Specific user agent to use in this context.
    - OptionalvideoSize?: { height: number; width: number }
      Deprecated
      Use recordVideo instead.
      
      height: number
      Video frame height.
      
      width: number
      Video frame width.
    - OptionalvideosPath?: string
      Deprecated
      Use recordVideo instead.
    - Optionalviewport?: { height: number; width: number } | null
      Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use null to disable the consistent viewport emulation. Learn more about viewport emulation.
      
      NOTE The null value opts out from the default presets, makes viewport depend on the host window size defined by the operating system. It makes the execution of the tests non-deterministic.
  Returns Effect<PlaywrightBrowserContextService, PlaywrightError>

Since

0.2.4

launchPersistentContextScoped

launchPersistentContextScoped: (
    browserType: BrowserType,
    userDataDir: string,
    options?: {
        acceptDownloads?: boolean;
        args?: string[];
        baseURL?: string;
        bypassCSP?: boolean;
        channel?: string;
        chromiumSandbox?: boolean;
        clientCertificates?: {
            cert?: Buffer<ArrayBufferLike>;
            certPath?: string;
            key?: Buffer<ArrayBufferLike>;
            keyPath?: string;
            origin: string;
            passphrase?: string;
            pfx?: Buffer<ArrayBufferLike>;
            pfxPath?: string;
        }[];
        colorScheme?: "light"
        | "dark"
        | "no-preference"
        | null;
        contrast?: "no-preference" | "more" | null;
        deviceScaleFactor?: number;
        downloadsPath?: string;
        env?: { [key: string]: string | undefined };
        executablePath?: string;
        extraHTTPHeaders?: { [key: string]: string };
        firefoxUserPrefs?: { [key: string]: string | number | boolean };
        forcedColors?: "none" | "active" | null;
        geolocation?: { accuracy?: number; latitude: number; longitude: number };
        handleSIGHUP?: boolean;
        handleSIGINT?: boolean;
        handleSIGTERM?: boolean;
        hasTouch?: boolean;
        headless?: boolean;
        httpCredentials?: {
            origin?: string;
            password: string;
            send?: "unauthorized" | "always";
            username: string;
        };
        ignoreDefaultArgs?: boolean
        | string[];
        ignoreHTTPSErrors?: boolean;
        isMobile?: boolean;
        javaScriptEnabled?: boolean;
        locale?: string;
        logger?: Logger;
        offline?: boolean;
        permissions?: string[];
        proxy?: {
            bypass?: string;
            password?: string;
            server: string;
            username?: string;
        };
        recordHar?: {
            content?: "embed"
            | "omit"
            | "attach";
            mode?: "full" | "minimal";
            omitContent?: boolean;
            path: string;
            urlFilter?: string | RegExp;
        };
        recordVideo?: { dir: string; size?: { height: number; width: number } };
        reducedMotion?: "reduce" | "no-preference" | null;
        screen?: { height: number; width: number };
        serviceWorkers?: "block" | "allow";
        slowMo?: number;
        strictSelectors?: boolean;
        timeout?: number;
        timezoneId?: string;
        tracesDir?: string;
        userAgent?: string;
        videoSize?: { height: number; width: number };
        videosPath?: string;
        viewport?: { height: number; width: number } | null;
    },
) => Effect<PlaywrightBrowserContextService, PlaywrightError, Scope>

Launches a persistent browser context managed by a Scope.

This automatically closes the persistent context (and therefore the browser process) when the scope is closed.

import { Effect } from "effect";
import { Playwright } from "effect-playwright";
import { chromium } from "playwright-core";

const program = Effect.gen(function* () {
  const playwright = yield* Playwright;
  const context = yield* playwright.launchPersistentContextScoped(
    chromium,
    "./.playwright-profile",
  );

  const page = yield* context.newPage;
  yield* page.goto("https://example.com");
  // Context/browser cleanup is automatic when scope closes.
}).pipe(Effect.scoped);

await Effect.runPromise(program);

Type Declaration

- (
      browserType: BrowserType,
      userDataDir: string,
      options?: {
          acceptDownloads?: boolean;
          args?: string[];
          baseURL?: string;
          bypassCSP?: boolean;
          channel?: string;
          chromiumSandbox?: boolean;
          clientCertificates?: {
              cert?: Buffer<ArrayBufferLike>;
              certPath?: string;
              key?: Buffer<ArrayBufferLike>;
              keyPath?: string;
              origin: string;
              passphrase?: string;
              pfx?: Buffer<ArrayBufferLike>;
              pfxPath?: string;
          }[];
          colorScheme?: "light"
          | "dark"
          | "no-preference"
          | null;
          contrast?: "no-preference" | "more" | null;
          deviceScaleFactor?: number;
          downloadsPath?: string;
          env?: { [key: string]: string | undefined };
          executablePath?: string;
          extraHTTPHeaders?: { [key: string]: string };
          firefoxUserPrefs?: { [key: string]: string | number | boolean };
          forcedColors?: "none" | "active" | null;
          geolocation?: { accuracy?: number; latitude: number; longitude: number };
          handleSIGHUP?: boolean;
          handleSIGINT?: boolean;
          handleSIGTERM?: boolean;
          hasTouch?: boolean;
          headless?: boolean;
          httpCredentials?: {
              origin?: string;
              password: string;
              send?: "unauthorized" | "always";
              username: string;
          };
          ignoreDefaultArgs?: boolean
          | string[];
          ignoreHTTPSErrors?: boolean;
          isMobile?: boolean;
          javaScriptEnabled?: boolean;
          locale?: string;
          logger?: Logger;
          offline?: boolean;
          permissions?: string[];
          proxy?: {
              bypass?: string;
              password?: string;
              server: string;
              username?: string;
          };
          recordHar?: {
              content?: "embed"
              | "omit"
              | "attach";
              mode?: "full" | "minimal";
              omitContent?: boolean;
              path: string;
              urlFilter?: string | RegExp;
          };
          recordVideo?: { dir: string; size?: { height: number; width: number } };
          reducedMotion?: "reduce" | "no-preference" | null;
          screen?: { height: number; width: number };
          serviceWorkers?: "block" | "allow";
          slowMo?: number;
          strictSelectors?: boolean;
          timeout?: number;
          timezoneId?: string;
          tracesDir?: string;
          userAgent?: string;
          videoSize?: { height: number; width: number };
          videosPath?: string;
          viewport?: { height: number; width: number } | null;
      },
  ): Effect<PlaywrightBrowserContextService, PlaywrightError, Scope>
- Parameters
  - browserType: BrowserType
    The browser type to launch (e.g. chromium, firefox, webkit).
  - userDataDir: string
    Directory used for persistent browser profile data. Pass "" for a temporary profile directory.
  - Optionaloptions: {
        acceptDownloads?: boolean;
        args?: string[];
        baseURL?: string;
        bypassCSP?: boolean;
        channel?: string;
        chromiumSandbox?: boolean;
        clientCertificates?: {
            cert?: Buffer<ArrayBufferLike>;
            certPath?: string;
            key?: Buffer<ArrayBufferLike>;
            keyPath?: string;
            origin: string;
            passphrase?: string;
            pfx?: Buffer<ArrayBufferLike>;
            pfxPath?: string;
        }[];
        colorScheme?: "light"
        | "dark"
        | "no-preference"
        | null;
        contrast?: "no-preference" | "more" | null;
        deviceScaleFactor?: number;
        downloadsPath?: string;
        env?: { [key: string]: string | undefined };
        executablePath?: string;
        extraHTTPHeaders?: { [key: string]: string };
        firefoxUserPrefs?: { [key: string]: string | number | boolean };
        forcedColors?: "none" | "active" | null;
        geolocation?: { accuracy?: number; latitude: number; longitude: number };
        handleSIGHUP?: boolean;
        handleSIGINT?: boolean;
        handleSIGTERM?: boolean;
        hasTouch?: boolean;
        headless?: boolean;
        httpCredentials?: {
            origin?: string;
            password: string;
            send?: "unauthorized" | "always";
            username: string;
        };
        ignoreDefaultArgs?: boolean
        | string[];
        ignoreHTTPSErrors?: boolean;
        isMobile?: boolean;
        javaScriptEnabled?: boolean;
        locale?: string;
        logger?: Logger;
        offline?: boolean;
        permissions?: string[];
        proxy?: {
            bypass?: string;
            password?: string;
            server: string;
            username?: string;
        };
        recordHar?: {
            content?: "embed"
            | "omit"
            | "attach";
            mode?: "full" | "minimal";
            omitContent?: boolean;
            path: string;
            urlFilter?: string | RegExp;
        };
        recordVideo?: { dir: string; size?: { height: number; width: number } };
        reducedMotion?: "reduce" | "no-preference" | null;
        screen?: { height: number; width: number };
        serviceWorkers?: "block" | "allow";
        slowMo?: number;
        strictSelectors?: boolean;
        timeout?: number;
        timezoneId?: string;
        tracesDir?: string;
        userAgent?: string;
        videoSize?: { height: number; width: number };
        videosPath?: string;
        viewport?: { height: number; width: number } | null;
    }
    Optional persistent context launch options.
    - OptionalacceptDownloads?: boolean
      Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.
    - Optionalargs?: string[]
      NOTE Use custom browser args at your own risk, as some of them may break Playwright functionality.
      
      Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.
    - OptionalbaseURL?: string
      When using page.goto(url[, options]), page.route(url, handler[, options]), page.waitForURL(url[, options]), page.waitForRequest(urlOrPredicate[, options]), or page.waitForResponse(urlOrPredicate[, options]) it takes the base URL in consideration by using the URL() constructor for building the corresponding URL. Unset by default. Examples:
      
      baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
      
      baseURL: http://localhost:3000/foo/ and navigating to ./bar.html results in http://localhost:3000/foo/bar.html
      
      baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html
    - OptionalbypassCSP?: boolean
      Toggles bypassing page's Content-Security-Policy. Defaults to false.
    - Optionalchannel?: string
      Browser distribution channel.
      
      Use "chromium" to opt in to new headless mode.
      
      Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or "msedge-canary" to use branded Google Chrome and Microsoft Edge.
    - OptionalchromiumSandbox?: boolean
      Enable Chromium sandboxing. Defaults to false.
    - OptionalclientCertificates?: {
          cert?: Buffer<ArrayBufferLike>;
          certPath?: string;
          key?: Buffer<ArrayBufferLike>;
          keyPath?: string;
          origin: string;
          passphrase?: string;
          pfx?: Buffer<ArrayBufferLike>;
          pfxPath?: string;
      }[]
      TLS Client Authentication allows the server to request a client certificate and verify it.
      
      Details
      
      An array of client certificates to be used. Each certificate object must have either both certPath and keyPath, a single pfxPath, or their corresponding direct value equivalents (cert and key, or pfx). Optionally, passphrase property should be provided if the certificate is encrypted. The origin property should be provided with an exact match to the request origin that the certificate is valid for.
      
      Client certificate authentication is only active when at least one client certificate is provided. If you want to reject all client certificates sent by the server, you need to provide a client certificate with an origin that does not match any of the domains you plan to visit.
      
      NOTE When using WebKit on macOS, accessing localhost will not pick up client certificates. You can make it work by replacing localhost with local.playwright.
    - OptionalcolorScheme?: "light" | "dark" | "no-preference" | null
      Emulates prefers-colors-scheme media feature, supported values are 'light' and 'dark'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'light'.
    - Optionalcontrast?: "no-preference" | "more" | null
      Emulates 'prefers-contrast' media feature, supported values are 'no-preference', 'more'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'no-preference'.
    - OptionaldeviceScaleFactor?: number
      Specify device scale factor (can be thought of as dpr). Defaults to 1. Learn more about emulating devices with device scale factor.
    - OptionaldownloadsPath?: string
      If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed.
    - Optionalenv?: { [key: string]: string | undefined }
    - OptionalexecutablePath?: string
      Path to a browser executable to run instead of the bundled one. If executablePath is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.
    - OptionalextraHTTPHeaders?: { [key: string]: string }
      An object containing additional HTTP headers to be sent with every request. Defaults to none.
    - OptionalfirefoxUserPrefs?: { [key: string]: string | number | boolean }
      Firefox user preferences. Learn more about the Firefox user preferences at about:config.
      
      You can also provide a path to a custom policies.json file via PLAYWRIGHT_FIREFOX_POLICIES_JSON environment variable.
    - OptionalforcedColors?: "none" | "active" | null
      Emulates 'forced-colors' media feature, supported values are 'active', 'none'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'none'.
    - Optionalgeolocation?: { accuracy?: number; latitude: number; longitude: number }
      Optionalaccuracy?: number
      Non-negative accuracy value. Defaults to 0.
      
      latitude: number
      Latitude between -90 and 90.
      
      longitude: number
      Longitude between -180 and 180.
    - OptionalhandleSIGHUP?: boolean
      Close the browser process on SIGHUP. Defaults to true.
    - OptionalhandleSIGINT?: boolean
      Close the browser process on Ctrl-C. Defaults to true.
    - OptionalhandleSIGTERM?: boolean
      Close the browser process on SIGTERM. Defaults to true.
    - OptionalhasTouch?: boolean
      Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.
    - Optionalheadless?: boolean
      Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to true.
    - OptionalhttpCredentials?: {
          origin?: string;
          password: string;
          send?: "unauthorized" | "always";
          username: string;
      }
      Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.
      
      Optionalorigin?: string
      Restrain sending http credentials on specific origin (scheme://host:port).
      
      password: string
      Optionalsend?: "unauthorized" | "always"
      This option only applies to the requests sent from corresponding APIRequestContext and does not affect requests sent from the browser. 'always' - Authorization header with basic authentication credentials will be sent with the each API request. 'unauthorized - the credentials are only sent when 401 (Unauthorized) response with WWW-Authenticate header is received. Defaults to 'unauthorized'.
      
      username: string
    - OptionalignoreDefaultArgs?: boolean | string[]
      If true, Playwright does not pass its own configurations args and only uses the ones from args. If an array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to false.
    - OptionalignoreHTTPSErrors?: boolean
      Whether to ignore HTTPS errors when sending network requests. Defaults to false.
    - OptionalisMobile?: boolean
      Whether the meta viewport tag is taken into account and touch events are enabled. isMobile is a part of device, so you don't actually need to set it manually. Defaults to false and is not supported in Firefox. Learn more about mobile emulation.
    - OptionaljavaScriptEnabled?: boolean
      Whether or not to enable JavaScript in the context. Defaults to true. Learn more about disabling JavaScript.
    - Optionallocale?: string
      Specify user locale, for example en-GB, de-DE, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules. Defaults to the system default locale. Learn more about emulation in our emulation guide.
    - Optionallogger?: Logger
      Logger sink for Playwright logging.
      
      Deprecated
      The logs received by the logger are incomplete. Please use tracing instead.
    - Optionaloffline?: boolean
      Whether to emulate network being offline. Defaults to false. Learn more about network emulation.
    - Optionalpermissions?: string[]
      A list of permissions to grant to all pages in this context. See browserContext.grantPermissions(permissions[, options]) for more details. Defaults to none.
    - Optionalproxy?: { bypass?: string; password?: string; server: string; username?: string }
      Network proxy settings.
      
      Optionalbypass?: string
      Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
      
      Optionalpassword?: string
      Optional password to use if HTTP proxy requires authentication.
      
      server: string
      Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.
      
      Optionalusername?: string
      Optional username to use if HTTP proxy requires authentication.
    - OptionalrecordHar?: {
          content?: "embed" | "omit" | "attach";
          mode?: "full" | "minimal";
          omitContent?: boolean;
          path: string;
          urlFilter?: string | RegExp;
      }
      Enables HAR recording for all pages into recordHar.path file. If not specified, the HAR is not recorded. Make sure to await browserContext.close([options]) for the HAR to be saved.
      
      Optionalcontent?: "embed" | "omit" | "attach"
      Optional setting to control resource content management. If omit is specified, content is not persisted. If attach is specified, resources are persisted as separate files or entries in the ZIP archive. If embed is specified, content is stored inline the HAR file as per HAR specification. Defaults to attach for .zip output files and to embed for all other file extensions.
      
      Optionalmode?: "full" | "minimal"
      When set to minimal, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to full.
      
      OptionalomitContent?: boolean
      Optional setting to control whether to omit request content from the HAR. Defaults to false. Deprecated, use content policy instead.
      
      path: string
      Path on the filesystem to write the HAR file to. If the file name ends with .zip, content: 'attach' is used by default.
      
      OptionalurlFilter?: string | RegExp
      A glob or regex pattern to filter requests that are stored in the HAR. When a baseURL via the context options was provided and the passed URL is a path, it gets merged via the new URL() constructor. Defaults to none.
    - OptionalrecordVideo?: { dir: string; size?: { height: number; width: number } }
      Enables video recording for all pages into recordVideo.dir directory. If not specified videos are not recorded. Make sure to await browserContext.close([options]) for videos to be saved.
      
      dir: string
      Path to the directory to put videos into.
      
      Optionalsize?: { height: number; width: number }
      Optional dimensions of the recorded videos. If not specified the size will be equal to viewport scaled down to fit into 800x800. If viewport is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.
      
      height: number
      Video frame height.
      
      width: number
      Video frame width.
    - OptionalreducedMotion?: "reduce" | "no-preference" | null
      Emulates 'prefers-reduced-motion' media feature, supported values are 'reduce', 'no-preference'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'no-preference'.
    - Optionalscreen?: { height: number; width: number }
      Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewport is set.
      
      height: number
      page height in pixels.
      
      width: number
      page width in pixels.
    - OptionalserviceWorkers?: "block" | "allow"
      Whether to allow sites to register Service workers. Defaults to 'allow'.
      
      'allow': Service Workers can be registered.
      
      'block': Playwright will block all registration of Service Workers.
    - OptionalslowMo?: number
      Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.
    - OptionalstrictSelectors?: boolean
      If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will throw when more than one element matches the selector. This option does not affect any Locator APIs (Locators are always strict). Defaults to false. See Locator to learn more about the strict mode.
    - Optionaltimeout?: number
      Maximum time in milliseconds to wait for the browser instance to start. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
    - OptionaltimezoneId?: string
      Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs. Defaults to the system timezone.
    - OptionaltracesDir?: string
      If specified, traces are saved into this directory.
    - OptionaluserAgent?: string
      Specific user agent to use in this context.
    - OptionalvideoSize?: { height: number; width: number }
      Deprecated
      Use recordVideo instead.
      
      height: number
      Video frame height.
      
      width: number
      Video frame width.
    - OptionalvideosPath?: string
      Deprecated
      Use recordVideo instead.
    - Optionalviewport?: { height: number; width: number } | null
      Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use null to disable the consistent viewport emulation. Learn more about viewport emulation.
      
      NOTE The null value opts out from the default presets, makes viewport depend on the host window size defined by the operating system. It makes the execution of the tests non-deterministic.
  Returns Effect<PlaywrightBrowserContextService, PlaywrightError, Scope>

Since

0.2.4

launchScoped

launchScoped: (
browserType: BrowserType,
options?: LaunchOptions,
) => Effect<PlaywrightBrowserService, PlaywrightError, Scope>

Launches a new browser instance managed by a Scope.

This method automatically closes the browser when the scope is closed.

import { Effect } from "effect";
import { Playwright } from "effect-playwright";
import { chromium } from "playwright-core";

const program = Effect.gen(function* () {
  const browser = yield* Playwright.launchScoped(chromium);
  // Browser will be closed automatically when scope closes
});

await Effect.runPromise(program);

Type Declaration

- (
  browserType: BrowserType,
  options?: LaunchOptions,
  ): Effect<PlaywrightBrowserService, PlaywrightError, Scope>
- Parameters
  - browserType: BrowserType
    The browser type to launch (e.g. chromium, firefox, webkit).
  - Optionaloptions: LaunchOptions
    Optional launch options.
  Returns Effect<PlaywrightBrowserService, PlaywrightError, Scope>

Since

0.1.0

Interface PlaywrightService

Since

Index

Properties

Properties

connectCDP

Type Declaration

Parameters

Returns Effect<PlaywrightBrowserService, PlaywrightError>

Since

connectCDPScoped

Type Declaration

Parameters

Returns Effect<PlaywrightBrowserService, PlaywrightError, Scope>

Since

launch

Type Declaration

Parameters

Returns Effect<PlaywrightBrowserService, PlaywrightError>

Since

launchPersistentContext

Type Declaration

Parameters

OptionalacceptDownloads?: boolean

Optionalargs?: string[]

OptionalbaseURL?: string

OptionalbypassCSP?: boolean

Optionalchannel?: string

OptionalchromiumSandbox?: boolean

OptionalclientCertificates?: { cert?: Buffer<ArrayBufferLike>; certPath?: string; key?: Buffer<ArrayBufferLike>; keyPath?: string; origin: string; passphrase?: string; pfx?: Buffer<ArrayBufferLike>; pfxPath?: string;}[]

OptionalcolorScheme?: "light" | "dark" | "no-preference" | null

Optionalcontrast?: "no-preference" | "more" | null

OptionaldeviceScaleFactor?: number

OptionaldownloadsPath?: string

Optionalenv?: { [key: string]: string | undefined }

OptionalexecutablePath?: string

OptionalextraHTTPHeaders?: { [key: string]: string }

OptionalfirefoxUserPrefs?: { [key: string]: string | number | boolean }

OptionalforcedColors?: "none" | "active" | null

Optionalgeolocation?: { accuracy?: number; latitude: number; longitude: number }

Optionalaccuracy?: number

latitude: number

longitude: number

OptionalhandleSIGHUP?: boolean

OptionalhandleSIGINT?: boolean

OptionalhandleSIGTERM?: boolean

OptionalhasTouch?: boolean

Optionalheadless?: boolean

OptionalhttpCredentials?: { origin?: string; password: string; send?: "unauthorized" | "always"; username: string;}

Optionalorigin?: string

password: string

Optionalsend?: "unauthorized" | "always"

username: string

OptionalignoreDefaultArgs?: boolean | string[]

OptionalignoreHTTPSErrors?: boolean

OptionalisMobile?: boolean

OptionaljavaScriptEnabled?: boolean

Optionallocale?: string

Optionallogger?: Logger

Deprecated

Optionaloffline?: boolean

Optionalpermissions?: string[]

Optionalproxy?: { bypass?: string; password?: string; server: string; username?: string }

Optionalbypass?: string

Optionalpassword?: string

server: string

Optionalusername?: string

OptionalrecordHar?: { content?: "embed" | "omit" | "attach"; mode?: "full" | "minimal"; omitContent?: boolean; path: string; urlFilter?: string | RegExp;}

Optionalcontent?: "embed" | "omit" | "attach"

Optionalmode?: "full" | "minimal"

OptionalomitContent?: boolean

path: string

OptionalurlFilter?: string | RegExp

OptionalrecordVideo?: { dir: string; size?: { height: number; width: number } }

dir: string

Optionalsize?: { height: number; width: number }

height: number

width: number

OptionalreducedMotion?: "reduce" | "no-preference" | null

Optionalscreen?: { height: number; width: number }

`Optional`acceptDownloads?: boolean

`Optional`args?: string[]

`Optional`baseURL?: string

`Optional`bypassCSP?: boolean

`Optional`channel?: string

`Optional`chromiumSandbox?: boolean

`Optional`clientCertificates?: {
cert?: Buffer<ArrayBufferLike>;
certPath?: string;
key?: Buffer<ArrayBufferLike>;
keyPath?: string;
origin: string;
passphrase?: string;
pfx?: Buffer<ArrayBufferLike>;
pfxPath?: string;
}[]

`Optional`colorScheme?: "light" | "dark" | "no-preference" | null

`Optional`contrast?: "no-preference" | "more" | null

`Optional`deviceScaleFactor?: number

`Optional`downloadsPath?: string

`Optional`env?: { [key: string]: string | undefined }

`Optional`executablePath?: string

`Optional`extraHTTPHeaders?: { [key: string]: string }

`Optional`firefoxUserPrefs?: { [key: string]: string | number | boolean }

`Optional`forcedColors?: "none" | "active" | null

`Optional`geolocation?: { accuracy?: number; latitude: number; longitude: number }

`Optional`accuracy?: number

`Optional`handleSIGHUP?: boolean

`Optional`handleSIGINT?: boolean

`Optional`handleSIGTERM?: boolean

`Optional`hasTouch?: boolean

`Optional`headless?: boolean

`Optional`httpCredentials?: {
origin?: string;
password: string;
send?: "unauthorized" | "always";
username: string;
}

`Optional`origin?: string

`Optional`send?: "unauthorized" | "always"

`Optional`ignoreDefaultArgs?: boolean | string[]

`Optional`ignoreHTTPSErrors?: boolean

`Optional`isMobile?: boolean

`Optional`javaScriptEnabled?: boolean

`Optional`locale?: string

`Optional`logger?: Logger

`Optional`offline?: boolean

`Optional`permissions?: string[]

`Optional`proxy?: { bypass?: string; password?: string; server: string; username?: string }

`Optional`bypass?: string

`Optional`password?: string

`Optional`username?: string

`Optional`recordHar?: {
content?: "embed" | "omit" | "attach";
mode?: "full" | "minimal";
omitContent?: boolean;
path: string;
urlFilter?: string | RegExp;
}

`Optional`content?: "embed" | "omit" | "attach"

`Optional`mode?: "full" | "minimal"

`Optional`omitContent?: boolean

`Optional`urlFilter?: string | RegExp

`Optional`recordVideo?: { dir: string; size?: { height: number; width: number } }

`Optional`size?: { height: number; width: number }

`Optional`reducedMotion?: "reduce" | "no-preference" | null

`Optional`screen?: { height: number; width: number }

`Optional`serviceWorkers?: "block" | "allow"

`Optional`slowMo?: number

`Optional`strictSelectors?: boolean

`Optional`timeout?: number

`Optional`timezoneId?: string

`Optional`tracesDir?: string

`Optional`userAgent?: string

`Optional`videoSize?: { height: number; width: number }

`Optional`videosPath?: string

`Optional`viewport?: { height: number; width: number } | null

`Optional`acceptDownloads?: boolean

`Optional`args?: string[]

`Optional`baseURL?: string

`Optional`bypassCSP?: boolean

`Optional`channel?: string

`Optional`chromiumSandbox?: boolean

`Optional`clientCertificates?: {
cert?: Buffer<ArrayBufferLike>;
certPath?: string;
key?: Buffer<ArrayBufferLike>;
keyPath?: string;
origin: string;
passphrase?: string;
pfx?: Buffer<ArrayBufferLike>;
pfxPath?: string;
}[]

`Optional`colorScheme?: "light" | "dark" | "no-preference" | null

`Optional`contrast?: "no-preference" | "more" | null

`Optional`deviceScaleFactor?: number

`Optional`downloadsPath?: string

`Optional`env?: { [key: string]: string | undefined }

`Optional`executablePath?: string

`Optional`extraHTTPHeaders?: { [key: string]: string }

`Optional`firefoxUserPrefs?: { [key: string]: string | number | boolean }

`Optional`forcedColors?: "none" | "active" | null

`Optional`geolocation?: { accuracy?: number; latitude: number; longitude: number }

`Optional`accuracy?: number

`Optional`handleSIGHUP?: boolean

`Optional`handleSIGINT?: boolean

`Optional`handleSIGTERM?: boolean

`Optional`hasTouch?: boolean

`Optional`headless?: boolean