@types/k6 0.44.1 → 0.44.3

k6/README.md

@@ -8,7 +8,7 @@ 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: Fri, 28 Apr 2023 16:02:49 GMT
+ * Last updated: Fri, 16 Jun 2023 07:32:49 GMT
  * Dependencies: none
  * Global values: none
 

k6/crypto.d.ts

@@ -26,7 +26,7 @@ export function hmac<OE extends OutputEncoding>(
     algorithm: Algorithm,
     secret: string | ArrayBuffer,
     input: string | ArrayBuffer,
-    outputEncoding: OE
+    outputEncoding: OE,
 ): Output<OE>;
 
 /**
@@ -38,10 +38,7 @@ export function hmac<OE extends OutputEncoding>(
  * @example
  * crypto.md4('hello world!', 'hex')
  */
-export function md4<OE extends OutputEncoding>(
-    input: string | ArrayBuffer,
-    outputEncoding: OE
-): Output<OE>;
+export function md4<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
 /**
  * Hash with MD5.
@@ -52,10 +49,7 @@ export function md4<OE extends OutputEncoding>(
  * @example
  * crypto.md5("hello world!", "hex")
  */
-export function md5<OE extends OutputEncoding>(
-    input: string | ArrayBuffer,
-    outputEncoding: OE
-): Output<OE>;
+export function md5<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
 /**
  * Hash with SHA-1.
@@ -66,10 +60,7 @@ export function md5<OE extends OutputEncoding>(
  * @example
  * crypto.sha1('hello world!', 'hex')
  */
-export function sha1<OE extends OutputEncoding>(
-    input: string | ArrayBuffer,
-    outputEncoding: OE
-): Output<OE>;
+export function sha1<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
 /**
  * Hash with SHA-256.
@@ -80,10 +71,7 @@ export function sha1<OE extends OutputEncoding>(
  * @example
  * crypto.sha256('hello world!', 'hex')
  */
-export function sha256<OE extends OutputEncoding>(
-    input: string | ArrayBuffer,
-    outputEncoding: OE
-): Output<OE>;
+export function sha256<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
 /**
  * Hash with SHA-384.
@@ -94,10 +82,7 @@ export function sha256<OE extends OutputEncoding>(
  * @example
  * crypto.sha384('hello world!', 'hex')
  */
-export function sha384<OE extends OutputEncoding>(
-    input: string | ArrayBuffer,
-    outputEncoding: OE
-): Output<OE>;
+export function sha384<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
 /**
  * Hash with SHA-512.
@@ -108,10 +93,7 @@ export function sha384<OE extends OutputEncoding>(
  * @example
  * crypto.sha512('hello world!', 'hex')
  */
-export function sha512<OE extends OutputEncoding>(
-    input: string | ArrayBuffer,
-    outputEncoding: OE
-): Output<OE>;
+export function sha512<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
 /**
  * Hash with SHA-512/224.
@@ -122,10 +104,7 @@ export function sha512<OE extends OutputEncoding>(
  * @example
  * crypto.sha512_224('hello world!', 'hex')
  */
-export function sha512_224<OE extends OutputEncoding>(
-    input: string | ArrayBuffer,
-    outputEncoding: OE
-): Output<OE>;
+export function sha512_224<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
 /**
  * Hash with SHA-512/256.
@@ -136,10 +115,7 @@ export function sha512_224<OE extends OutputEncoding>(
  * @example
  * crypto.sha512_256('hello world!', 'hex')
  */
-export function sha512_256<OE extends OutputEncoding>(
-    input: string | ArrayBuffer,
-    outputEncoding: OE
-): Output<OE>;
+export function sha512_256<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
 /**
  * Hash with RIPEMD-160.
@@ -150,10 +126,7 @@ export function sha512_256<OE extends OutputEncoding>(
  * @example
  * crypto.ripemd160('hello world!', 'hex')
  */
-export function ripemd160<OE extends OutputEncoding>(
-    input: string | ArrayBuffer,
-    outputEncoding: OE
-): Output<OE>;
+export function ripemd160<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
 /**
  * Create a hashing object.
@@ -277,7 +250,7 @@ declare namespace crypto {
         algorithm: Algorithm,
         secret: string | ArrayBuffer,
         input: string | ArrayBuffer,
-        outputEncoding: OE
+        outputEncoding: OE,
     ): Output<OE>;
 
     /**
@@ -289,10 +262,7 @@ declare namespace crypto {
      * @example
      * crypto.md4('hello world!', 'hex')
      */
-    function md4<OE extends OutputEncoding>(
-        input: string | ArrayBuffer,
-        outputEncoding: OE
-    ): Output<OE>;
+    function md4<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
     /**
      * Hash with MD5.
@@ -303,10 +273,7 @@ declare namespace crypto {
      * @example
      * crypto.md5("hello world!", "hex")
      */
-    function md5<OE extends OutputEncoding>(
-        input: string | ArrayBuffer,
-        outputEncoding: OE
-    ): Output<OE>;
+    function md5<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
     /**
      * Hash with SHA-1.
@@ -317,10 +284,7 @@ declare namespace crypto {
      * @example
      * crypto.sha1('hello world!', 'hex')
      */
-    function sha1<OE extends OutputEncoding>(
-        input: string | ArrayBuffer,
-        outputEncoding: OE
-    ): Output<OE>;
+    function sha1<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
     /**
      * Hash with SHA-256.
@@ -331,10 +295,7 @@ declare namespace crypto {
      * @example
      * crypto.sha256('hello world!', 'hex')
      */
-    function sha256<OE extends OutputEncoding>(
-        input: string | ArrayBuffer,
-        outputEncoding: OE
-    ): Output<OE>;
+    function sha256<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
     /**
      * Hash with SHA-384.
@@ -345,10 +306,7 @@ declare namespace crypto {
      * @example
      * crypto.sha384('hello world!', 'hex')
      */
-    function sha384<OE extends OutputEncoding>(
-        input: string | ArrayBuffer,
-        outputEncoding: OE
-    ): Output<OE>;
+    function sha384<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
     /**
      * Hash with SHA-512.
@@ -359,10 +317,7 @@ declare namespace crypto {
      * @example
      * crypto.sha512('hello world!', 'hex')
      */
-    function sha512<OE extends OutputEncoding>(
-        input: string | ArrayBuffer,
-        outputEncoding: OE
-    ): Output<OE>;
+    function sha512<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
     /**
      * Hash with SHA-512/224.
@@ -373,10 +328,7 @@ declare namespace crypto {
      * @example
      * crypto.sha512_224('hello world!', 'hex')
      */
-    function sha512_224<OE extends OutputEncoding>(
-        input: string | ArrayBuffer,
-        outputEncoding: OE
-    ): Output<OE>;
+    function sha512_224<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
     /**
      * Hash with SHA-512/256.
@@ -387,10 +339,7 @@ declare namespace crypto {
      * @example
      * crypto.sha512_256('hello world!', 'hex')
      */
-    function sha512_256<OE extends OutputEncoding>(
-        input: string | ArrayBuffer,
-        outputEncoding: OE
-    ): Output<OE>;
+    function sha512_256<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
     /**
      * Hash with RIPEMD-160.
@@ -401,10 +350,7 @@ declare namespace crypto {
      * @example
      * crypto.ripemd160('hello world!', 'hex')
      */
-    function ripemd160<OE extends OutputEncoding>(
-        input: string | ArrayBuffer,
-        outputEncoding: OE
-    ): Output<OE>;
+    function ripemd160<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
 
     /**
      * Create a hashing object.

k6/data.d.ts

@@ -7,10 +7,10 @@ export const SharedArray: {
      * Given a name and a function that returns an array, the SharedArray constructor returns the same array but sharing the array memory between VUs.
      * https://k6.io/docs/javascript-api/k6-data/sharedarray/
      */
-    new(name: string, callback: () => []): [];
+    new (name: string, callback: () => []): [];
     /**
      * Given a name and a function that returns an array, the SharedArray constructor returns the same array but sharing the array memory between VUs.
      * https://k6.io/docs/javascript-api/k6-data/sharedarray/
      */
-    new<T>(name: string, callback: () => T[]): T[];
+    new <T>(name: string, callback: () => T[]): T[];
 };

k6/encoding.d.ts

@@ -24,7 +24,7 @@ export function b64decode(input: string, encoding?: Base64Variant): ArrayBuffer;
  * encoding.b64decode(str, 'rawstd')
  * const decodedString = encoding.b64decode(str, 'rawurl', 's')
  */
- export function b64decode(input: string, encoding: Base64Variant, format: 's'): string;
+export function b64decode(input: string, encoding: Base64Variant, format: 's'): string;
 
 /**
  * Base64 encode a string.

k6/experimental/browser/element_handle.d.ts

@@ -0,0 +1,213 @@
+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;
+}