@types/k6 0.44.2 → 0.44.3

k6/experimental/browser/js_handle.d.ts

@@ -1,51 +1,51 @@
-import { PageFunction } from ".";
-import { ElementHandle } from "./element_handle";
+import { PageFunction } from '.';
+import { ElementHandle } from './element_handle';
 
 /**
  * JSHandle represents an in-page JavaScript object.
  */
 export class JSHandle<T = any> {
-  /**
-   * Returns either `null` or the object handle itself, if the object handle is
-   * an instance of `ElementHandle`.
-   * @returns The ElementHandle if available.
-   */
-  asElement(): ElementHandle | null;
+    /**
+     * Returns either `null` or the object handle itself, if the object handle is
+     * an instance of `ElementHandle`.
+     * @returns The ElementHandle if available.
+     */
+    asElement(): ElementHandle | null;
 
-  /**
-   * Stops referencing the element handle.
-   */
-  dispose(): void;
+    /**
+     * Stops referencing the element handle.
+     */
+    dispose(): void;
 
-  /**
-   * Evaluates the page function and returns its return value.
-   * This method passes this handle as the first argument to the page function.
-   * @param pageFunction The function to be evaluated.
-   * @param args The arguments to pass to the page function.
-   * @returns The return value of `pageFunction`.
-   */
-  evaluate<R, Arg>(pageFunction: PageFunction<R, Arg>, ...args: any): any;
+    /**
+     * Evaluates the page function and returns its return value.
+     * This method passes this handle as the first argument to the page function.
+     * @param pageFunction The function to be evaluated.
+     * @param args The arguments to pass to the page function.
+     * @returns The return value of `pageFunction`.
+     */
+    evaluate<R, Arg>(pageFunction: PageFunction<R, Arg>, ...args: any): any;
 
-  /**
-   * Evaluates the page function and returns a `JSHandle`.
-   * This method passes this handle as the first argument to the page function.
-   * Unlike `evaluate`, `evaluateHandle` returns the value as a `JSHandle`
-   * @param pageFunction The function to be evaluated.
-   * @param args The arguments to pass to the page function.
-   * @returns A JSHandle of the return value of `pageFunction`.
-   */
-  evaluateHandle<R, Arg>(pageFunction: PageFunction<R, Arg>, ...args: any): JSHandle<R>;
+    /**
+     * Evaluates the page function and returns a `JSHandle`.
+     * This method passes this handle as the first argument to the page function.
+     * Unlike `evaluate`, `evaluateHandle` returns the value as a `JSHandle`
+     * @param pageFunction The function to be evaluated.
+     * @param args The arguments to pass to the page function.
+     * @returns A JSHandle of the return value of `pageFunction`.
+     */
+    evaluateHandle<R, Arg>(pageFunction: PageFunction<R, Arg>, ...args: any): JSHandle<R>;
 
-  /**
-   * Fethes a map with own property names of of the `JSHandle` with their values as
-   * `JSHandle` instances.
-   * @returns A map with property names as keys and `JSHandle` instances for the property values.
-   */
-  getProperties(): Map<string, JSHandle>;
+    /**
+     * Fethes a map with own property names of of the `JSHandle` with their values as
+     * `JSHandle` instances.
+     * @returns A map with property names as keys and `JSHandle` instances for the property values.
+     */
+    getProperties(): Map<string, JSHandle>;
 
-  /**
-   * Fetches a JSON representation of the object.
-   * @returns A JSON representation of the object.
-   */
-  jsonValue(): any;
+    /**
+     * Fetches a JSON representation of the object.
+     * @returns A JSON representation of the object.
+     */
+    jsonValue(): any;
 }

k6/experimental/browser/keyboard.d.ts

@@ -2,42 +2,42 @@
  * Keyboard provides an API for managing a virtual keyboard.
  */
 export class Keyboard {
-  /**
-   * Sends a key down message to a session target.
-   * A superset of the key values can be found [here](https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values).
-   * @param key Name of key to press, such as `ArrowLeft`.
-   */
-  down(key: string): void;
+    /**
+     * Sends a key down message to a session target.
+     * A superset of the key values can be found [here](https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values).
+     * @param key Name of key to press, such as `ArrowLeft`.
+     */
+    down(key: string): void;
 
-  /**
-   * Dispatches an `input` event with the given `text`.
-   * This method does not emit `keyDown`, `keyUp` or `keyPress` events.
-   * @param text Event text.
-   */
-  insertText(text: string): void;
+    /**
+     * Dispatches an `input` event with the given `text`.
+     * This method does not emit `keyDown`, `keyUp` or `keyPress` events.
+     * @param text Event text.
+     */
+    insertText(text: string): void;
 
-  /**
-   * Sends a key press message to a session target.
-   * A press message consists of successive key down and up messages.
-   * @param key Sequence of keys to press.
-   * @param options Specifies the typing options.
-   */
-  press(key: string, options?: { delay?: number }): void;
+    /**
+     * Sends a key press message to a session target.
+     * A press message consists of successive key down and up messages.
+     * @param key Sequence of keys to press.
+     * @param options Specifies the typing options.
+     */
+    press(key: string, options?: { delay?: number }): void;
 
-  /**
-   * Type sends a `press` message to a session target for each character in text.
-   * It sends an insertText message if a character is not among
-   * valid characters in the keyboard's layout.
-   * Modifier keys `Shift`, `Control`, `Alt`, `Meta` are _not_ respected.
-   * @param text A text to type into a focused element.
-   * @param options Specifies the typing options.
-   */
-  type(text: string, options?: { delay?: number }): void;
+    /**
+     * Type sends a `press` message to a session target for each character in text.
+     * It sends an insertText message if a character is not among
+     * valid characters in the keyboard's layout.
+     * Modifier keys `Shift`, `Control`, `Alt`, `Meta` are _not_ respected.
+     * @param text A text to type into a focused element.
+     * @param options Specifies the typing options.
+     */
+    type(text: string, options?: { delay?: number }): void;
 
-  /**
-   * Sends a key up message to a session target.
-   * A superset of the key values can be found [here](https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values).
-   * @param key Name of key to release, such as `ArrowLeft`.
-   */
-  up(key: string): void;
+    /**
+     * Sends a key up message to a session target.
+     * A superset of the key values can be found [here](https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values).
+     * @param key Name of key to release, such as `ArrowLeft`.
+     */
+    up(key: string): void;
 }

k6/experimental/browser/locator.d.ts

@@ -10,7 +10,7 @@ import {
     ElementState,
     MouseMultiClickOptions,
     StrictnessOptions,
-} from "./";
+} from './';
 
 /**
  * The Locator API makes it easier to work with dynamically changing elements.
@@ -23,169 +23,172 @@ import {
  * React, Vue, etc.
  */
 export class Locator {
-  /**
-   * Mouse click on the chosen element.
-   * @param options Options to use.
-   * @returns Promise which resolves when the element is successfully clicked.
-   */
-  click(options?: MouseMoveOptions & MouseMultiClickOptions & StrictnessOptions): Promise<void>;
-
-  /**
-   * Mouse double click on the chosen element.
-   * @param options Options to use.
-   */
-  dblclick(options?: MouseMoveOptions & MouseMultiClickOptions & StrictnessOptions): void;
-
-  /**
-   * Use this method to select an `input type="checkbox"`.
-   * @param options Options to use.
-   */
-  check(options?: ElementClickOptions & StrictnessOptions): void;
-
-  /**
-   * Use this method to unselect an `input type="checkbox"`.
-   * @param options Options to use.
-   */
-  uncheck(options?: ElementClickOptions & StrictnessOptions): void;
-
-  /**
-   * Checks to see if the `input type="checkbox"` is selected or not.
-   * @param options Options to use.
-   * @returns `true` if the element is checked, `false` otherwise.
-   */
-  isChecked(options?: TimeoutOptions & StrictnessOptions): boolean;
-
-  /**
-   * Checks if the element is editable.
-   * @param options Options to use.
-   * @returns `true` if the element is editable, `false` otherwise.
-   */
-  isEditable(options?: TimeoutOptions): boolean;
-
-  /**
-   * Checks if the element is `enabled`.
-   * @param options Options to use.
-   * @returns `true` if the element is enabled, `false` otherwise.
-   */
-  isEnabled(options?: TimeoutOptions & StrictnessOptions): boolean;
-
-  /**
-   * Checks if the element is `disabled`.
-   * @param options Options to use.
-   * @returns `true` if the element is disabled, `false` otherwise.
-   */
-  isDisabled(options?: TimeoutOptions & StrictnessOptions): boolean;
-
-  /**
-   * Checks if the element is `visible`.
-   * @param options Options to use.
-   * @returns `true` if the element is visible, `false` otherwise.
-   */
-  isVisible(options?: TimeoutOptions & StrictnessOptions): boolean;
-
-  /**
-   * Checks if the element is `hidden`.
-   * @param options Options to use.
-   * @returns `true` if the element is hidden, `false` otherwise.
-   */
-  isHidden(options?: TimeoutOptions & StrictnessOptions): boolean;
-
-  /**
-   * Fill an `input`, `textarea` or `contenteditable` element with the provided value.
-   * @param value Value to fill for the `input` or `textarea` element.
-   * @param options Options to use.
-   */
-  fill(value: string, options?: ElementHandleOptions & StrictnessOptions): void;
-
-  /**
-   * Focuses the element using locator's selector.
-   * @param options Options to use.
-   */
-  focus(options?: TimeoutOptions & StrictnessOptions): void;
-
-  /**
-   * Returns the element attribute value for the given attribute name.
-   * @param name Attribute name to retrieve value for.
-   * @param options Options to use.
-   * @returns Attribute value.
-   */
-  getAttribute(name: string, options?: TimeoutOptions & StrictnessOptions): string|null;
-
-  /**
-   * Returns the `element.innerHTML`.
-   * @param options Options to use.
-   * @returns Element's innerHTML.
-   */
-  innerHTML(options?: TimeoutOptions & StrictnessOptions): string;
-
-  /**
-   * Returns the `element.innerText`.
-   * @param options Options to use.
-   * @returns Element's innerText.
-   */
-  innerText(options?: TimeoutOptions & StrictnessOptions): string;
-
-  /**
-   * Returns the `element.textContent`.
-   * @param options Options to use.
-   * @returns Element's textContent.
-   */
-  textContent(options?: TimeoutOptions & StrictnessOptions): string;
-
-  /**
-   * Returns `input.value` for the selected `input`, `textarea` or `select` element.
-   * @param options Options to use.
-   * @returns The input value of the element.
-   */
-  inputValue(options?: TimeoutOptions & StrictnessOptions): string;
-
-  /**
-   * Select one or more options which match the values. If the select has the multiple attribute, all matching options are selected,
-   * otherwise only the first option matching one of the passed options is selected.
-   * @param values Values of options to select.
-   * @param options Options to use.
-   * @returns List of selected options.
-   */
-  selectOption(values: string|string[]|{ value?: string; label?: string; index?: number }, options?: ElementHandleOptions & StrictnessOptions): string[];
-
-  /**
-   * Press a single key on the keyboard or a combination of keys.
-   * A superset of the key values can be found [here](https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values).
-   * @param key Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
-   * @param options Keyboard press options.
-   */
-  press(key: string, options?: KeyboardPressOptions): void;
-
-  /**
-   * Type a text into the input field.
-   * @param text Text to type into the input field.
-   * @param options Typing options.
-   */
-  type(text: string, options?: KeyboardPressOptions): void;
-
-  /**
-   * Hover over the element.
-   * @param options Options to use.
-   */
-  hover(options?: MouseMoveOptions & StrictnessOptions): void;
-
-  /**
-   * Tap on the chosen element.
-   * @param options Options to use.
-   */
-  tap(options?: MouseMoveOptions & StrictnessOptions): void;
-
-  /**
-   * Dispatches HTML DOM event types e.g. `click`.
-   * @param type DOM event type.
-   * @param eventInit Event-specific properties.
-   * @param options Options to use.
-   */
-  dispatchEvent(type: string, eventInit?: EvaluationArgument, options?: TimeoutOptions & StrictnessOptions): void;
-
-  /**
-   * Wait for the element to be in a particular state e.g. `visible`.
-   * @param options Wait options.
-   */
-  waitFor(options?: { state?: ElementState } & TimeoutOptions & StrictnessOptions): void;
+    /**
+     * Mouse click on the chosen element.
+     * @param options Options to use.
+     * @returns Promise which resolves when the element is successfully clicked.
+     */
+    click(options?: MouseMoveOptions & MouseMultiClickOptions & StrictnessOptions): Promise<void>;
+
+    /**
+     * Mouse double click on the chosen element.
+     * @param options Options to use.
+     */
+    dblclick(options?: MouseMoveOptions & MouseMultiClickOptions & StrictnessOptions): void;
+
+    /**
+     * Use this method to select an `input type="checkbox"`.
+     * @param options Options to use.
+     */
+    check(options?: ElementClickOptions & StrictnessOptions): void;
+
+    /**
+     * Use this method to unselect an `input type="checkbox"`.
+     * @param options Options to use.
+     */
+    uncheck(options?: ElementClickOptions & StrictnessOptions): void;
+
+    /**
+     * Checks to see if the `input type="checkbox"` is selected or not.
+     * @param options Options to use.
+     * @returns `true` if the element is checked, `false` otherwise.
+     */
+    isChecked(options?: TimeoutOptions & StrictnessOptions): boolean;
+
+    /**
+     * Checks if the element is editable.
+     * @param options Options to use.
+     * @returns `true` if the element is editable, `false` otherwise.
+     */
+    isEditable(options?: TimeoutOptions): boolean;
+
+    /**
+     * Checks if the element is `enabled`.
+     * @param options Options to use.
+     * @returns `true` if the element is enabled, `false` otherwise.
+     */
+    isEnabled(options?: TimeoutOptions & StrictnessOptions): boolean;
+
+    /**
+     * Checks if the element is `disabled`.
+     * @param options Options to use.
+     * @returns `true` if the element is disabled, `false` otherwise.
+     */
+    isDisabled(options?: TimeoutOptions & StrictnessOptions): boolean;
+
+    /**
+     * Checks if the element is `visible`.
+     * @param options Options to use.
+     * @returns `true` if the element is visible, `false` otherwise.
+     */
+    isVisible(options?: TimeoutOptions & StrictnessOptions): boolean;
+
+    /**
+     * Checks if the element is `hidden`.
+     * @param options Options to use.
+     * @returns `true` if the element is hidden, `false` otherwise.
+     */
+    isHidden(options?: TimeoutOptions & StrictnessOptions): boolean;
+
+    /**
+     * Fill an `input`, `textarea` or `contenteditable` element with the provided value.
+     * @param value Value to fill for the `input` or `textarea` element.
+     * @param options Options to use.
+     */
+    fill(value: string, options?: ElementHandleOptions & StrictnessOptions): void;
+
+    /**
+     * Focuses the element using locator's selector.
+     * @param options Options to use.
+     */
+    focus(options?: TimeoutOptions & StrictnessOptions): void;
+
+    /**
+     * Returns the element attribute value for the given attribute name.
+     * @param name Attribute name to retrieve value for.
+     * @param options Options to use.
+     * @returns Attribute value.
+     */
+    getAttribute(name: string, options?: TimeoutOptions & StrictnessOptions): string | null;
+
+    /**
+     * Returns the `element.innerHTML`.
+     * @param options Options to use.
+     * @returns Element's innerHTML.
+     */
+    innerHTML(options?: TimeoutOptions & StrictnessOptions): string;
+
+    /**
+     * Returns the `element.innerText`.
+     * @param options Options to use.
+     * @returns Element's innerText.
+     */
+    innerText(options?: TimeoutOptions & StrictnessOptions): string;
+
+    /**
+     * Returns the `element.textContent`.
+     * @param options Options to use.
+     * @returns Element's textContent.
+     */
+    textContent(options?: TimeoutOptions & StrictnessOptions): string;
+
+    /**
+     * Returns `input.value` for the selected `input`, `textarea` or `select` element.
+     * @param options Options to use.
+     * @returns The input value of the element.
+     */
+    inputValue(options?: TimeoutOptions & StrictnessOptions): string;
+
+    /**
+     * Select one or more options which match the values. If the select has the multiple attribute, all matching options are selected,
+     * otherwise only the first option matching one of the passed options is selected.
+     * @param values Values of options to select.
+     * @param options Options to use.
+     * @returns List of selected options.
+     */
+    selectOption(
+        values: string | string[] | { value?: string; label?: string; index?: number },
+        options?: ElementHandleOptions & StrictnessOptions,
+    ): string[];
+
+    /**
+     * Press a single key on the keyboard or a combination of keys.
+     * A superset of the key values can be found [here](https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values).
+     * @param key Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
+     * @param options Keyboard press options.
+     */
+    press(key: string, options?: KeyboardPressOptions): void;
+
+    /**
+     * Type a text into the input field.
+     * @param text Text to type into the input field.
+     * @param options Typing options.
+     */
+    type(text: string, options?: KeyboardPressOptions): void;
+
+    /**
+     * Hover over the element.
+     * @param options Options to use.
+     */
+    hover(options?: MouseMoveOptions & StrictnessOptions): void;
+
+    /**
+     * Tap on the chosen element.
+     * @param options Options to use.
+     */
+    tap(options?: MouseMoveOptions & StrictnessOptions): void;
+
+    /**
+     * Dispatches HTML DOM event types e.g. `click`.
+     * @param type DOM event type.
+     * @param eventInit Event-specific properties.
+     * @param options Options to use.
+     */
+    dispatchEvent(type: string, eventInit?: EvaluationArgument, options?: TimeoutOptions & StrictnessOptions): void;
+
+    /**
+     * Wait for the element to be in a particular state e.g. `visible`.
+     * @param options Wait options.
+     */
+    waitFor(options?: { state?: ElementState } & TimeoutOptions & StrictnessOptions): void;
 }

k6/experimental/browser/mouse.d.ts

@@ -1,43 +1,43 @@
-import { MouseClickOptions, MouseDownUpOptions, MouseMultiClickOptions } from "./";
+import { MouseClickOptions, MouseDownUpOptions, MouseMultiClickOptions } from './';
 
 /**
  * Mouse provides an API for managing a virtual mouse.
  */
 export class Mouse {
-  /**
-   * Shortcut for `mouse.move(x, y)`, `mouse.down()`, `mouse.up()`.
-   * @param x The x position.
-   * @param y The y position.
-   * @param options The click options.
-   */
-  click(x: number, y: number, options?: MouseMultiClickOptions): void;
+    /**
+     * Shortcut for `mouse.move(x, y)`, `mouse.down()`, `mouse.up()`.
+     * @param x The x position.
+     * @param y The y position.
+     * @param options The click options.
+     */
+    click(x: number, y: number, options?: MouseMultiClickOptions): void;
 
-  /**
-   * Shortcut for `mouse.move(x, y)`, `mouse.down()`, `mouse.up()`, `mouse.down()`,
-   * `mouse.up()`.
-   * @param x The x position.
-   * @param y The y position.
-   * @param options The click options.
-   */
-  dblclick(x: number, y: number, options?: MouseClickOptions): void;
+    /**
+     * Shortcut for `mouse.move(x, y)`, `mouse.down()`, `mouse.up()`, `mouse.down()`,
+     * `mouse.up()`.
+     * @param x The x position.
+     * @param y The y position.
+     * @param options The click options.
+     */
+    dblclick(x: number, y: number, options?: MouseClickOptions): void;
 
-  /**
-   * Dispatches a `mousedown` event.
-   * @param options The mouse down options.
-   */
-  down(options?: MouseDownUpOptions): void;
+    /**
+     * Dispatches a `mousedown` event.
+     * @param options The mouse down options.
+     */
+    down(options?: MouseDownUpOptions): void;
 
-  /**
-   * Dispatches a `mousemove` event.
-   * @param x The x position.
-   * @param y The y position.
-   * @param options The mouse move options.
-   */
-  move(x: number, y: number, options?: { steps?: number }): void;
+    /**
+     * Dispatches a `mousemove` event.
+     * @param x The x position.
+     * @param y The y position.
+     * @param options The mouse move options.
+     */
+    move(x: number, y: number, options?: { steps?: number }): void;
 
-  /**
-   * Dispatches a `mouseup` event.
-   * @param options The mouse up options.
-   */
-  up(options?: MouseDownUpOptions): void;
+    /**
+     * Dispatches a `mouseup` event.
+     * @param options The mouse up options.
+     */
+    up(options?: MouseDownUpOptions): void;
 }