@types/k6 0.53.1 → 0.53.2

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: Tue, 17 Sep 2024 08:09:49 GMT
  * Dependencies: none
 
 # Credits

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/{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

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;
+    }
 }

k6/{http.d.ts → http/index.d.ts}

@@ -1,5 +1,5 @@
-import { JSONValue } from ".";
-import { Selection } from "./html";
+import { Selection } from "../html/index.js";
+import { JSONValue } from "../index.js";
 
 /**
  * Make DELETE  request.
@@ -143,6 +143,17 @@ export function asyncRequest<RT extends ResponseType | undefined>(
     params?: RefinedParams<RT> | null,
 ): Promise<RefinedResponse<RT>>;
 
+/**
+ * Creates a URL with set name tag.
+ * https://grafana.com/docs/k6/latest/using-k6/http-requests/#url-grouping
+ * @param strings - Passed string values.
+ * @param args - Tagged template expressions.
+ * @returns HTTP URL object.
+ * @example
+ * http.get(http.url`http://example.com/posts/${id}`) // tags.name="http://example.com/posts/${}",
+ */
+export function url(strings: TemplateStringsArray, ...args: Array<string | number | boolean>): HttpURL;
+
 /**
  * Batch multiple HTTP requests together,
  * to issue them in parallel over multiple TCP connections.
@@ -792,228 +803,4 @@ interface HttpURL {
     __brand: "http-url";
 }
 
-/**
- * The http module contains functionality for performing HTTP transactions.
- * https://grafana.com/docs/k6/latest/javascript-api/k6-http/
- */
-declare namespace http {
-    /**
-     * Make DELETE  request.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-http/del/
-     * @param url - Request URL.
-     * @param body - Discouraged. Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     */
-    function del<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Make HEAD request.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-http/head/
-     * @param url - Request URL.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     * @example
-     * http.head('https://test.k6.io')
-     */
-    function head<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Make GET request.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-http/get/
-     * @param url - Request URL.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     * @example
-     * http.get('https://k6.io')
-     */
-    function get<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Make OPTIONS request.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-http/options/
-     * @param url - Request URL.
-     * @param body - Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     */
-    function options<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Make PATCH request.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-http/patch/
-     * @param url - Request URL.
-     * @param body - Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     */
-    function patch<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Make POST request.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-http/post/
-     * @param url - Request URL.
-     * @param body - Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     * @example
-     * let formData = {name: 'k6'};
-     * let headers = { 'Content-Type': 'application/x-www-form-urlencoded' };
-     * http.post(url, formData, { headers: headers });
-     */
-    function post<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Make PUT request.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-http/put/
-     * @param url - Request URL.
-     * @param body - Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     */
-    function put<RT extends ResponseType | undefined>(
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Make request.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-http/request/
-     * @param method - HTTP method.
-     * @param url - Request URL.
-     * @param body - Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     * @example
-     * let formData = {name: 'k6'};
-     * let headers = { 'Content-Type': 'application/x-www-form-urlencoded' };
-     * http.request('POST', url, formData, { headers: headers });
-     */
-    function request<RT extends ResponseType | undefined>(
-        method: string,
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): RefinedResponse<RT>;
-
-    /**
-     * Make async request.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-http/asyncrequest/
-     * @param method - HTTP method.
-     * @param url - Request URL.
-     * @param body - Request body. Object form encoded.
-     * @param params - Request parameters.
-     * @returns Resulting response.
-     * @example
-     * let formData = {name: 'k6'};
-     * let headers = { 'Content-Type': 'application/x-www-form-urlencoded' };
-     * http.asyncRequest('POST', url, formData, { headers: headers });
-     */
-    function asyncRequest<RT extends ResponseType | undefined>(
-        method: string,
-        url: string | HttpURL,
-        body?: RequestBody | null,
-        params?: RefinedParams<RT> | null,
-    ): Promise<RefinedResponse<RT>>;
-
-    /**
-     * Creates a URL with set name tag.
-     * https://grafana.com/docs/k6/latest/using-k6/http-requests/#url-grouping
-     * @param strings - Passed string values.
-     * @param args - Tagged template expressions.
-     * @returns HTTP URL object.
-     * @example
-     * http.get(http.url`http://example.com/posts/${id}`) // tags.name="http://example.com/posts/${}",
-     */
-    function url(strings: TemplateStringsArray, ...args: Array<string | number | boolean>): HttpURL;
-
-    /**
-     * Batch multiple HTTP requests together,
-     * to issue them in parallel over multiple TCP connections.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-http/batch/
-     * @param requests - Request specifications.
-     * @returns Resulting responses.
-     * @example
-     * let req1 = {
-     *    method: 'GET',
-     *    url: 'https://httpbin.org/get',
-     * };
-     * let req2 = {
-     *   method: 'POST',
-     *   url: 'https://httpbin.org/post',
-     *   body: {
-     *     hello: 'world!',
-     *   },
-     *   params: {
-     *     headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
-     *   },
-     * };
-     * let responses = http.batch([req1, req2]);
-     */
-    function batch<Q extends BatchRequests>(requests: Q): BatchResponses<Q>;
-
-    /**
-     * Create a file object used for building multipart requests (file uploads).
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-http/file/
-     * @param data - File data.
-     * @param filename - Filename. Included in MIME message.
-     * @param contentType - Content type. Included in MIME message.
-     * @returns File data object.
-     * @example
-     * let binFile = open('/path/to/file.bin', 'b');
-     *
-     * export default function() {
-     *   let f = http.file(binFile, 'test.bin');
-     *   console.log(md5(f.data, 'hex'));
-     *   console.log(f.filename);
-     *   console.log(f.content_type);
-     * }
-     */
-    function file(data: string | ArrayBuffer, filename?: string, contentType?: string): FileData;
-
-    /**
-     * Get active cookie jar.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-http/cookiejar/
-     * @returns Active cookie jar.
-     * @example
-     * let jar = http.cookieJar();
-     */
-    function cookieJar(): CookieJar;
-    /**
-     * Returns a callback to be used with setResponseCallback to mark responses
-     * as expected based only on their status codes.
-     * https://staging.k6.io/docs/javascript-api/k6-http/expectedstatuses-statuses/
-     */
-    function expectedStatuses(...param: Array<number | ExpectedStatusesObject>): ExpectedStatusesCallback;
-
-    /**
-     * Set the response callback to be called to determine if a response was expected/successful or not.
-     * https://grafana.com/docs/k6/latest/javascript-api/k6-http/setresponsecallback/
-     */
-    function setResponseCallback(responseCallback: ExpectedStatusesCallback): void;
-}
-
-export default http;
+export * as default from "k6/http";