API reference

Everything POMWright exports, imported from the package root: import { PageObject } from "pomwright". Types are imported with import type. Each page documents its members in Playwright’s form: usage, arguments, return value and the errors thrown, with the real messages. The same text is in the doc comments, so an editor’s hover shows it.

Page objects

export	what it is
PageObject	the base class of a page object: a registry, a navigation helper and a session storage helper for a page
PageObjectOptions	the constructor’s options: label, navOptions, sessionStorage, locators
PageObjectTypeOptions	the second type argument: the URL types and the session storage schema
BaseUrlTypeFromOptions, UrlPathTypeFromOptions, FullUrlTypeFromOptions, StorageTypeFromOptions	the types PageObjectTypeOptions produces

Locators

export	what it is
LocatorRegistry	a registry: add, getNestedLocator, getLocator, getLocatorSchema, verify, createReusable
createRegistryWithAccessors	creates a registry without a page object
LocatorRegistryOptions	the registry’s options: strictChains
AddAccessor, GetLocatorAccessor, GetNestedLocatorAccessor, GetLocatorSchemaAccessor	the registry’s methods as functions of their own
Registration	what add(path) returns: the ten locator methods, then filter, nth, describe (not exported)
LocatorQueryBuilder	a query, what getLocatorSchema(path) returns
LocatorUpdateBuilder	what a query’s update() and replace() return
ReusableLocator	a seed from createReusable
FilterDefinition	the argument of filter
IndexSelector	the argument of nth
LocatorSchemaPathFormat	the path rules as a type
LocatorSchemaPathArgument	the type of a path parameter, for helpers that forward paths

Navigation

export	what it is
NavigationFor	a page object’s navigation: goto, expectThisPage, expectAnotherPage
NavigationOptions	waitUntil and timeout
ThisPageOptions	the options of goto() and expectThisPage(), with runPostNavigationActions
UrlMatcher	the fullUrl of a page whose URL varies

Session storage

export	what it is
SessionStorage	Playwright’s page.sessionStorage with batches, report steps, an origin check, codecs and seed
json	the JSON codec
Codec	how a key’s value is stored and read back
SessionStorageSchema	codecs by key

Reports

export	what it is
test	Playwright’s test with the log fixture
PlaywrightReportLogger	a logger whose entries are attached to the report
LogEntry, LogLevel	one entry; the levels
step	the @step decorator

Errors

Error messages lists every message, by the call that throws it.