@types/k6 0.44.0 → 0.44.2

k6/README.md

@@ -8,9 +8,9 @@ This package contains type definitions for k6 (https://k6.io/docs/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6.
 
 ### Additional Details
- * Last updated: Thu, 27 Apr 2023 08:02:47 GMT
+ * Last updated: Tue, 30 May 2023 15:02:52 GMT
  * Dependencies: none
  * Global values: none
 
 # Credits
-These definitions were written by [na--](https://github.com/na--), [Mihail Stoykov](https://github.com/MStoykov), [Ivan](https://github.com/codebien), [Ivan Mirić](https://github.com/imiric), [Théo Crevon](https://github.com/oleiade), [Oleg Bespalov](https://github.com/olegbespalov), [Pepe Cano](https://github.com/ppcano), and [Nicole van der Hoeven](https://github.com/nicolevanderhoeven).
+These definitions were written by [na--](https://github.com/na--), [Mihail Stoykov](https://github.com/MStoykov), [Ivan](https://github.com/codebien), [Ivan Mirić](https://github.com/imiric), [Théo Crevon](https://github.com/oleiade), [Oleg Bespalov](https://github.com/olegbespalov), [Pepe Cano](https://github.com/ppcano), [Nicole van der Hoeven](https://github.com/nicolevanderhoeven), and [Ankur Agarwal](https://github.com/ankur22).

k6/experimental/browser/element_handle.d.ts

@@ -0,0 +1,209 @@
+import {
+  Rect,
+  ElementHandlePointerOptions,
+  ElementClickOptions,
+  KeyboardModifierOptions,
+  TimeoutOptions,
+  KeyboardPressOptions,
+  ScreenshotOptions,
+  ElementHandleOptions,
+  MouseMoveOptions,
+  StrictnessOptions,
+  InputElementState,
+  ElementState,
+  SelectOptionsObject } from "./";
+import { JSHandle } from "./js_handle";
+import { Frame } from "./frame";
+
+/**
+ * ElementHandle represents an in-page DOM element.
+ */
+export class ElementHandle extends JSHandle {
+  /**
+   * Finds an element matching the specified selector in the `ElementHandle`'s subtree.
+   * @param selector A selector to query element for.
+   * @returns An `ElementHandle` pointing to the result element or `null`.
+   */
+  $(selector: string): ElementHandle | null;
+
+  /**
+   * Finds all elements matching the specified selector in the `ElementHandle`'s subtree.
+   * @param selector A selector to query element for.
+   * @returns A list of `ElementHandle`s pointing to the result elements.
+   */
+  $$(selector: string): ElementHandle[];
+
+  /**
+   * This method returns the bounding box of the element.
+   * @returns Element's bounding box.
+   */
+  boundingBox(): Rect;
+
+  /**
+   * Get the content frame for element handles.
+   * @returns The content frame handle of the element handle.
+   */
+  contentFrame(): Frame;
+
+  /**
+   * Fill the `input` or `textarea` element with the provided `value`.
+   * @param value Value to fill for the `input` or `textarea` element.
+   * @param options Element handle options.
+   */
+  fill(value: string, options?: ElementHandleOptions): void;
+
+  /**
+   * Focuses the element.
+   */
+  focus(): void;
+
+  /**
+   * Fetch the element's attribute value.
+   * @param name Attribute name to get the value for.
+   * @returns Attribute value.
+   */
+  getAttribute(name: string): string | null;
+
+  /**
+   * Scrolls element into view and hovers over its center point.
+   * @param options Hover options.
+   */
+  hover(options?: ElementClickOptions & KeyboardModifierOptions): void;
+
+  /**
+   * Returns the `element.innerHTML`.
+   * @returns Element's innerHTML.
+   */
+  innerHTML(): string;
+
+  /**
+   * Returns the `element.innerText`.
+   * @returns Element's innerText.
+   */
+  innerText(): string;
+
+  /**
+   * Returns `input.value` for the selected `input`, `textarea` or `select` element.
+   * @returns The input value of the element.
+   */
+  inputValue(options?: TimeoutOptions): string;
+
+  /**
+   * Checks if a checkbox or radio is checked.
+   * @returns Whether the element is checked.
+   */
+  isChecked(): boolean;
+
+  /**
+   * Checks if the element is disabled.
+   * @returns Whether the element is disabled.
+   */
+  isDisabled(): boolean;
+
+  /**
+   * Checks if the element is editable.
+   * @returns Whether the element is editable.
+   */
+  isEditable(): boolean;
+
+  /**
+   * Checks if the element is enabled.
+   * @returns Whether the element is enabled.
+   */
+  isEnabled(): boolean;
+
+  /**
+   * Checks if the element is hidden.
+   * @returns Whether the element is hidden.
+   */
+  isHidden(): boolean;
+
+  /**
+   * Checks if the element is visible.
+   * @returns Whether the element is visible.
+   */
+  isVisible(): boolean;
+
+  /**
+   * Returns the frame containing the given element.
+   * @returns The frame that contains the element handle.
+   */
+  ownerFrame(): Frame;
+
+  /**
+   * Focuses the element, and then uses `keyboard.down` and `keyboard.up` with the specified key.
+   * @param key A keyboard key name or a single character to press.
+   * @param options Keyboard press options.
+   */
+  press(key: string, options?: KeyboardPressOptions): void;
+
+  /**
+   * This method scrolls element into view, if needed, and then captures a
+   * screenshot of it.
+   * @param options Screenshot options.
+   * @returns An `ArrayBuffer` with the screenshot data.
+   */
+  screenshot(options?: ScreenshotOptions & TimeoutOptions): ArrayBuffer;
+
+  /**
+   * This method checks whether the element is actionable using provided options, and
+   * then tries to scroll it into view, unless it is completely visible.
+   * @param options Element handle options.
+   */
+  scrollIntoViewIfNeeded(options?: ElementHandleOptions): void;
+
+  /**
+   * Select one or more options of a `<select>` element which match the values.
+   * @param values Values of options to select.
+   * @param options Element handle options.
+   * @returns List of selected options.
+   */
+  selectOption(values: string | ElementHandle | SelectOptionsObject | string[] | ElementHandle[] | SelectOptionsObject[], options?: ElementHandleOptions): string[];
+
+  /**
+   * Focuses the element and selects all its text content.
+   * @param options Element handle options.
+   */
+  selectText(options?: ElementHandleOptions): void;
+
+  /**
+   * Scrolls element into view if needed, and then uses `page.tapscreen` to tap in the center of the element
+   * or at the specified position.
+   * @param options Tap options.
+   */
+  tap(options?: MouseMoveOptions): void;
+
+  /**
+   * Returns the `node.textContent`.
+   * @returns The text content of the element.
+   */
+  textContent(): string;
+
+  /**
+   * Scrolls element into view, focuses element and types text.
+   * @param text Text to type into the element.
+   * @param options Typing options.
+   */
+  type(text: string, options?: KeyboardPressOptions): void;
+
+  /**
+   * Scrolls element into view, and if it's an input element of type
+   * checkbox that is already checked, clicks on it to mark it as unchecked.
+   * @param options Click options.
+   */
+  uncheck(options?: ElementClickOptions & StrictnessOptions): void;
+
+  /**
+   * Returns when the element satisfies the `state`.
+   * @param state Wait for element to satisfy this state.
+   * @param options Wait options.
+   */
+  waitForElementState(state: InputElementState, options?: TimeoutOptions): void;
+
+  /**
+   * Returns when the child element matching `selector` satisfies the `state`.
+   * @param selector A selector to query for.
+   * @param options Wait options.
+   */
+  waitForSelector(selector: string, options?: { state?: ElementState; } & StrictnessOptions & TimeoutOptions): void;
+}

k6/experimental/browser/frame.d.ts

@@ -0,0 +1,360 @@
+import {
+  ContentLoadOptions,
+  ElementClickOptions,
+  ElementHandleOptions,
+  ElementStateFilter,
+  KeyboardModifierOptions,
+  KeyboardPressOptions,
+  LifecycleEvent,
+  MouseClickOptions,
+  MouseMoveOptions,
+  MouseMultiClickOptions,
+  NavigationOptions,
+  PageFunction,
+  PollingOptions,
+  SelectOptionsObject,
+  StrictnessOptions,
+  TimeoutOptions,
+} from ".";
+import { ElementHandle } from "./element_handle";
+import { JSHandle } from "./js_handle";
+import { Response } from "./response";
+import { Locator } from "./locator";
+import { Page } from "./page";
+
+/**
+ * Frame represents the frame within a page. A page is made up of hierarchy of frames.
+ */
+export class Frame {
+  /**
+   * Finds an element matching the specified selector within the `Frame`.
+   * @param selector A selector to query element for.
+   * @returns An `ElementHandle` pointing to the result element or `null`.
+   */
+  $(selector: string): ElementHandle | null;
+
+  /**
+   * Finds all elements matching the specified selector within the `Frame`.
+   * @param selector A selector to query element for.
+   * @returns A list of `ElementHandle`s pointing to the result elements.
+   */
+  $$(selector: string): ElementHandle[];
+
+  /**
+   * Checks the first checkbox element found that matches selector.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   */
+  check(selector: string, options?: ElementClickOptions & StrictnessOptions): void;
+
+  /**
+   * Uncheck the first found element that matches the selector.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   */
+  uncheck(selector: string, options?: ElementClickOptions & StrictnessOptions): void;
+
+  /**
+   * Clicks the element.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   * @returns A promise that resolves when the element is clicked.
+   */
+  click(selector: string, options?: MouseMultiClickOptions & StrictnessOptions): Promise<void>;
+
+  /**
+   * Double clicks the element.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   */
+  dblclick(selector: string, options?: MouseClickOptions & MouseMoveOptions & StrictnessOptions): void;
+
+  /**
+   * Fills out the first element found that matches the selector.
+   * @param selector The selector to use.
+   * @param value The value to fill.
+   * @param options The options to use.
+   */
+  fill(selector: string, value: string, options?: ElementHandleOptions & StrictnessOptions): void;
+
+  /**
+   * Focuses the first element found that matches the selector.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   */
+  focus(selector: string, options?: TimeoutOptions & StrictnessOptions): void;
+
+  /**
+   * Hovers the first element found that matches the selector.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   */
+  hover(selector: string, options?: ElementClickOptions & KeyboardModifierOptions & StrictnessOptions): void;
+
+  /**
+   * Taps the first element found that matches the selector.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   */
+  tap(selector: string, options?: ElementClickOptions & KeyboardModifierOptions & StrictnessOptions): void;
+
+  /**
+   * Press the given key for the first element found that matches the selector.
+   * @param selector The selector to use.
+   * @param key The key to press.
+   * @param options The options to use.
+   */
+  press(selector: string, key: string, options?: KeyboardPressOptions & StrictnessOptions): void;
+
+  /**
+   * Type the given text for the first element found that matches the selector.
+   * @param selector The selector to use.
+   * @param text The text to type.
+   * @param options The options to use.
+   */
+  type(selector: string, text: string, options?: KeyboardPressOptions & StrictnessOptions): void;
+
+  /**
+   * Select the given options and return the array of option values of the first element
+   * found that matches the selector.
+   * @param selector The selector to use.
+   * @param values The values to select.
+   * @returns The array of option values of the first element found.
+   */
+  selectOption(
+    selector: string,
+    values: string | ElementHandle | SelectOptionsObject | string[] | ElementHandle[] | SelectOptionsObject[],
+    options?: ElementHandleOptions & StrictnessOptions): string[];
+
+  /**
+   * Dispatches an event for the first element matching the selector.
+   * @param selector The selector to use.
+   * @param type The type of event to dispatch.
+   * @param eventInit The event initialization properties.
+   * @param options The options to use.
+   */
+  dispatchEvent(selector: string, type: string, eventInit?: object, options?: TimeoutOptions & StrictnessOptions): void;
+
+  /**
+   * Returns the value of the `pageFunction` invocation.
+   *
+   * A string can also be passed in instead of a function.
+   *
+   * @param pageFunction Function to be evaluated in the page context.
+   * @param arg Optional argument to pass to `pageFunction`.
+   */
+  evaluate<R, Arg>(pageFunction: PageFunction<Arg, R>, arg?: Arg): R;
+
+  /**
+   * Returns the value of the `pageFunction` invocation as a [JSHandle].
+   *
+   * The only difference between page.evaluate(pageFunction[, arg]) and
+   * page.evaluateHandle(pageFunction[, arg]) is that
+   * page.evaluateHandle(pageFunction[, arg])returns [JSHandle].
+   *
+   * @param pageFunction Function to be evaluated in the page context.
+   * @param arg Optional argument to pass to `pageFunction`.
+   */
+  evaluateHandle<R, Arg>(pageFunction: PageFunction<Arg, R>, arg?: Arg): JSHandle<R>;
+
+  /**
+   * Get the page that owns frame.
+   * @returns The page that owns frame.
+   */
+  page(): Page;
+
+  /**
+   * Get the parent frame.
+   * @returns The parent frame, or `null` if there is no parent frame.
+   */
+  parentFrame(): Frame|null;
+
+  /**
+   * Get a list of all child frames.
+   * @returns A list of all child frames.
+   */
+  childFrames(): Frame[];
+
+  /**
+   * Get the `ElementHandle` for this frame.
+   * @returns The `ElementHandle` for this frame.
+   */
+  frameElement(): ElementHandle;
+
+  /**
+   * Navigate the frame to the specified URL and return a HTTP response object.
+   * @param url The URL to navigate to.
+   * @param options The options to use.
+   * @returns A promise that resolves to the HTTP response object.
+   */
+  goto(url: string, options?: NavigationOptions): Promise<Response|null>;
+
+  /**
+   * Replace the entire HTML document content.
+   * @param html The HTML to use.
+   * @param options The options to use.
+   */
+  setContent(html: string, options?: ContentLoadOptions): void;
+
+  /**
+   * Get the name of the frame.
+   * @returns The name of the frame.
+   */
+  name(): string;
+
+  /**
+   * Get the title of the frame.
+   * @returns The title of the frame.
+   */
+  title(): string;
+
+  /**
+   * Get the URL of the frame.
+   * @returns The URL of the frame.
+   */
+  url(): string;
+
+  /**
+   * Get the HTML content of the frame.
+   * @returns The HTML content of the frame.
+   */
+  content(): string;
+
+  /**
+   * Get whether the frame is detached or not.
+   * @returns `true` if the frame is detached, `false` otherwise.
+   */
+  isDetached(): boolean;
+
+  /**
+   * Сreates and returns a new locator for this frame.
+   * @param selector The selector to use.
+   * @returns The new locator.
+   */
+  locator(selector: string): Locator;
+
+  /**
+   * Get the `innerHTML` attribute of the first element found that matches the selector.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   * @returns The `innerHTML` attribute of the first element found.
+   */
+  innerHTML(selector: string, options?: TimeoutOptions & StrictnessOptions): string;
+
+  /**
+   * Get the `innerText` attribute of the first element found that matches the selector.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   * @returns The `innerText` attribute of the first element found.
+   */
+  innerText(selector: string, options?: TimeoutOptions & StrictnessOptions): string;
+
+  /**
+   * Get the text content of the first element found that matches the selector.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   * @returns The text content of the first element found.
+   */
+  textContent(selector: string, options?: TimeoutOptions & StrictnessOptions): string;
+
+  /**
+   * Get the value of an attribute of the first element found that matches the selector.
+   * @param selector The selector to use.
+   * @param name The name of the attribute to get.
+   * @param options The options to use.
+   * @returns The value of the attribute.
+   */
+  getAttribute(selector: string, name: string, options?: TimeoutOptions & StrictnessOptions): string;
+
+  /**
+   * Get the input value of the first element found that matches the selector.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   * @returns The input value of the first element found.
+   */
+  inputValue(selector: string, options?: TimeoutOptions & StrictnessOptions): string;
+
+  /**
+   * Get the `checked` attribute of the first checkbox element found that matches the selector.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   * @returns `true` if the checkbox is checked, `false` otherwise.
+   */
+  isChecked(selector: string, options?: TimeoutOptions & StrictnessOptions): boolean;
+
+  /**
+   * Get whether the first element found that matches the selector is disabled or not.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   * @returns `true` if the element is disabled, `false` otherwise.
+   */
+  isDisabled(selector: string, options?: TimeoutOptions & StrictnessOptions): boolean;
+
+  /**
+   * Get whether the first element found that matches the selector is enabled or not.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   * @returns `true` if the element is enabled, `false` otherwise.
+   */
+  isEnabled(selector: string, options?: TimeoutOptions & StrictnessOptions): boolean;
+
+  /**
+   * Get whether the first element found that matches the selector is editable or not.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   * @returns `true` if the element is editable, `false` otherwise.
+   */
+  isEditable(selector: string, options?: TimeoutOptions & StrictnessOptions): boolean;
+
+  /**
+   * Get whether the first element found that matches the selector is hidden or not.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   * @returns `true` if the element is hidden, `false` otherwise.
+   */
+  isHidden(selector: string, options?: TimeoutOptions & StrictnessOptions): boolean;
+
+  /**
+   * Get whether the first element found that matches the selector is visible or not.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   * @returns `true` if the element is visible, `false` otherwise.
+   */
+  isVisible(selector: string, options?: TimeoutOptions & StrictnessOptions): boolean;
+
+  /**
+   * Wait for the given function to return a truthy value.
+   * @param predicate The function to call and wait for.
+   * @param options The options to use.
+   */
+  waitForFunction<R, Arg>(pageFunction: PageFunction<Arg, R>, options?: PollingOptions & TimeoutOptions, arg?: Arg): Promise<JSHandle<R>>;
+
+  /**
+   * Wait for the given load state to be reached.
+   * This will unblock if that lifecycle event has already been received.
+   * @param state The load state to wait for, defaults to `load`.
+   * @param options The options to use.
+   */
+  waitForLoadState(state?: LifecycleEvent, options?: TimeoutOptions): void;
+
+  /**
+   * Waits for the navigation event to happen.
+   * @param options The options to use.
+   * @returns A promise that resolves to the response of the navigation when it happens.
+   */
+  waitForNavigation(options?: ContentLoadOptions): Promise<Response|null>;
+
+  /**
+   * Wait for the given selector to match the waiting criteria.
+   * @param selector The selector to use.
+   * @param options The options to use.
+   * @returns The first element found that matches the selector.
+   */
+  waitForSelector(selector: string, options?: ElementStateFilter & TimeoutOptions & StrictnessOptions): ElementHandle;
+
+  /**
+   * Wait for the given timeout to elapse.
+   * @param timeout The timeout to wait for.
+   */
+  waitForTimeout(timeout: number): void;
+}