@types/k6 0.53.2 → 0.54.1

k6/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for k6 (https://grafana.com/docs/k6/lates
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6.
 
 ### Additional Details
- * Last updated: Tue, 17 Sep 2024 08:09:49 GMT
+ * Last updated: Wed, 02 Oct 2024 08:39:47 GMT
  * Dependencies: none
 
 # Credits

k6/browser/index.d.ts

@@ -163,6 +163,8 @@ export type ElementClickOptions = ElementHandlePointerOptions & {
     position?: { x: number; y: number };
 };
 
+export type FrameCheckOptions = ElementClickOptions;
+
 export interface KeyboardModifierOptions {
     /**
      * `Alt`, `Control`, `Meta` or `Shift` modifiers keys pressed during the action.
@@ -391,19 +393,17 @@ export interface ScreenshotOptions {
  * - `mutation` - use a mutation observer
  * - `interval` - use a polling interval
  */
-export type PollingMethod = "raf" | "mutation" | "interval";
+export type PollingMethod = number | "raf" | "mutation";
 
 export interface PollingOptions {
     /**
-     * Polling method to use.
-     * @default 'raf'
-     */
-    polling?: "raf" | "mutation" | "interval";
-
-    /**
-     * Polling interval in milliseconds if `polling` is set to `interval`.
+     * If `polling` is `'raf'`, then `pageFunction` is constantly executed in
+     * `requestAnimationFrame` callback. If the `polling` is `'mutation'` it
+     * will be called when a change is made to the DOM tree. If `polling` is
+     * a number, then it is treated as an interval in milliseconds at which
+     * the function would be executed. Defaults to `raf`.
      */
-    interval?: number;
+    polling?: PollingMethod;
 }
 
 export interface ElementStateFilter {
@@ -1333,6 +1333,14 @@ export interface ElementHandle extends JSHandle {
      */
     selectText(options?: ElementHandleOptions): Promise<void>;
 
+    /**
+     * Checks or unchecks the input checkbox element.
+     * @param checked Whether to check or uncheck the element.
+     * @param options Options to customize the check action.
+     * @returns A promise that resolves when the element is checked or unchecked.
+     */
+    setChecked(checked: boolean, options?: ElementClickOptions & StrictnessOptions): Promise<void>;
+
     /**
      * Sets the file input element's value to the specified files.
      *
@@ -1578,6 +1586,15 @@ export interface Frame {
      */
     goto(url: string, options?: NavigationOptions): Promise<Response | null>;
 
+    /**
+     * Checks or unchecks the input checkbox element.
+     * @param selector A selector to search for an element.
+     * @param checked Whether to check or uncheck the element.
+     * @param options Options to customize the check action.
+     * @returns A promise that resolves when the element is checked or unchecked.
+     */
+    setChecked(selector: string, checked: boolean, options?: FrameCheckOptions & StrictnessOptions): Promise<void>;
+
     /**
      * Replace the entire HTML document content.
      * @param html The HTML to use.
@@ -2029,6 +2046,14 @@ export interface Locator {
         options?: ElementHandleOptions,
     ): Promise<string[]>;
 
+    /**
+     * Checks or unchecks the input checkbox element.
+     * @param checked Whether to check or uncheck the element.
+     * @param options Options to customize the check action.
+     * @returns A promise that resolves when the element is checked or unchecked.
+     */
+    setChecked(checked: boolean, options?: FrameCheckOptions): Promise<void>;
+
     /**
      * 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).
@@ -3066,6 +3091,15 @@ export interface Page {
         } & ScreenshotOptions,
     ): Promise<ArrayBuffer>;
 
+    /**
+     * Checks or unchecks the input checkbox element.
+     * @param selector A selector to search for an element.
+     * @param checked Whether to check or uncheck the element.
+     * @param options Options to customize the check action.
+     * @returns A promise that resolves when the element is checked or unchecked.
+     */
+    setChecked(selector: string, checked: boolean, options?: FrameCheckOptions & StrictnessOptions): Promise<void>;
+
     /**
      * **NOTE** Use locator-based locator.selectOption(values[, options]) instead.
      *
@@ -3359,7 +3393,7 @@ export interface Page {
      * **Usage**
      *
      * ```js
-     * import { browser, networkProfiles } from 'k6/experimental/browser';
+     * import { browser, networkProfiles } from 'k6/browser';
      * ... // redacted
      *   const context = browser.newContext();
      *   const page = context.newPage();
@@ -3516,11 +3550,12 @@ export interface Page {
         options?: {
             /**
              * If `polling` is `'raf'`, then `pageFunction` is constantly executed in
-             * `requestAnimationFrame` callback. If `polling` is a number, then it is
-             * treated as an interval in milliseconds at which the function would be
-             * executed. Defaults to `raf`.
+             * `requestAnimationFrame` callback. If the `polling` is `'mutation'` it
+             * will be called when a change is made to the DOM tree. If `polling` is
+             * a number, then it is treated as an interval in milliseconds at which
+             * the function would be executed. Defaults to `raf`.
              */
-            polling?: number | "raf";
+            polling?: PollingMethod;
 
             /**
              * Maximum time in milliseconds. Defaults to `30` seconds. Default is

k6/experimental/browser/index.d.ts

@@ -4192,7 +4192,7 @@ export interface Page {
      * **Usage**
      *
      * ```js
-     * import { browser, networkProfiles } from 'k6/experimental/browser';
+     * import { browser, networkProfiles } from 'k6/browser';
      * ... // redacted
      *   const context = browser.newContext();
      *   const page = context.newPage();

k6/experimental/csv/index.d.ts

@@ -0,0 +1,80 @@
+/**
+ * The `k6-experimental/csv` module provides efficient ways to handle CSV files in k6, offering faster parsing and lower memory
+ * usage compared to traditional JavaScript-based libraries.
+ *
+ * This module includes functionalities for both full-file parsing and streaming, allowing users to choose between
+ * performance and memory optimization.
+ */
+
+import type { SharedArray } from "k6/data";
+import * as fs from "k6/experimental/fs";
+
+/**
+ * The parse function parses an entire CSV file at once and returns a promise
+ * that resolves to a `SharedArray` instance.
+ *
+ * This function uses Go-based processing, which results in faster parsing and
+ * lower memory usage compared to JavaScript alternatives.
+ *
+ * It's ideal for scenarios where performance is a priority, and the entire CSV
+ * file can be loaded into memory.
+ *
+ * @param {fs.File} file - The file path as a `fs.File` instance. Relative paths are resolved relative to the k6 script.
+ * @param {Partial<Options>} [options] - An optional configuration object for the parsing operation.
+ */
+export function parse(file: fs.File, options?: Partial<Options>): Promise<typeof SharedArray>;
+
+/**
+ * The `csv.Parser` class provides a streaming parser that reads CSV files
+ * line-by-line, offering fine-grained control over the parsing process and
+ * minimizing memory consumption.
+ *
+ * It's well-suited for scenarios where memory efficiency is crucial or when
+ * you need to process large CSV files without loading the entire file into memory.
+ */
+export class Parser {
+    /**
+     * Constructs a new Parser instance.
+     *
+     * @param {fs.File} file - A csv file to parse, provided as a `fs.File` instance.
+     * @param {Partial<Options>} [options] - An optional configuration object for the parser.
+     */
+    constructor(file: fs.File, options?: Partial<Options>);
+
+    /**
+     * Parses the next record from the CSV file.
+     *
+     * @returns {Promise<{done: boolean, value: string[]}>} - A promise that
+     * resolves to an object with the `done` property set to `true` if the end of the file
+     * is reached, and the `value` property set to an array of strings representing the record.
+     */
+    next(): Promise<{ done: boolean; value: string[] }>;
+}
+
+/**
+ * The Options object describes the configuration available for the operation of parsing CSV
+ * files using the `parse` function and the `Parser` class.
+ */
+export interface Options {
+    /**
+     * The delimiter character used in the CSV file. Default is ','.
+     */
+    delimiter: string;
+
+    /**
+     * Whether to skip the first line of the CSV file. Default is false.
+     */
+    skipFirstLine: boolean;
+
+    /**
+     * The line number the parsing should start from. Default is 0.
+     */
+    fromLine: number;
+
+    /**
+     * The line number the parsing should stop at. Default is undefined.
+     */
+    toLine?: number;
+}
+
+export * as default from "k6/experimental/csv";

k6/experimental/websockets/index.d.ts

@@ -37,8 +37,9 @@ export class WebSocket {
 
     /**
      * The type of binary data being transmitted over the connection.
+     * @default "blob"
      */
-    readonly binaryType: BinaryType;
+    binaryType: BinaryType;
 
     /**
      * The Websocket constructor returns a newly created WebSocket object.
@@ -56,7 +57,7 @@ export class WebSocket {
      *
      * @param data - the data to send to the server
      */
-    send(data: string | ArrayBuffer | Blob): void;
+    send(data: string | ArrayBuffer | Blob | ArrayBufferView): void;
 
     /**
      * Bind event names to event handlers to be executed when their

k6/net/grpc/index.d.ts

@@ -78,15 +78,24 @@ export interface TLSParams {
 
 export interface Params {
     /**
-     * @deprecated Use metadata instead.
+     * Object with key-value pairs representing custom metadata the user would like to add to the request.
      */
-    headers?: object;
-
     metadata?: object;
 
+    /**
+     * Key-value pairs where the keys are names of tags and the values are tag values
+     */
     tags?: object;
 
+    /**
+     * Request timeout to use.
+     */
     timeout?: string | number;
+
+    /**
+     * Specify if response messages should be discarded.
+     */
+    discardResponseMessage?: boolean;
 }
 
 export interface GrpcError {
@@ -141,6 +150,16 @@ export type StreamEvent =
      */
     | "end";
 
+/**
+ * StreamMessageMetadata handles gRPC stream messages's metadata
+ */
+export interface StreamMessageMetadata {
+    /**
+     * Contains the timestamp of the original event (for example, when a message has been received).
+     */
+    ts: number;
+}
+
 /**
  * Stream allows you to use streaming RPCs.
  */
@@ -160,7 +179,10 @@ export class Stream {
      * @param event - the event to listen for
      * @param listener - the callback to invoke when the event is emitted
      */
-    on(event: StreamEvent, listener: (data: object | GrpcError | undefined) => void): void;
+    on(
+        event: StreamEvent,
+        listener: (data: object | GrpcError | undefined, metadata: StreamMessageMetadata) => void,
+    ): void;
 
     /**
      * Writes a request to the stream.

k6/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/k6",
-    "version": "0.53.2",
+    "version": "0.54.1",
     "description": "TypeScript definitions for k6",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6",
     "license": "MIT",
@@ -61,6 +61,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "157d18815426920cc271f8668e306138a0c10336ba1266c5cacd6af2b8bff05b",
+    "typesPublisherContentHash": "16df1d4804829cafe4d54bc250f82dc44d94a5df3a0b67262eaf6ffa33f024c7",
     "typeScriptVersion": "4.8"
 }

k6/experimental/timers/index.d.ts

@@ -1,47 +0,0 @@
-/**
- *  This module provides setInterval, setTimeout and co.
- */
-
-/**
- * Set a timer that executes a function once the timer expires.
- *
- * @param functionRef - The function to be executed.
- * @param delay - The delay in milliseconds.
- * @param args - The arguments to be passed to the function.
- * @returns The timer id.
- */
-export function setTimeout(functionRef: (...args: any[]) => void, delay: number, ...args: any[]): TimeoutID;
-
-/**
- * Cancels a timer previously set with setTimeout().
- *
- * @param timeoutID - The timer id to be cancelled.
- */
-export function clearTimeout(timeoutID: TimeoutID): void;
-
-/**
- * Repeatedly execute a function, with a fixed time delay between each call.
- *
- * @param functionRef - The function to be executed.
- * @param delay - The delay in milliseconds.
- * @param args - The arguments to be passed to the function.
- * @returns The interval id.
- */
-export function setInterval(functionRef: (...args: any[]) => void, delay: number, ...args: any[]): IntervalID;
-
-/**
- * Cancels an interval previously set with setInterval().
- *
- * @param intervalID - The interval id to be cancelled.
- */
-export function clearInterval(intervalID: IntervalID): void;
-
-/**
- * Type alias for a timer id.
- */
-export type TimeoutID = number;
-
-/**
- * Type alias for a interval id.
- */
-export type IntervalID = number;