ScreenCIPage
ScreenCIPage =
Omit<Page,"click"|"mouse"|"screenshot"|"waitForTimeout"|LocatorReturnMethodNames> &object
Defined in: types.ts:1118
Type Declaration
Section titled “Type Declaration”mouse:
ScreenCIMouse
click()
Section titled “click()”click(
selector,options?):Promise<void>
Clicks an element matched by selector with an animated cursor move.
ScreenCI defaults noWaitAfter to true for this action so the rendered
click can complete before navigation waits. Pass noWaitAfter: false to
keep Playwright’s default waiting behavior.
Parameters
Section titled “Parameters”selector
Section titled “selector”string
options?
Section titled “options?”object & CursorActionMoveOptions & object
Returns
Section titled “Returns”Promise<void>
getByAltText()
Section titled “getByAltText()”getByAltText(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string | RegExp, object]
Returns
Section titled “Returns”getByLabel()
Section titled “getByLabel()”getByLabel(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string | RegExp, object]
Returns
Section titled “Returns”getByPlaceholder()
Section titled “getByPlaceholder()”getByPlaceholder(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string | RegExp, object]
Returns
Section titled “Returns”getByRole()
Section titled “getByRole()”getByRole(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…["region" | "alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem", object]
Returns
Section titled “Returns”getByTestId()
Section titled “getByTestId()”getByTestId(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string | RegExp]
Returns
Section titled “Returns”getByText()
Section titled “getByText()”getByText(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string | RegExp, object]
Returns
Section titled “Returns”getByTitle()
Section titled “getByTitle()”getByTitle(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string | RegExp, object]
Returns
Section titled “Returns”locator()
Section titled “locator()”locator(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string, object]
Returns
Section titled “Returns”screenshot()
Section titled “screenshot()”screenshot(
options?):Promise<Buffer<ArrayBufferLike>>
Captures a screenshot. Inside a video() recording this also writes a
branded still as a separate screenshot recording named ”
Parameters
Section titled “Parameters”options?
Section titled “options?”ScreenCIScreenshotOptions
Returns
Section titled “Returns”Promise<Buffer<ArrayBufferLike>>
waitForTimeout()
Section titled “waitForTimeout()”waitForTimeout(
timeout?):Promise<void>
Waits in the recording timeline. Plain screenci test collapses this to
0ms so authoring runs stay fast; screenci record and
screenci test --mock-record keep the requested duration.
Use Playwright locator/action waits for application readiness instead of relying on this as a real polling delay.
Parameters
Section titled “Parameters”timeout?
Section titled “timeout?”number
Returns
Section titled “Returns”Promise<void>