effect-playwright
    Preparing search index...

    Interface PlaywrightBrowserService

    0.1.0

    interface PlaywrightBrowserService {
        browserType: Effect<BrowserType<{}>>;
        close: Effect<void, PlaywrightError>;
        contexts: Effect<PlaywrightBrowserContextService[]>;
        eventStream: <K extends "disconnected">(
            event: K,
        ) => Stream<
            ReturnType<
                { disconnected: (browser: Browser) => PlaywrightBrowserService }[K],
            >,
        >;
        isConnected: Effect<boolean>;
        newContext: (
            options?: BrowserContextOptions,
        ) => Effect<PlaywrightBrowserContextService, PlaywrightError, Scope>;
        newPage: (
            options?: {
                acceptDownloads?: boolean;
                baseURL?: string;
                bypassCSP?: 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;
                extraHTTPHeaders?: { [key: string]: string };
                forcedColors?: "none" | "active" | null;
                geolocation?: { accuracy?: number; latitude: number; longitude: number };
                hasTouch?: boolean;
                httpCredentials?: {
                    origin?: string;
                    password: string;
                    send?: "unauthorized" | "always";
                    username: 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?: "allow" | "block";
                storageState?:
                    | string
                    | {
                        cookies: {
                            domain: string;
                            expires: number;
                            httpOnly: boolean;
                            name: string;
                            path: string;
                            sameSite: "None"
                            | "Strict"
                            | "Lax";
                            secure: boolean;
                            value: string;
                        }[];
                        origins: {
                            localStorage: { name: string; value: string }[];
                            origin: string;
                        }[];
                    };
                strictSelectors?: boolean;
                timezoneId?: string;
                userAgent?: string;
                videoSize?: { height: number; width: number };
                videosPath?: string;
                viewport?: { height: number; width: number } | null;
            },
        ) => Effect<PlaywrightPageService, PlaywrightError>;
        use: <T>(f: (browser: Browser) => Promise<T>) => Effect<T, PlaywrightError>;
        version: Effect<string>;
    }
    Index

    other

    browserType close contexts isConnected newContext newPage use version

    custom

    eventStream

    other

    browserType: Effect<BrowserType<{}>>

    An Effect that returns the browser type (chromium, firefox or webkit) that the browser belongs to.

    Browser.browserType

    close: Effect<void, PlaywrightError>

    An Effect that closes the browser and all of its pages.

    Browser.close

    contexts: Effect<PlaywrightBrowserContextService[]>

    An Effect that returns the list of all open browser contexts.

    Browser.contexts

    isConnected: Effect<boolean>

    An Effect that returns whether the browser is connected.

    Browser.isConnected

    newContext: (
        options?: BrowserContextOptions,
    ) => Effect<PlaywrightBrowserContextService, PlaywrightError, Scope>
    newPage: (
        options?: {
            acceptDownloads?: boolean;
            baseURL?: string;
            bypassCSP?: 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;
            extraHTTPHeaders?: { [key: string]: string };
            forcedColors?: "none" | "active" | null;
            geolocation?: { accuracy?: number; latitude: number; longitude: number };
            hasTouch?: boolean;
            httpCredentials?: {
                origin?: string;
                password: string;
                send?: "unauthorized" | "always";
                username: 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?: "allow" | "block";
            storageState?:
                | string
                | {
                    cookies: {
                        domain: string;
                        expires: number;
                        httpOnly: boolean;
                        name: string;
                        path: string;
                        sameSite: "None"
                        | "Strict"
                        | "Lax";
                        secure: boolean;
                        value: string;
                    }[];
                    origins: {
                        localStorage: { name: string; value: string }[];
                        origin: string;
                    }[];
                };
            strictSelectors?: boolean;
            timezoneId?: string;
            userAgent?: string;
            videoSize?: { height: number; width: number };
            videosPath?: string;
            viewport?: { height: number; width: number } | null;
        },
    ) => Effect<PlaywrightPageService, PlaywrightError>

    Opens a new page in the browser.

    Type Declaration

      • (
            options?: {
                acceptDownloads?: boolean;
                baseURL?: string;
                bypassCSP?: 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;
                extraHTTPHeaders?: { [key: string]: string };
                forcedColors?: "none" | "active" | null;
                geolocation?: { accuracy?: number; latitude: number; longitude: number };
                hasTouch?: boolean;
                httpCredentials?: {
                    origin?: string;
                    password: string;
                    send?: "unauthorized" | "always";
                    username: 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?: "allow" | "block";
                storageState?:
                    | string
                    | {
                        cookies: {
                            domain: string;
                            expires: number;
                            httpOnly: boolean;
                            name: string;
                            path: string;
                            sameSite: "None"
                            | "Strict"
                            | "Lax";
                            secure: boolean;
                            value: string;
                        }[];
                        origins: {
                            localStorage: { name: string; value: string }[];
                            origin: string;
                        }[];
                    };
                strictSelectors?: boolean;
                timezoneId?: string;
                userAgent?: string;
                videoSize?: { height: number; width: number };
                videosPath?: string;
                viewport?: { height: number; width: number } | null;
            },
        ): Effect<PlaywrightPageService, PlaywrightError>

      • Parameters

        • Optionaloptions: {
              acceptDownloads?: boolean;
              baseURL?: string;
              bypassCSP?: 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;
              extraHTTPHeaders?: { [key: string]: string };
              forcedColors?: "none" | "active" | null;
              geolocation?: { accuracy?: number; latitude: number; longitude: number };
              hasTouch?: boolean;
              httpCredentials?: {
                  origin?: string;
                  password: string;
                  send?: "unauthorized" | "always";
                  username: 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?: "allow" | "block";
              storageState?:
                  | string
                  | {
                      cookies: {
                          domain: string;
                          expires: number;
                          httpOnly: boolean;
                          name: string;
                          path: string;
                          sameSite: "None"
                          | "Strict"
                          | "Lax";
                          secure: boolean;
                          value: string;
                      }[];
                      origins: {
                          localStorage: { name: string; value: string }[];
                          origin: string;
                      }[];
                  };
              strictSelectors?: boolean;
              timezoneId?: string;
              userAgent?: string;
              videoSize?: { height: number; width: number };
              videosPath?: string;
              viewport?: { height: number; width: number } | null;
          }

          Optional options for creating the new page.

          • OptionalacceptDownloads?: boolean

            Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.

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

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

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

            An object containing additional HTTP headers to be sent with every request. Defaults to none.

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

          • OptionalhasTouch?: boolean

            Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.

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

            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 to use with this context. Defaults to none.

            • 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?: "allow" | "block"

            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.
          • OptionalstorageState?:
                | string
                | {
                    cookies: {
                        domain: string;
                        expires: number;
                        httpOnly: boolean;
                        name: string;
                        path: string;
                        sameSite: "None"
                        | "Strict"
                        | "Lax";
                        secure: boolean;
                        value: string;
                    }[];
                    origins: {
                        localStorage: { name: string; value: string }[];
                        origin: string;
                    }[];
                }

            Learn more about storage state and auth.

            Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via browserContext.storageState([options]).

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

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

          • OptionaluserAgent?: string

            Specific user agent to use in this context.

          • OptionalvideoSize?: { height: number; width: number }

            Use recordVideo instead.

            • height: number

              Video frame height.

            • width: number

              Video frame width.

          • OptionalvideosPath?: string

            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<PlaywrightPageService, PlaywrightError>

        An effect that resolves to a PlaywrightPage service.

    const page = yield* browser.newPage();

    Browser.newPage

    use: <T>(f: (browser: Browser) => Promise<T>) => Effect<T, PlaywrightError>

    A generic utility to execute any promise-based method on the underlying Playwright Browser. Can be used to access any Browser functionality not directly exposed by this service.

    Type Declaration

      • <T>(f: (browser: Browser) => Promise<T>): Effect<T, PlaywrightError>

      • Type Parameters

        • T

        Parameters

        • f: (browser: Browser) => Promise<T>

          A function that takes the Playwright Browser and returns a Promise.

        Returns Effect<T, PlaywrightError>

        An effect that wraps the promise and returns its result.

    const contexts = yield* browser.use((b) => b.contexts());

    Browser

    version: Effect<string>

    An Effect that returns the version of the browser.

    Browser.version

    custom

    eventStream: <K extends "disconnected">(
        event: K,
    ) => Stream<
        ReturnType<
            { disconnected: (browser: Browser) => PlaywrightBrowserService }[K],
        >,
    >

    Creates a stream of the given event from the browser.

    const disconnectedStream = browser.eventStream("disconnected");

    Browser.on

    0.1.2

    Settings

    Member Visibility

    On This Page

    other
    custom