@types/k6 0.32.1 → 0.34.2

k6/README.md

@@ -8,9 +8,9 @@ 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, 25 Jun 2021 11:31:14 GMT
+ * Last updated: Wed, 20 Oct 2021 10:31:23 GMT
  * Dependencies: none
  * Global values: none
 
 # Credits
-These definitions were written by [MajorBreakfast](https://github.com/MajorBreakfast), [Book Moons](https://github.com/bookmoons), [na--](https://github.com/na--), [Pepe Cano](https://github.com/ppcano), [Simon Aronsson](https://github.com/simskij), and [Ivan Mirić](https://github.com/imiric).
+These definitions were written by [na--](https://github.com/na--), [Ivan Mirić](https://github.com/imiric), [Mihail Stoykov](https://github.com/MStoykov), [Ivan](https://github.com/codebien), [Inanc Gumus](https://github.com/inancgumus), [yorugac](https://github.com/yorugac), and [Pepe Cano](https://github.com/ppcano).

k6/data.d.ts

@@ -7,5 +7,5 @@ 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<T>(name: string, callback: () => T[]): T[];
 };

k6/execution.d.ts

@@ -0,0 +1,85 @@
+/*
+ * The execution module provides information about the current test execution state.
+ * https://k6.io/docs/javascript-api/k6-execution/
+ */
+declare namespace execution {
+    /**
+     * Information about the current scenario.
+     */
+    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.
+     */
+    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;
+    };
+
+    /**
+     * Information about the current virtual user.
+     */
+    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;
+    };
+}
+
+export default execution;

k6/http.d.ts

@@ -10,7 +10,7 @@ import { Selection } from './html';
  * @returns Resulting response.
  */
 export function del<RT extends ResponseType | undefined>(
-    url: string,
+    url: string | HttpURL,
     body?: RequestBody | null,
     params?: RefinedParams<RT> | null
 ): RefinedResponse<RT>;
@@ -25,7 +25,7 @@ export function del<RT extends ResponseType | undefined>(
  * http.get('https://k6.io')
  */
 export function get<RT extends ResponseType | undefined>(
-    url: string,
+    url: string | HttpURL,
     params?: RefinedParams<RT> | null
 ): RefinedResponse<RT>;
 
@@ -38,7 +38,7 @@ export function get<RT extends ResponseType | undefined>(
  * @returns Resulting response.
  */
 export function options<RT extends ResponseType | undefined>(
-    url: string,
+    url: string | HttpURL,
     body?: RequestBody | null,
     params?: RefinedParams<RT> | null
 ): RefinedResponse<RT>;
@@ -52,7 +52,7 @@ export function options<RT extends ResponseType | undefined>(
  * @returns Resulting response.
  */
 export function patch<RT extends ResponseType | undefined>(
-    url: string,
+    url: string | HttpURL,
     body?: RequestBody | null,
     params?: RefinedParams<RT> | null
 ): RefinedResponse<RT>;
@@ -70,7 +70,7 @@ export function patch<RT extends ResponseType | undefined>(
  * http.post(url, formData, { headers: headers });
  */
 export function post<RT extends ResponseType | undefined>(
-    url: string,
+    url: string | HttpURL,
     body?: RequestBody | null,
     params?: RefinedParams<RT> | null
 ): RefinedResponse<RT>;
@@ -84,7 +84,7 @@ export function post<RT extends ResponseType | undefined>(
  * @returns Resulting response.
  */
 export function put<RT extends ResponseType | undefined>(
-    url: string,
+    url: string | HttpURL,
     body?: RequestBody | null,
     params?: RefinedParams<RT> | null
 ): RefinedResponse<RT>;
@@ -104,7 +104,7 @@ export function put<RT extends ResponseType | undefined>(
  */
 export function request<RT extends ResponseType | undefined>(
     method: string,
-    url: string,
+    url: string | HttpURL,
     body?: RequestBody | null,
     params?: RefinedParams<RT> | null
 ): RefinedResponse<RT>;
@@ -307,12 +307,12 @@ export interface StructuredRequestBody {
  * Batch request specification.
  * https://k6.io/docs/javascript-api/k6-http/batch-requests
  */
-export type BatchRequest = string | ArrayBatchRequest | ObjectBatchRequest;
+export type BatchRequest = string | HttpURL | ArrayBatchRequest | ObjectBatchRequest;
 
 /**
  * Array form batch request specification.
  */
-export type ArrayBatchRequest = [ string, string, (RequestBody | null)?, (Params | null)? ];
+export type ArrayBatchRequest = [ string, string | HttpURL, (RequestBody | null)?, (Params | null)? ];
 
 /**
  * Object form batch request specification.
@@ -322,7 +322,7 @@ export interface ObjectBatchRequest {
     method: string;
 
     /** Request URL. */
-    url: string;
+    url: string | HttpURL;
 
     /** Request body. */
     body?: RequestBody | null;
@@ -345,6 +345,7 @@ export type BatchRequests = BatchRequest[] | { [name: string]: BatchRequest };
  */
 export type RefinedBatchRequest<RT extends ResponseType | undefined> =
     | string
+    | HttpURL
     | ArrayRefinedBatchRequest<RT>
     | ObjectRefinedBatchRequest<RT>;
 
@@ -353,7 +354,7 @@ export type RefinedBatchRequest<RT extends ResponseType | undefined> =
  */
 export type ArrayRefinedBatchRequest<RT extends ResponseType | undefined> = [
     string,
-    string,
+    string | HttpURL ,
     (RequestBody | null)?,
     (RefinedParams<RT> | null)?
 ];
@@ -363,7 +364,7 @@ export type ArrayRefinedBatchRequest<RT extends ResponseType | undefined> = [
  */
 export interface ObjectRefinedBatchRequest<RT extends ResponseType | undefined> {
     method: string;
-    url: string;
+    url: string | HttpURL;
     body?: RequestBody | null;
     params?: RefinedParams<RT> | null;
 }
@@ -520,7 +521,7 @@ export interface Response {
      * let res = http.get(url);
      * res.json();
      */
-    json(selector?: string): JSONValue | undefined;
+    json(selector?: string): JSONValue;
 
     /**
      * Submit form on page.
@@ -734,6 +735,16 @@ export interface ExpectedStatusesObject {
     max: number;
 }
 
+// === HTTP URL ===
+// -----------------------
+
+/**
+ * Returned value from http.url method.
+ */
+ interface HttpURL {
+  __brand: "http-url";
+}
+
 /**
  * The http module contains functionality for performing HTTP transactions.
  * https://k6.io/docs/javascript-api/k6-http/
@@ -748,7 +759,7 @@ declare namespace http {
      * @returns Resulting response.
      */
     function del<RT extends ResponseType | undefined>(
-        url: string,
+        url: string | HttpURL,
         body?: RequestBody | null,
         params?: RefinedParams<RT> | null
     ): RefinedResponse<RT>;
@@ -763,7 +774,7 @@ declare namespace http {
      * http.get('https://k6.io')
      */
     function get<RT extends ResponseType | undefined>(
-        url: string,
+        url: string | HttpURL,
         params?: RefinedParams<RT> | null
     ): RefinedResponse<RT>;
 
@@ -776,7 +787,7 @@ declare namespace http {
      * @returns Resulting response.
      */
     function options<RT extends ResponseType | undefined>(
-        url: string,
+        url: string | HttpURL,
         body?: RequestBody | null,
         params?: RefinedParams<RT> | null
     ): RefinedResponse<RT>;
@@ -790,7 +801,7 @@ declare namespace http {
      * @returns Resulting response.
      */
     function patch<RT extends ResponseType | undefined>(
-        url: string,
+        url: string | HttpURL,
         body?: RequestBody | null,
         params?: RefinedParams<RT> | null
     ): RefinedResponse<RT>;
@@ -808,7 +819,7 @@ declare namespace http {
      * http.post(url, formData, { headers: headers });
      */
     function post<RT extends ResponseType | undefined>(
-        url: string,
+        url: string | HttpURL,
         body?: RequestBody | null,
         params?: RefinedParams<RT> | null
     ): RefinedResponse<RT>;
@@ -822,7 +833,7 @@ declare namespace http {
      * @returns Resulting response.
      */
     function put<RT extends ResponseType | undefined>(
-        url: string,
+        url: string | HttpURL,
         body?: RequestBody | null,
         params?: RefinedParams<RT> | null
     ): RefinedResponse<RT>;
@@ -842,11 +853,22 @@ declare namespace http {
      */
     function request<RT extends ResponseType | undefined>(
         method: string,
-        url: string,
+        url: string | HttpURL,
         body?: RequestBody | null,
         params?: RefinedParams<RT> | null
     ): RefinedResponse<RT>;
 
+    /**
+     * Creates a URL with set name tag.
+     * https://k6.io/docs/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.

k6/index.d.ts

@@ -1,11 +1,12 @@
-// Type definitions for k6 0.32
+// Type definitions for k6 0.34
 // Project: https://k6.io/docs/
-// Definitions by: MajorBreakfast <https://github.com/MajorBreakfast>
-//                 Book Moons <https://github.com/bookmoons>
-//                 na-- <https://github.com/na-->
-//                 Pepe Cano <https://github.com/ppcano>
-//                 Simon Aronsson <https://github.com/simskij>
+// Definitions by: na-- <https://github.com/na-->
 //                 Ivan Mirić <https://github.com/imiric>
+//                 Mihail Stoykov <https://github.com/MStoykov>
+//                 Ivan <https://github.com/codebien>
+//                 Inanc Gumus <https://github.com/inancgumus>
+//                 yorugac <https://github.com/yorugac>
+//                 Pepe Cano <https://github.com/ppcano>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // TypeScript Version: 3.4
 
@@ -34,6 +35,7 @@ import './global'; // Type global environment
 import './crypto';
 import './data';
 import './encoding';
+import './execution';
 import './html';
 import './http';
 import './metrics';

k6/metrics.d.ts

@@ -15,6 +15,9 @@ export abstract class Metric {
      */
     constructor(name: string, isTime?: boolean);
 
+    /** The name of the custom metric. */
+    name: string;
+
     /**
      * Add value.
      * @param value - Value to add.

k6/package.json

@@ -1,39 +1,44 @@
 {
     "name": "@types/k6",
-    "version": "0.32.1",
+    "version": "0.34.2",
     "description": "TypeScript definitions for k6",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6",
     "license": "MIT",
     "contributors": [
         {
-            "name": "MajorBreakfast",
-            "url": "https://github.com/MajorBreakfast",
-            "githubUsername": "MajorBreakfast"
+            "name": "na--",
+            "url": "https://github.com/na--",
+            "githubUsername": "na--"
         },
         {
-            "name": "Book Moons",
-            "url": "https://github.com/bookmoons",
-            "githubUsername": "bookmoons"
+            "name": "Ivan Mirić",
+            "url": "https://github.com/imiric",
+            "githubUsername": "imiric"
         },
         {
-            "name": "na--",
-            "url": "https://github.com/na--",
-            "githubUsername": "na--"
+            "name": "Mihail Stoykov",
+            "url": "https://github.com/MStoykov",
+            "githubUsername": "MStoykov"
         },
         {
-            "name": "Pepe Cano",
-            "url": "https://github.com/ppcano",
-            "githubUsername": "ppcano"
+            "name": "Ivan",
+            "url": "https://github.com/codebien",
+            "githubUsername": "codebien"
         },
         {
-            "name": "Simon Aronsson",
-            "url": "https://github.com/simskij",
-            "githubUsername": "simskij"
+            "name": "Inanc Gumus",
+            "url": "https://github.com/inancgumus",
+            "githubUsername": "inancgumus"
         },
         {
-            "name": "Ivan Mirić",
-            "url": "https://github.com/imiric",
-            "githubUsername": "imiric"
+            "name": "yorugac",
+            "url": "https://github.com/yorugac",
+            "githubUsername": "yorugac"
+        },
+        {
+            "name": "Pepe Cano",
+            "url": "https://github.com/ppcano",
+            "githubUsername": "ppcano"
         }
     ],
     "main": "",
@@ -45,6 +50,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "ed5e70f6d3f6e90e131b3958cfb61c328e44ed91ee4a74fbb56d5e6be96d4ca7",
-    "typeScriptVersion": "3.6"
+    "typesPublisherContentHash": "a0c95f6bb3f3029894f1263b00b2b0a0fe8d331c94d0f78ea2db2e4c7990c1d4",
+    "typeScriptVersion": "3.7"
 }