flagpole/dist/browserelement.d.ts

Simple and fast DOM integration, headless or headful browser, and REST API testing framework.

/// <reference types="node" />
import { PuppeteerElement } from "./puppeteerelement";
import { iValue, iAssertionContext, iBounds, ScreenshotOpts, KeyValue } from "./interfaces";
import { ElementHandle } from "puppeteer";
import { iScenario } from ".";
export declare class BrowserElement extends PuppeteerElement implements iValue {
    protected _input: ElementHandle;
    get $(): ElementHandle;
    static create(input: ElementHandle, context: iAssertionContext, name: string, path?: string): Promise<BrowserElement>;
    protected constructor(input: ElementHandle, context: iAssertionContext, name: string, path?: string);
    find(selector: string): Promise<iValue>;
    findAll(selector: string): Promise<BrowserElement[]>;
    getClosest(selector?: string): Promise<iValue>;
    getChildren(selector?: string): Promise<iValue[]>;
    getParent(): Promise<iValue>;
    getSiblings(selector?: string): Promise<iValue[]>;
    getPreviousSibling(selector?: string): Promise<iValue>;
    getPreviousSiblings(selector?: string): Promise<iValue[]>;
    getNextSibling(selector?: string): Promise<BrowserElement | iValue>;
    getNextSiblings(selector?: string): Promise<iValue[]>;
    getBounds(boxType?: string): Promise<iBounds | null>;
    focus(): Promise<any>;
    blur(): Promise<any>;
    hover(): Promise<void>;
    tap(): Promise<void>;
    press(key: string, opts?: any): Promise<void>;
    type(textToType: string, opts?: any): Promise<void>;
    clear(): Promise<void>;
    fillForm(attributeName: string, formData: KeyValue): Promise<iValue>;
    fillForm(formData: KeyValue): Promise<iValue>;
    submit(): Promise<void>;
    submit(message: string): Promise<iScenario>;
    submit(callback: Function): Promise<iScenario>;
    submit(scenario: iScenario): Promise<iScenario>;
    submit(message: string, callback: Function): Promise<iScenario>;
    click(): Promise<void>;
    click(message: string): Promise<iScenario>;
    click(callback: Function): Promise<iScenario>;
    click(scenario: iScenario): Promise<iScenario>;
    click(message: string, callback: Function): Promise<iScenario>;
    screenshot(): Promise<Buffer>;
    screenshot(localFilePath: string): Promise<Buffer>;
    screenshot(localFilePath: string, opts: ScreenshotOpts): Promise<Buffer>;
    screenshot(opts: ScreenshotOpts): Promise<Buffer>;
    selectOption(valuesToSelect: string | string[]): Promise<void>;
    pressEnter(): Promise<void>;
    scrollTo(): Promise<void>;
    protected _getInnerText(): Promise<string>;
    protected _getInnerHtml(): Promise<string>;
    protected _getOuterHtml(): Promise<string>;
    protected _getData(key: string): Promise<unknown>;
    protected _getValue(): Promise<unknown>;
    protected _getText(): Promise<string>;
    protected _getClassName(): Promise<string>;
    protected _getTagName(): Promise<string>;
    protected _getAttribute(key: string): Promise<string>;
    protected isPasswordField(): Promise<boolean>;
}