vasu-playwright-utils

vasu-playwright-utils

A Playwright TypeScript utility library that simplifies browser automation with reusable helper functions for actions, assertions, locators, element queries, page management, and API requests.

Setup Requirement

Before using any utility, you must call setPage(page) with the Playwright Page instance:

import { setPage } from 'vasu-playwright-utils';

// In test setup or beforeEach:
setPage(page);

Import Patterns

Main export (all utilities)

import { click, fill, expectElementToBeVisible, getLocator } from 'vasu-playwright-utils';

Subpath exports (tree-shakable)

import { click, fill, clickAndNavigate } from 'vasu-playwright-utils/action-utils';
import { expectElementToBeVisible, expectPageToHaveURL } from 'vasu-playwright-utils/assert-utils';
import { getLocator, getLocatorByRole, getLocatorByText } from 'vasu-playwright-utils/locator-utils';
import { getText, isElementVisible, waitForElementToBeVisible } from 'vasu-playwright-utils/element-utils';
import { gotoURL, switchPage, getPage, setPage } from 'vasu-playwright-utils/page-utils';
import { getRequest, postRequest } from 'vasu-playwright-utils/api-utils';
import { ClickOptions, FillOptions } from 'vasu-playwright-utils/types';

Core Pattern

Most functions accept string | Locator as their first argument (the input parameter). This means you can pass either a CSS/XPath selector string or a Playwright Locator object.

Action functions enforce visibility by default (onlyVisible: true). Override with { onlyVisible: false }.

Most functions accept an optional options object as the last parameter, extending Playwright's native options with:

• onlyVisible?: boolean - Filter to visible elements only (default: true for actions)
• stable?: boolean - Wait for element position to stabilize before acting
• loadState?: WaitForLoadStateOptions - Wait for load state after navigation actions
• soft?: boolean - Use soft assertions (won't stop test on failure)