@types/k6 0.53.1 → 0.54.0

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: Fri, 23 Aug 2024 08:10:16 GMT
+ * Last updated: Mon, 30 Sep 2024 10:08:47 GMT
  * Dependencies: none
 
 # Credits

k6/{browser.d.ts → 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.
@@ -1333,6 +1335,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 +1588,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 +2048,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 +3093,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 +3395,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/{crypto.d.ts → crypto/index.d.ts}

@@ -215,165 +215,4 @@ export abstract class Hasher {
     digest<OE extends OutputEncoding>(outputEncoding: OE): Output<OE>;
 }
 
-/**
- * This module provides common hashing functionality available in the GoLang crypto package.
- * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/
- */
-declare namespace crypto {
-    /**
-     * Generate random bytes.
-     * @param size - Number of bytes to generate.
-     * @returns An ArrayBuffer with cryptographically random bytes.
-     * @example
-     * const bytes = crypto.randomBytes(42);
-     * const view = new Uint8Array(bytes);
-     * console.log(view); // 156,71,245,191,56,...
-     */
-    function randomBytes(size: number): ArrayBuffer;
-
-    /**
-     * Produce HMAC.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/hmac/
-     * @param algorithm - Hash algorithm.
-     * @param secret - Shared secret.
-     * @param input - Input data.
-     * @param outputEncoding - Output encoding.
-     * @returns Produced HMAC.
-     * @example
-     * crypto.hmac('sha256', 'mysecret', 'hello world!', 'hex')
-     */
-    function hmac<OE extends OutputEncoding>(
-        algorithm: Algorithm,
-        secret: string | ArrayBuffer,
-        input: string | ArrayBuffer,
-        outputEncoding: OE,
-    ): Output<OE>;
-
-    /**
-     * Hash with MD4.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/md4/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns MD4 digest.
-     * @example
-     * crypto.md4('hello world!', 'hex')
-     */
-    function md4<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with MD5.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/md5/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns MD5 digest.
-     * @example
-     * crypto.md5("hello world!", "hex")
-     */
-    function md5<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with SHA-1.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/sha1/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns SHA-1 digest.
-     * @example
-     * crypto.sha1('hello world!', 'hex')
-     */
-    function sha1<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with SHA-256.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/sha256/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns SHA-256 digest.
-     * @example
-     * crypto.sha256('hello world!', 'hex')
-     */
-    function sha256<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with SHA-384.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/sha384/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns SHA-384 digest.
-     * @example
-     * crypto.sha384('hello world!', 'hex')
-     */
-    function sha384<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with SHA-512.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/sha512/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns SHA-512 digest.
-     * @example
-     * crypto.sha512('hello world!', 'hex')
-     */
-    function sha512<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with SHA-512/224.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/sha512_224/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns SHA-512/224 digest.
-     * @example
-     * crypto.sha512_224('hello world!', 'hex')
-     */
-    function sha512_224<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with SHA-512/256.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/sha512_256/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns SHA-512/256 digest.
-     * @example
-     * crypto.sha512_256('hello world!', 'hex')
-     */
-    function sha512_256<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Hash with RIPEMD-160.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/ripemd160/
-     * @param input - Data to hash.
-     * @param outputEncoding - Output encoding.
-     * @returns RIPEMD-160 digest.
-     * @example
-     * crypto.ripemd160('hello world!', 'hex')
-     */
-    function ripemd160<OE extends OutputEncoding>(input: string | ArrayBuffer, outputEncoding: OE): Output<OE>;
-
-    /**
-     * Create a hashing object.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/createhash/
-     * @param algorithm - Hash algorithm.
-     * @returns Hashing object.
-     * @example
-     * let hasher = crypto.createHash('sha256');
-     * hasher.update('hello ');
-     * hasher.update('world!');
-     * console.log(hasher.digest('hex'));
-     */
-    function createHash(algorithm: Algorithm): Hasher;
-
-    /**
-     * Create an HMAC hashing object.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-crypto/createhmac/
-     * @param algorithm - Hash algorithm.
-     * @param secret - Shared secret.
-     * @returns HMAC hashing object.
-     * @example
-     * let hasher = crypto.createHMAC('sha256', 'a secret');
-     * hasher.update('hello ');
-     * hasher.update('world!');
-     * console.log(hasher.digest('hex'));
-     */
-    function createHMAC(algorithm: Algorithm, secret: string | ArrayBuffer): Hasher;
-}
-
-export default crypto;
+export * as default from "k6/crypto";

k6/encoding/index.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Base64 decode a string.
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-encoding/b64decode/
+ * @param input - The string to base64 decode.
+ * @param encoding - Base64 variant.
+ * @returns The base64 decoded version of the input string in either string or ArrayBuffer format, depending on the `format` parameter.
+ * @example
+ * encoding.b64decode(str)
+ * encoding.b64decode(str, 'rawstd')
+ * const decBuffer = encoding.b64decode(str, 'rawurl')
+ * let decBin = new Uint8Array(decBuffer);
+ */
+export function b64decode(input: string, encoding?: Base64Variant): ArrayBuffer;
+
+/**
+ * Base64 decode a string.
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-encoding/b64decode/
+ * @param input - The string to base64 decode.
+ * @param encoding - Base64 variant.
+ * @param format - If 's' return the data as a string, otherwise an ArrayBuffer object .
+ * @returns The base64 decoded version of the input string in either string or ArrayBuffer format, depending on the `format` parameter.
+ * @example
+ * encoding.b64decode(str)
+ * encoding.b64decode(str, 'rawstd')
+ * const decodedString = encoding.b64decode(str, 'rawurl', 's')
+ */
+export function b64decode(input: string, encoding: Base64Variant, format: "s"): string;
+
+/**
+ * Base64 encode a string.
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-encoding/b64encode/
+ * @param input - String to encode or ArrayBuffer object.
+ * @param encoding - Base64 variant.
+ * @returns Base64 encoded string.
+ * @example
+ * encoding.b64encode(str)
+ * encoding.b64encode(str, 'rawstd')
+ */
+export function b64encode(input: string | ArrayBuffer, encoding?: Base64Variant): string;
+
+/**
+ * Base64 variant.
+ */
+export type Base64Variant = "std" | "rawstd" | "url" | "rawurl";
+
+export * as default from "k6/encoding";

k6/execution/index.d.ts

@@ -0,0 +1,115 @@
+import { Options } from "./../options/index.js";
+
+/**
+ * Information about the current scenario.
+ */
+export const scenario: {
+    /**
+     * The assigned name of the running scenario.
+     */
+    name: string;
+    /**
+     * The name of the running Executor type.
+     */
+    executor: string;
+    /**
+     * The Unix timestamp in milliseconds when the scenario started.
+     */
+    startTime: number;
+    /**
+     * Percentage in a 0 to 1 interval of the scenario progress.
+     */
+    progress: number;
+    /**
+     * The unique and zero-based sequential number of the current iteration in the scenario, across the current instance.
+     */
+    iterationInInstance: number;
+    /**
+     * The unique and zero-based sequential number of the current iteration in the scenario.
+     */
+    iterationInTest: number;
+};
+
+/**
+ * Information about the current load generator instance.
+ */
+export const instance: {
+    /**
+     * The number of prematurely interrupted iterations in the current instance.
+     */
+    iterationsInterrupted: number;
+    /**
+     * The number of completed iterations in the current instance.
+     */
+    iterationsCompleted: number;
+    /**
+     * The number of active VUs.
+     */
+    vusActive: number;
+    /**
+     * The number of currently initialized VUs.
+     */
+    vusInitialized: number;
+    /**
+     * The time passed from the start of the current test run in milliseconds.
+     */
+    currentTestRunDuration: number;
+};
+
+/**
+ * Control the test execution.
+ */
+export const test: {
+    /**
+     * Aborts the test run with the exit code 108.
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-execution/#test
+     * @param input - Aborted message.
+     * @example
+     * import exec from "k6/execution";
+     * exec.test.abort();
+     * exec.test.abort('this is the reason');
+     */
+    abort(input?: string): void;
+
+    options: Options;
+};
+
+/**
+ * Information about the current virtual user.
+ */
+export const vu: {
+    /**
+     * The identifier of the iteration in the current instance.
+     */
+    iterationInInstance: number;
+    /**
+     * The identifier of the iteration in the current scenario.
+     */
+    iterationInScenario: number;
+    /**
+     * The identifier of the VU across the instance.
+     */
+    idInInstance: number;
+    /**
+     * 	The globally unique (across the whole test run) identifier of the VU.
+     */
+    idInTest: number;
+
+    /**
+     * 	Map to set or get VU tags.
+     * 	@deprecated should use `metrics.tags` instead of just `tags`
+     */
+    tags: Record<string, number | string | boolean>;
+    metrics: {
+        /**
+         * 	Map to set or get VU tags.
+         */
+        tags: Record<string, number | string | boolean>;
+        /**
+         * 	Map to set or get VU metadata.
+         */
+        metadata: Record<string, number | string | boolean>;
+    };
+};
+
+export * as default from "k6/execution";

k6/experimental/{browser.d.ts → 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/{fs.d.ts → fs/index.d.ts}

@@ -100,3 +100,5 @@ export enum SeekMode {
     Current = 1, // Seek from the current file position.
     End = 2, // Seek from the end of the file
 }
+
+export * as default from "k6/experimental/fs";

k6/experimental/{redis.d.ts → redis/index.d.ts}

@@ -814,3 +814,8 @@ export interface ClusterOptions {
      */
     nodes: RedisConnectionURL[] | SocketOptions[];
 }
+
+declare let _default: {
+    Client: Client;
+};
+export default _default;

k6/experimental/{tracing.d.ts → tracing/index.d.ts}

@@ -8,7 +8,7 @@
  * https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/tracing/
  */
 
-import { RefinedParams, RefinedResponse, RequestBody, ResponseType } from "../http";
+import { RefinedParams, RefinedResponse, RequestBody, ResponseType } from "../../http/index.js";
 
 /**
  * The instrumentHTTP function instruments the k6 http module
@@ -204,3 +204,5 @@ export interface Options {
 export interface HttpURL {
     __brand: "http-url";
 }
+
+export * as default from "k6/experimental/tracing";

k6/experimental/{websockets.d.ts → websockets/index.d.ts}

@@ -1,5 +1,5 @@
-import { CookieJar } from "../http";
-import { ReadableStream } from "./streams";
+import { CookieJar } from "../../http/index.js";
+import { ReadableStream } from "../streams/index.js";
 
 /**
  * This module provides an experimental implementation of the WebSocket API
@@ -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/global.d.ts

@@ -56,7 +56,7 @@ declare global {
      * Environment variables.
      * https://grafana.com/docs/k6/latest/using-k6/environment-variables/
      */
-    const __ENV: { [name: string]: string };
+    var __ENV: { [name: string]: string };
 
     // === VU logic only ===
     // ---------------------
@@ -65,11 +65,19 @@ declare global {
      * Current VU number.
      * https://grafana.com/docs/k6/latest/using-k6/execution-context-variables/
      */
-    const __VU: number;
+    var __VU: number;
 
     /**
      * Current iteration number.
      * https://grafana.com/docs/k6/latest/using-k6/execution-context-variables/
      */
-    const __ITER: number;
+    var __ITER: number;
+
+    interface ImportMeta {
+        /**
+         * Resolve a path to a URL string in the same way an import statement does.
+         * https://grafana.com/docs/k6/latest/javascript-api/import.meta/resolve/
+         */
+        resolve(specifier: string): string;
+    }
 }