Interface PlaywrightLocatorService

Interface for a Playwright locator.

interface PlaywrightLocatorService {
    _raw: Locator;
    all: () => Effect<readonly PlaywrightLocatorService[], PlaywrightError>;
    allInnerTexts: () => Effect<readonly string[], PlaywrightError>;
    allTextContents: () => Effect<readonly string[], PlaywrightError>;
    and: (
        locator: PlaywrightLocatorService | Locator,
    ) => PlaywrightLocatorService;
    ariaSnapshot: (
        options?: { timeout?: number },
    ) => Effect<string, PlaywrightError>;
    blur: (options?: { timeout?: number }) => Effect<void, PlaywrightError>;
    boundingBox: (
        options?: { timeout?: number },
    ) => Effect<
        Option<{ height: number; width: number; x: number; y: number }>,
        PlaywrightError,
    >;
    check: (
        options?: {
            force?: boolean;
            noWaitAfter?: boolean;
            position?: { x: number; y: number };
            timeout?: number;
            trial?: boolean;
        },
    ) => Effect<void, PlaywrightError>;
    clear: (
        options?: { force?: boolean; noWaitAfter?: boolean; timeout?: number },
    ) => Effect<void, PlaywrightError>;
    click: (
        options?: {
            button?: "left" | "right" | "middle";
            clickCount?: number;
            delay?: number;
            force?: boolean;
            modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[];
            noWaitAfter?: boolean;
            position?: { x: number; y: number };
            steps?: number;
            timeout?: number;
            trial?: boolean;
        },
    ) => Effect<void, PlaywrightError>;
    contentFrame: () => PlaywrightFrameLocatorService;
    count: Effect<number, PlaywrightError>;
    dblclick: (
        options?: {
            button?: "left" | "right" | "middle";
            delay?: number;
            force?: boolean;
            modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[];
            noWaitAfter?: boolean;
            position?: { x: number; y: number };
            steps?: number;
            timeout?: number;
            trial?: boolean;
        },
    ) => Effect<void, PlaywrightError>;
    describe: (description: string) => PlaywrightLocatorService;
    description: () => Option<string>;
    dispatchEvent: (
        type: string,
        eventInit?: EvaluationArgument,
        options?: { timeout?: number },
    ) => Effect<void, PlaywrightError>;
    dragTo: (
        target: PlaywrightLocatorService | Locator,
        options?: {
            force?: boolean;
            noWaitAfter?: boolean;
            sourcePosition?: { x: number; y: number };
            steps?: number;
            targetPosition?: { x: number; y: number };
            timeout?: number;
            trial?: boolean;
        },
    ) => Effect<void, PlaywrightError>;
    elementHandle: (
        options?: { timeout?: number },
    ) => Effect<
        Option<ElementHandle<SVGElement | HTMLElement>>,
        PlaywrightError,
    >;
    elementHandles: () => Effect<
        readonly ElementHandle<SVGElement | HTMLElement>[],
        PlaywrightError,
    >;
    evaluate: <
        R,
        Arg = void,
        E extends SVGElement | HTMLElement = SVGElement | HTMLElement,
    >(
        pageFunction: (element: E, arg: Unboxed<Arg>) => R | Promise<R>,
        arg?: Arg,
        options?: { timeout?: number },
    ) => Effect<R, PlaywrightError>;
    evaluateAll: <
        R,
        Arg = void,
        E extends SVGElement | HTMLElement = SVGElement | HTMLElement,
    >(
        pageFunction: (elements: E[], arg: Unboxed<Arg>) => R | Promise<R>,
        arg?: Arg,
    ) => Effect<R, PlaywrightError>;
    evaluateHandle: <
        R,
        Arg = void,
        E extends SVGElement | HTMLElement = SVGElement | HTMLElement,
    >(
        pageFunction: (element: E, arg: Unboxed<Arg>) => R | Promise<R>,
        arg?: Arg,
    ) => Effect<JSHandle<R>, PlaywrightError>;
    fill: (
        value: string,
        options?: { force?: boolean; noWaitAfter?: boolean; timeout?: number },
    ) => Effect<void, PlaywrightError>;
    filter: (
        options?: {
            has?: Locator;
            hasNot?: Locator;
            hasNotText?: string | RegExp;
            hasText?: string | RegExp;
            visible?: boolean;
        },
    ) => PlaywrightLocatorService;
    first: () => PlaywrightLocatorService;
    focus: (options?: { timeout?: number }) => Effect<void, PlaywrightError>;
    frameLocator: (selector: string) => PlaywrightFrameLocatorService;
    getAttribute: (
        name: string,
        options?: { timeout?: number },
    ) => Effect<string | null, PlaywrightError>;
    getByAltText: (
        text: string | RegExp,
        options?: { exact?: boolean },
    ) => PlaywrightLocatorService;
    getByLabel: (
        text: string | RegExp,
        options?: { exact?: boolean },
    ) => PlaywrightLocatorService;
    getByPlaceholder: (
        text: string | RegExp,
        options?: { exact?: boolean },
    ) => PlaywrightLocatorService;
    getByRole: (
        role:
            | "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"
            | "region"
            | "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",
        options?: {
            checked?: boolean;
            disabled?: boolean;
            exact?: boolean;
            expanded?: boolean;
            includeHidden?: boolean;
            level?: number;
            name?: string | RegExp;
            pressed?: boolean;
            selected?: boolean;
        },
    ) => PlaywrightLocatorService;
    getByTestId: (testId: string | RegExp) => PlaywrightLocatorService;
    getByText: (
        text: string | RegExp,
        options?: { exact?: boolean },
    ) => PlaywrightLocatorService;
    getByTitle: (
        text: string | RegExp,
        options?: { exact?: boolean },
    ) => PlaywrightLocatorService;
    highlight: () => Effect<void, PlaywrightError>;
    hover: (
        options?: {
            force?: boolean;
            modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[];
            noWaitAfter?: boolean;
            position?: { x: number; y: number };
            timeout?: number;
            trial?: boolean;
        },
    ) => Effect<void, PlaywrightError>;
    innerHTML: (
        options?: { timeout?: number },
    ) => Effect<string, PlaywrightError>;
    innerText: (
        options?: { timeout?: number },
    ) => Effect<string, PlaywrightError>;
    inputValue: (
        options?: { timeout?: number },
    ) => Effect<string, PlaywrightError>;
    isChecked: (
        options?: { timeout?: number },
    ) => Effect<boolean, PlaywrightError>;
    isDisabled: (
        options?: { timeout?: number },
    ) => Effect<boolean, PlaywrightError>;
    isEditable: (
        options?: { timeout?: number },
    ) => Effect<boolean, PlaywrightError>;
    isEnabled: (
        options?: { timeout?: number },
    ) => Effect<boolean, PlaywrightError>;
    isHidden: (
        options?: { timeout?: number },
    ) => Effect<boolean, PlaywrightError>;
    isVisible: (
        options?: { timeout?: number },
    ) => Effect<boolean, PlaywrightError>;
    last: () => PlaywrightLocatorService;
    locator: (
        selectorOrLocator: string | PlaywrightLocatorService | Locator,
        options?: {
            has?: Locator;
            hasNot?: Locator;
            hasNotText?: string | RegExp;
            hasText?: string | RegExp;
        },
    ) => PlaywrightLocatorService;
    nth: (index: number) => PlaywrightLocatorService;
    or: (
        locator: PlaywrightLocatorService | Locator,
    ) => PlaywrightLocatorService;
    page: () => PlaywrightPageService;
    press: (
        key: string,
        options?: { delay?: number; noWaitAfter?: boolean; timeout?: number },
    ) => Effect<void, PlaywrightError>;
    pressSequentially: (
        text: string,
        options?: { delay?: number; noWaitAfter?: boolean; timeout?: number },
    ) => Effect<void, PlaywrightError>;
    screenshot: (
        options?: LocatorScreenshotOptions,
    ) => Effect<Buffer<ArrayBufferLike>, PlaywrightError>;
    scrollIntoViewIfNeeded: (
        options?: { timeout?: number },
    ) => Effect<void, PlaywrightError>;
    selectOption: (
        values:
            | string
            | ElementHandle<Node>
            | readonly string[]
            | { index?: number; label?: string; value?: string }
            | readonly ElementHandle<Node>[]
            | readonly { index?: number; label?: string; value?: string }[]
            | null,
        options?: { force?: boolean; noWaitAfter?: boolean; timeout?: number },
    ) => Effect<readonly string[], PlaywrightError>;
    selectText: (
        options?: { force?: boolean; timeout?: number },
    ) => Effect<void, PlaywrightError>;
    setChecked: (
        checked: boolean,
        options?: {
            force?: boolean;
            noWaitAfter?: boolean;
            position?: { x: number; y: number };
            timeout?: number;
            trial?: boolean;
        },
    ) => Effect<void, PlaywrightError>;
    setInputFiles: (
        files:
            | string
            | readonly string[]
            | { buffer: Buffer; mimeType: string; name: string }
            | readonly { buffer: Buffer; mimeType: string; name: string }[],
        options?: { noWaitAfter?: boolean; timeout?: number },
    ) => Effect<void, PlaywrightError>;
    tap: (
        options?: {
            force?: boolean;
            modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[];
            noWaitAfter?: boolean;
            position?: { x: number; y: number };
            timeout?: number;
            trial?: boolean;
        },
    ) => Effect<void, PlaywrightError>;
    textContent: (
        options?: { timeout?: number },
    ) => Effect<string | null, PlaywrightError>;
    toString: () => string;
    uncheck: (
        options?: {
            force?: boolean;
            noWaitAfter?: boolean;
            position?: { x: number; y: number };
            timeout?: number;
            trial?: boolean;
        },
    ) => Effect<void, PlaywrightError>;
    use: <T>(f: (locator: Locator) => Promise<T>) => Effect<T, PlaywrightError>;
    waitFor: (
        options?: {
            state?: "attached" | "detached" | "visible" | "hidden";
            timeout?: number;
        },
    ) => Effect<void, PlaywrightError>;
}

Properties

`Readonly` `Internal`_raw

_raw: Locator

The underlying Playwright Locator instance.

`Readonly`all

all: () => Effect<readonly PlaywrightLocatorService[], PlaywrightError>

Returns an array of locators pointing to the matched elements.

See

Locator.all

Since

0.4.1

`Readonly`allInnerTexts

allInnerTexts: () => Effect<readonly string[], PlaywrightError>

Gets all inner texts.

See

Locator.allInnerTexts

Since

0.1.0

`Readonly`allTextContents

allTextContents: () => Effect<readonly string[], PlaywrightError>

Gets all text contents.

See

Locator.allTextContents

Since

0.1.0

`Readonly`and

and: (locator: PlaywrightLocatorService | Locator) => PlaywrightLocatorService

Creates a locator that matches both this locator and the argument locator.

See

Locator.and

Since

0.4.1

`Readonly`ariaSnapshot

ariaSnapshot: (
options?: { timeout?: number },
) => Effect<string, PlaywrightError>

Returns the accessibility tree snapshot.

See

Locator.ariaSnapshot

Since

0.1.0

`Readonly`blur

blur: (options?: { timeout?: number }) => Effect<void, PlaywrightError>

Removes keyboard focus from the current element.

See

Locator.blur

Since

0.4.2

`Readonly`boundingBox

boundingBox: (
    options?: { timeout?: number },
) => Effect<
    Option<{ height: number; width: number; x: number; y: number }>,
    PlaywrightError,
>

Returns the bounding box of the element.

See

Locator.boundingBox

Since

0.1.0

`Readonly`check

check: (
    options?: {
        force?: boolean;
        noWaitAfter?: boolean;
        position?: { x: number; y: number };
        timeout?: number;
        trial?: boolean;
    },
) => Effect<void, PlaywrightError>

Checks the element.

See

Locator.check

Since

0.1.0

`Readonly`clear

clear: (
options?: { force?: boolean; noWaitAfter?: boolean; timeout?: number },
) => Effect<void, PlaywrightError>

Clear the input field.

See

Locator.clear

Since

0.4.2

`Readonly`click

click: (
    options?: {
        button?: "left" | "right" | "middle";
        clickCount?: number;
        delay?: number;
        force?: boolean;
        modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[];
        noWaitAfter?: boolean;
        position?: { x: number; y: number };
        steps?: number;
        timeout?: number;
        trial?: boolean;
    },
) => Effect<void, PlaywrightError>

Clicks the element.

See

Locator.click

Since

0.1.0

`Readonly`contentFrame

contentFrame: () => PlaywrightFrameLocatorService

Returns a FrameLocator object pointing to the same iframe as this locator.

See

Locator.contentFrame

Since

0.4.1

`Readonly`count

count: Effect<number, PlaywrightError>

Counts the number of matched elements.

See

Locator.count

Since

0.1.0

`Readonly`dblclick

dblclick: (
    options?: {
        button?: "left" | "right" | "middle";
        delay?: number;
        force?: boolean;
        modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[];
        noWaitAfter?: boolean;
        position?: { x: number; y: number };
        steps?: number;
        timeout?: number;
        trial?: boolean;
    },
) => Effect<void, PlaywrightError>

Double-clicks the element.

See

Locator.dblclick

Since

0.4.2

`Readonly`describe

describe: (description: string) => PlaywrightLocatorService

Describes the locator.

See

Locator.describe

Since

0.1.0

`Readonly`description

description: () => Option<string>

Returns the description of the locator.

See

Locator.description

Since

0.1.0

`Readonly`dispatchEvent

dispatchEvent: (
    type: string,
    eventInit?: EvaluationArgument,
    options?: { timeout?: number },
) => Effect<void, PlaywrightError>

Dispatches an event.

See

Locator.dispatchEvent

Since

0.4.2

`Readonly`dragTo

dragTo: (
    target: PlaywrightLocatorService | Locator,
    options?: {
        force?: boolean;
        noWaitAfter?: boolean;
        sourcePosition?: { x: number; y: number };
        steps?: number;
        targetPosition?: { x: number; y: number };
        timeout?: number;
        trial?: boolean;
    },
) => Effect<void, PlaywrightError>

Drags the locator to another target locator.

See

Locator.dragTo

Since

0.4.2

`Readonly`elementHandle

elementHandle: (
    options?: { timeout?: number },
) => Effect<
    Option<ElementHandle<SVGElement | HTMLElement>>,
    PlaywrightError,
>

Resolves given locator to the first matching DOM element.

See

Locator.elementHandle

Since

0.3.0

`Readonly`elementHandles

elementHandles: () => Effect<
readonly ElementHandle<SVGElement | HTMLElement>[],
PlaywrightError,
>

Resolves given locator to all matching DOM elements.

See

Locator.elementHandles

Since

0.3.0

`Readonly`evaluate

evaluate: <
    R,
    Arg = void,
    E extends SVGElement | HTMLElement = SVGElement | HTMLElement,
>(
    pageFunction: (element: E, arg: Unboxed<Arg>) => R | Promise<R>,
    arg?: Arg,
    options?: { timeout?: number },
) => Effect<R, PlaywrightError>

Evaluates a function on the matched element.

Example

import { PlaywrightBrowser } from "effect-playwright";
import { PlaywrightEnvironment } from "effect-playwright/experimental";
import { chromium } from "@playwright/test";
import { Effect } from "effect";

const program = Effect.gen(function* () {
  const browser = yield* PlaywrightBrowser;
  const page = yield* browser.newPage();
  const locator = yield* page.locator("button");
  const buttonContent = yield* locator.evaluate((button) => button.textContent());
}).pipe(PlaywrightEnvironment.provideBrowser, Effect.provide(PlaywrightEnvironment.layer(chromium)));

See

Locator.evaluate

Since

0.1.0

`Readonly`evaluateAll

evaluateAll: <
    R,
    Arg = void,
    E extends SVGElement | HTMLElement = SVGElement | HTMLElement,
>(
    pageFunction: (elements: E[], arg: Unboxed<Arg>) => R | Promise<R>,
    arg?: Arg,
) => Effect<R, PlaywrightError>

Evaluates a function on all matched elements.

See

Locator.evaluateAll

Since

0.3.0

`Readonly`evaluateHandle

evaluateHandle: <
    R,
    Arg = void,
    E extends SVGElement | HTMLElement = SVGElement | HTMLElement,
>(
    pageFunction: (element: E, arg: Unboxed<Arg>) => R | Promise<R>,
    arg?: Arg,
) => Effect<JSHandle<R>, PlaywrightError>

Evaluates a function on the matched element and returns the result as a handle.

See

Locator.evaluateHandle

Since

0.3.0

`Readonly`fill

fill: (
value: string,
options?: { force?: boolean; noWaitAfter?: boolean; timeout?: number },
) => Effect<void, PlaywrightError>

Fills the input field.

See

Locator.fill

Since

0.1.0

`Readonly`filter

filter: (
    options?: {
        has?: Locator;
        hasNot?: Locator;
        hasNotText?: string | RegExp;
        hasText?: string | RegExp;
        visible?: boolean;
    },
) => PlaywrightLocatorService

Narrows existing locator according to the options.

See

Locator.filter

Since

0.4.1

`Readonly`first

first: () => PlaywrightLocatorService

Returns a locator that points to the first matched element.

See

Locator.first

Since

0.1.0

`Readonly`focus

focus: (options?: { timeout?: number }) => Effect<void, PlaywrightError>

Focuses the element.

See

Locator.focus

Since

0.4.2

`Readonly`frameLocator

frameLocator: (selector: string) => PlaywrightFrameLocatorService

Creates a frame locator that will enter the iframe and allow selecting elements in that iframe.

See

Locator.frameLocator

Since

0.4.1

`Readonly`getAttribute

getAttribute: (
name: string,
options?: { timeout?: number },
) => Effect<string | null, PlaywrightError>

Gets an attribute value.

See

Locator.getAttribute

Since

0.1.0

`Readonly`getByAltText

getByAltText: (
text: string | RegExp,
options?: { exact?: boolean },
) => PlaywrightLocatorService

Allows locating elements by their alt text.

See

Locator.getByAltText

Since

0.1.0

`Readonly`getByLabel

getByLabel: (
text: string | RegExp,
options?: { exact?: boolean },
) => PlaywrightLocatorService

Allows locating elements by their label text.

See

Locator.getByLabel

Since

0.1.0

`Readonly`getByPlaceholder

getByPlaceholder: (
text: string | RegExp,
options?: { exact?: boolean },
) => PlaywrightLocatorService

Allows locating elements by their placeholder text.

See

Locator.getByPlaceholder

Since

0.1.0

`Readonly`getByRole

getByRole: (
    role:
        | "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"
        | "region"
        | "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",
    options?: {
        checked?: boolean;
        disabled?: boolean;
        exact?: boolean;
        expanded?: boolean;
        includeHidden?: boolean;
        level?: number;
        name?: string | RegExp;
        pressed?: boolean;
        selected?: boolean;
    },
) => PlaywrightLocatorService

Allows locating elements by their ARIA role, ARIA attributes and accessible name.

See

Locator.getByRole

Since

0.1.0

`Readonly`getByTestId

getByTestId: (testId: string | RegExp) => PlaywrightLocatorService

Allows locating elements by their test id.

See

Locator.getByTestId

Since

0.1.0

`Readonly`getByText

getByText: (
text: string | RegExp,
options?: { exact?: boolean },
) => PlaywrightLocatorService

Allows locating elements that contain given text.

See

Locator.getByText

Since

0.1.0

`Readonly`getByTitle

getByTitle: (
text: string | RegExp,
options?: { exact?: boolean },
) => PlaywrightLocatorService

Allows locating elements by their title attribute.

See

Locator.getByTitle

Since

0.1.0

`Readonly`highlight

highlight: () => Effect<void, PlaywrightError>

Highlights the corresponding element(s) on the screen.

See

Locator.highlight

Since

0.4.1

`Readonly`hover

hover: (
    options?: {
        force?: boolean;
        modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[];
        noWaitAfter?: boolean;
        position?: { x: number; y: number };
        timeout?: number;
        trial?: boolean;
    },
) => Effect<void, PlaywrightError>

Hovers over the element.

See

Locator.hover

Since

0.4.2

`Readonly`innerHTML

innerHTML: (options?: { timeout?: number }) => Effect<string, PlaywrightError>

Gets the inner HTML.

See

Locator.innerHTML

Since

0.1.0

`Readonly`innerText

innerText: (options?: { timeout?: number }) => Effect<string, PlaywrightError>

Gets the inner text.

See

Locator.innerText

Since

0.1.0

`Readonly`inputValue

inputValue: (options?: { timeout?: number }) => Effect<string, PlaywrightError>

Gets the input value.

See

Locator.inputValue

Since

0.1.0

`Readonly`isChecked

isChecked: (options?: { timeout?: number }) => Effect<boolean, PlaywrightError>

Returns whether the element is checked.

See

Locator.isChecked

Since

0.4.1

`Readonly`isDisabled

isDisabled: (options?: { timeout?: number }) => Effect<boolean, PlaywrightError>

Returns whether the element is disabled.

See

Locator.isDisabled

Since

0.4.1

`Readonly`isEditable

isEditable: (options?: { timeout?: number }) => Effect<boolean, PlaywrightError>

Returns whether the element is editable.

See

Locator.isEditable

Since

0.4.1

`Readonly`isEnabled

isEnabled: (options?: { timeout?: number }) => Effect<boolean, PlaywrightError>

Returns whether the element is enabled.

See

Locator.isEnabled

Since

0.4.1

`Readonly`isHidden

isHidden: (options?: { timeout?: number }) => Effect<boolean, PlaywrightError>

Returns whether the element is hidden.

See

Locator.isHidden

Since

0.4.1

`Readonly`isVisible

isVisible: (options?: { timeout?: number }) => Effect<boolean, PlaywrightError>

Returns whether the element is visible.

See

Locator.isVisible

Since

0.4.1

`Readonly`last

last: () => PlaywrightLocatorService

Returns a locator that points to the last matched element.

See

Locator.last

Since

0.1.0

`Readonly`locator

locator: (
    selectorOrLocator: string | PlaywrightLocatorService | Locator,
    options?: {
        has?: Locator;
        hasNot?: Locator;
        hasNotText?: string | RegExp;
        hasText?: string | RegExp;
    },
) => PlaywrightLocatorService

Returns a locator that points to a matched element.

See

Locator.locator

Since

0.1.0

`Readonly`nth

nth: (index: number) => PlaywrightLocatorService

Returns a locator that points to the nth matched element.

See

Locator.nth

Since

0.1.0

`Readonly`or

or: (locator: PlaywrightLocatorService | Locator) => PlaywrightLocatorService

Creates a locator that matches either this locator or the argument locator.

See

Locator.or

Since

0.4.1

`Readonly`page

page: () => PlaywrightPageService

A page this locator belongs to.

See

Locator.page

Since

0.4.1

`Readonly`press

press: (
key: string,
options?: { delay?: number; noWaitAfter?: boolean; timeout?: number },
) => Effect<void, PlaywrightError>

Focuses the element, and then uses keyboard.down and keyboard.up.

See

Locator.press

Since

0.4.2

`Readonly`pressSequentially

pressSequentially: (
text: string,
options?: { delay?: number; noWaitAfter?: boolean; timeout?: number },
) => Effect<void, PlaywrightError>

Focuses the element, and then sends a keydown, keypress/input, and keyup event for each character in the text.

See

Locator.pressSequentially

Since

0.4.2

`Readonly`screenshot

screenshot: (
options?: LocatorScreenshotOptions,
) => Effect<Buffer<ArrayBufferLike>, PlaywrightError>

Captures a screenshot of the element.

See

Locator.screenshot

Since

0.4.1

`Readonly`scrollIntoViewIfNeeded

scrollIntoViewIfNeeded: (
options?: { timeout?: number },
) => Effect<void, PlaywrightError>

Scrolls the element into view if needed.

See

Locator.scrollIntoViewIfNeeded

Since

0.4.2

`Readonly`selectOption

selectOption: (
    values:
        | string
        | ElementHandle<Node>
        | readonly string[]
        | { index?: number; label?: string; value?: string }
        | readonly ElementHandle<Node>[]
        | readonly { index?: number; label?: string; value?: string }[]
        | null,
    options?: { force?: boolean; noWaitAfter?: boolean; timeout?: number },
) => Effect<readonly string[], PlaywrightError>

Selects an option in a <select> element.

See

Locator.selectOption

Since

0.4.2

`Readonly`selectText

selectText: (
options?: { force?: boolean; timeout?: number },
) => Effect<void, PlaywrightError>

Selects text.

See

Locator.selectText

Since

0.4.2

`Readonly`setChecked

setChecked: (
    checked: boolean,
    options?: {
        force?: boolean;
        noWaitAfter?: boolean;
        position?: { x: number; y: number };
        timeout?: number;
        trial?: boolean;
    },
) => Effect<void, PlaywrightError>

Checks the element if not already checked.

See

Locator.setChecked

Since

0.4.2

`Readonly`setInputFiles

setInputFiles: (
    files:
        | string
        | readonly string[]
        | { buffer: Buffer; mimeType: string; name: string }
        | readonly { buffer: Buffer; mimeType: string; name: string }[],
    options?: { noWaitAfter?: boolean; timeout?: number },
) => Effect<void, PlaywrightError>

Sets the value of the file input.

See

Locator.setInputFiles

Since

0.4.2

`Readonly`tap

tap: (
    options?: {
        force?: boolean;
        modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[];
        noWaitAfter?: boolean;
        position?: { x: number; y: number };
        timeout?: number;
        trial?: boolean;
    },
) => Effect<void, PlaywrightError>

Taps the element.

See

Locator.tap

Since

0.4.2

`Readonly`textContent

textContent: (
options?: { timeout?: number },
) => Effect<string | null, PlaywrightError>

Gets the text content.

See

Locator.textContent

Since

0.1.0

`Readonly`toString

toString: () => string

Returns the string representation of the locator.

See

Locator.toString

Since

0.4.1

`Readonly`uncheck

uncheck: (
    options?: {
        force?: boolean;
        noWaitAfter?: boolean;
        position?: { x: number; y: number };
        timeout?: number;
        trial?: boolean;
    },
) => Effect<void, PlaywrightError>

Unchecks the element.

See

Locator.uncheck

Since

0.4.2

`Readonly`use

use: <T>(f: (locator: Locator) => Promise<T>) => Effect<T, PlaywrightError>

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

Type Declaration

- <T>(f: (locator: Locator) => Promise<T>): Effect<T, PlaywrightError>
- Type Parameters
  - T
  Parameters
  - f: (locator: Locator) => Promise<T>
    A function that takes the Playwright Locator and returns a Promise.
  Returns Effect<T, PlaywrightError>
  An effect that wraps the promise and returns its result.

Example

const isVisible = yield* locator.use((l) => l.isVisible());

See

Locator

Since

0.1.0

`Readonly`waitFor

waitFor: (
    options?: {
        state?: "attached" | "detached" | "visible" | "hidden";
        timeout?: number;
    },
) => Effect<void, PlaywrightError>

Returns when element specified by locator satisfies the state option.

See

Locator.waitFor

Since

0.1.0

Interface PlaywrightLocatorService

Index

Properties

Properties

Readonly Internal_raw

Readonlyall

See

Since

ReadonlyallInnerTexts

See

Since

ReadonlyallTextContents

See

Since

Readonlyand

See

Since

ReadonlyariaSnapshot

See

Since

Readonlyblur

See

Since

ReadonlyboundingBox

See

Since

Readonlycheck

See

Since

Readonlyclear

See

Since

Readonlyclick

See

Since

ReadonlycontentFrame

See

Since

Readonlycount

See

Since

Readonlydblclick

See

Since

Readonlydescribe

See

Since

Readonlydescription

See

Since

ReadonlydispatchEvent

See

Since

ReadonlydragTo

See

Since

ReadonlyelementHandle

See

Since

ReadonlyelementHandles

See

Since

Readonlyevaluate

Example

See

Since

ReadonlyevaluateAll

See

Since

ReadonlyevaluateHandle

See

Since

Readonlyfill

See

Since

Readonlyfilter

See

Since

Readonlyfirst

See

`Readonly` `Internal`_raw

`Readonly`all

`Readonly`allInnerTexts

`Readonly`allTextContents

`Readonly`and

`Readonly`ariaSnapshot

`Readonly`blur

`Readonly`boundingBox

`Readonly`check

`Readonly`clear

`Readonly`click

`Readonly`contentFrame

`Readonly`count

`Readonly`dblclick

`Readonly`describe

`Readonly`description

`Readonly`dispatchEvent

`Readonly`dragTo

`Readonly`elementHandle

`Readonly`elementHandles

`Readonly`evaluate

`Readonly`evaluateAll

`Readonly`evaluateHandle

`Readonly`fill

`Readonly`filter

`Readonly`first

`Readonly`focus

`Readonly`frameLocator

`Readonly`getAttribute

`Readonly`getByAltText

`Readonly`getByLabel

`Readonly`getByPlaceholder

`Readonly`getByRole

`Readonly`getByTestId

`Readonly`getByText

`Readonly`getByTitle

`Readonly`highlight

`Readonly`hover

`Readonly`innerHTML

`Readonly`innerText

`Readonly`inputValue

`Readonly`isChecked

`Readonly`isDisabled

`Readonly`isEditable

`Readonly`isEnabled

`Readonly`isHidden

`Readonly`isVisible

`Readonly`last

`Readonly`locator