@types/k6 0.47.3 → 0.49.0

k6/options.d.ts

@@ -1,13 +1,13 @@
 /*
  * Program options.
- * https://k6.io/docs/using-k6/options/
+ * https://grafana.com/docs/k6/latest/using-k6/k6-options/
  */
 
 import { CipherSuite } from "./http";
 
 /**
  * Program options.
- * https://k6.io/docs/using-k6/options/
+ * https://grafana.com/docs/k6/latest/using-k6/k6-options/
  */
 export interface Options {
     /** Maximum parallel `http.batch()` connections per VU. */
@@ -25,7 +25,7 @@ export interface Options {
     /** Discard response bodies. */
     discardResponseBodies?: boolean;
 
-    /** DNS resolution behavior. https://k6.io/docs/using-k6/options#dns */
+    /** DNS resolution behavior. https://grafana.com/docs/k6/latest/using-k6/k6-options#dns */
     dns?: {
         /** 0, inf, or any time duration(60s, 5m30s, 10m, 2h). */
         ttl: string;
@@ -38,10 +38,10 @@ export interface Options {
     /** Test duration. */
     duration?: string;
 
-    /** Partition the test run in different segments. https://k6.io/docs/using-k6/options#execution-segment */
+    /** Partition the test run in different segments. https://grafana.com/docs/k6/latest/using-k6/k6-options#execution-segment */
     executionSegment?: string;
 
-    /** Define the sequence segment to run. https://k6.io/docs/using-k6/options#execution-segment */
+    /** Define the sequence segment to run. https://grafana.com/docs/k6/latest/using-k6/k6-options#execution-segment */
     executionSegmentSequence?: string;
 
     /** Third party collector configuration. */
@@ -152,13 +152,13 @@ export interface Stage {
 
 /**
  * Threshold specification.
- * https://k6.io/docs/using-k6/thresholds/
+ * https://grafana.com/docs/k6/latest/using-k6/thresholds/
  */
 export type Threshold = string | ObjectThreshold;
 
 /**
  * Object form threshold specification.
- * https://k6.io/docs/using-k6/thresholds/
+ * https://grafana.com/docs/k6/latest/using-k6/thresholds/
  */
 export interface ObjectThreshold {
     /** Abort test if threshold violated. */
@@ -200,7 +200,7 @@ export type ExecutorOptions =
 /**
  * BaseScenario.
  *
- * https://k6.io/docs/using-k6/scenarios/
+ * https://grafana.com/docs/k6/latest/using-k6/scenarios/
  */
 export abstract class BaseScenario {
     /**
@@ -224,7 +224,7 @@ export abstract class BaseScenario {
 
     /**
      * Time to wait for iterations to finish executing before stopping them forcefully.
-     * See https://k6.io/docs/using-k6/scenarios#graceful-stop-and-ramp-down/
+     * See https://grafana.com/docs/k6/latest/using-k6/scenarios#graceful-stop-and-ramp-down/
      *
      * Default value is 30s
      */
@@ -250,7 +250,7 @@ export abstract class BaseScenario {
 /**
  * A fixed amount of iterations are shared between a number of VUs.
  *
- * https://k6.io/docs/using-k6/scenarios/executors/shared-iterations/
+ * https://grafana.com/docs/k6/latest/using-k6/scenarios/executors/shared-iterations/
  */
 export interface SharedIterationsScenario extends BaseScenario {
     executor: "shared-iterations";
@@ -279,7 +279,7 @@ export interface SharedIterationsScenario extends BaseScenario {
 /**
  * Each VU executes an exact number of iterations.
  *
- * https://k6.io/docs/using-k6/scenarios/executors/per-vu-iterations/
+ * https://grafana.com/docs/k6/latest/using-k6/scenarios/executors/per-vu-iterations/
  */
 export interface PerVUIterationsScenario extends BaseScenario {
     executor: "per-vu-iterations";
@@ -308,7 +308,7 @@ export interface PerVUIterationsScenario extends BaseScenario {
 /**
  * A fixed number of VUs execute as many iterations as possible for a specified amount of time.
  *
- * https://k6.io/docs/using-k6/scenarios/executors/constant-vus/
+ * https://grafana.com/docs/k6/latest/using-k6/scenarios/executors/constant-vus/
  */
 export interface ConstantVUsScenario extends BaseScenario {
     executor: "constant-vus";
@@ -329,7 +329,7 @@ export interface ConstantVUsScenario extends BaseScenario {
 /**
  * A variable number of VUs execute as many iterations as possible for a specified amount of time.
  *
- * https://k6.io/docs/using-k6/scenarios/executors/ramping-vus/
+ * https://grafana.com/docs/k6/latest/using-k6/scenarios/executors/ramping-vus/
  */
 export interface RampingVUsScenario extends BaseScenario {
     executor: "ramping-vus";
@@ -355,7 +355,7 @@ export interface RampingVUsScenario extends BaseScenario {
 /**
  * A fixed number of iterations are executed in a specified period of time.
  *
- * https://k6.io/docs/using-k6/scenarios/executors/constant-arrival-rate/
+ * https://grafana.com/docs/k6/latest/using-k6/scenarios/executors/constant-arrival-rate/
  */
 export interface ConstantArrivalRateScenario extends BaseScenario {
     executor: "constant-arrival-rate";
@@ -387,7 +387,7 @@ export interface ConstantArrivalRateScenario extends BaseScenario {
 /**
  * A variable number of iterations are executed in a specified period of time.
  *
- * https://k6.io/docs/using-k6/scenarios/executors/ramping-arrival-rate/
+ * https://grafana.com/docs/k6/latest/using-k6/scenarios/executors/ramping-arrival-rate/
  */
 export interface RampingArrivalRateScenario extends BaseScenario {
     executor: "ramping-arrival-rate";
@@ -415,7 +415,7 @@ export interface RampingArrivalRateScenario extends BaseScenario {
 /**
  * Control and scale execution at runtime via k6's REST API or the CLI.
  *
- * https://k6.io/docs/using-k6/scenarios/executors/externally-controlled/
+ * https://grafana.com/docs/k6/latest/using-k6/scenarios/executors/externally-controlled/
  */
 export interface ExternallyControlledScenario extends BaseScenario {
     executor: "externally-controlled";

k6/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/k6",
-    "version": "0.47.3",
+    "version": "0.49.0",
     "description": "TypeScript definitions for k6",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6",
     "license": "MIT",
@@ -49,6 +49,11 @@
             "name": "Daniel Jiménez",
             "githubUsername": "ka3de",
             "url": "https://github.com/ka3de"
+        },
+        {
+            "name": "Joan López de la Franca Beltran",
+            "githubUsername": "joanlopez",
+            "url": "https://github.com/joanlopez"
         }
     ],
     "main": "",
@@ -60,6 +65,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "29d8cb3515608ff666bebafd6f058aceff34cbc16d198ff17fe87b47a45346e0",
-    "typeScriptVersion": "4.5"
+    "typesPublisherContentHash": "0d8d2b1f53185323eb5e05154ba6e59b216bf4cb81d3074f93b14aa093219244",
+    "typeScriptVersion": "4.6"
 }

k6/ws.d.ts

@@ -2,7 +2,7 @@ import { CookieJar } from "./http";
 
 /**
  * Open WebSocket connection.
- * https://k6.io/docs/javascript-api/k6-ws/connect-url-params-callback/
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/connect/
  * @param url - Request URL.
  * @param callback - Logic to execute with socket.
  * @returns HTTP response to connection request.
@@ -18,7 +18,7 @@ export function connect(url: string, callback: Executor): Response;
 
 /**
  * Open WebSocket connection.
- * https://k6.io/docs/javascript-api/k6-ws/connect-url-params-callback/
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/connect/
  * @param url - Request URL.
  * @param params - Request parameters.
  * @param callback - Logic to execute with socket.
@@ -95,14 +95,14 @@ export interface Response {
 
 /**
  * Created socket.
- * https://k6.io/docs/javascript-api/k6-ws/socket/
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/
  */
 export abstract class Socket {
     protected __brand: never;
 
     /**
      * Close connection.
-     * https://k6.io/docs/javascript-api/k6-ws/socket/socket-close/
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-close/
      * @param code - WebSocket status code.
      * @example
      * socket.close();
@@ -111,7 +111,7 @@ export abstract class Socket {
 
     /**
      * Listen to event.
-     * https://k6.io/docs/javascript-api/k6-ws/socket/socket-on-event-callback/
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-on/
      * @param event - Event type.
      * @param handler - Event handler.
      * @example
@@ -126,7 +126,7 @@ export abstract class Socket {
 
     /**
      * Send ping.
-     * https://k6.io/docs/javascript-api/k6-ws/socket/socket-ping/
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-ping/
      * @example
      * socket.ping();
      */
@@ -134,7 +134,7 @@ export abstract class Socket {
 
     /**
      * Send data.
-     * https://k6.io/docs/javascript-api/k6-ws/socket/socket-send-data/
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-send/
      * @param data - Data to send.
      * @example
      * socket.send(JSON.stringify({ data: 'hola' }));
@@ -162,7 +162,7 @@ export abstract class Socket {
 
     /**
      * Call a function repeatedly, while the WebSocket connection is open.
-     * https://k6.io/docs/javascript-api/k6-ws/socket/socket-setinterval-callback-interval/
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-setinterval/
      * @param handler - The function to call every `interval` milliseconds.
      * @param interval - Milliseconds between two calls to `callback`.
      * @example
@@ -176,7 +176,7 @@ export abstract class Socket {
     /**
      * Call a function at a later time,
      * if the WebSocket connection is still open then.
-     * https://k6.io/docs/javascript-api/k6-ws/socket/socket-settimeout-callback-delay/
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-settimeout/
      * @param handler - The function to call when `delay` has expired.
      * @param delay - Delay in milliseconds.
      * @example
@@ -282,12 +282,12 @@ export abstract class WebSocketError {
 
 /**
  * This module provides a WebSocket client implementing the WebSocket protocol.
- * https://k6.io/docs/javascript-api/k6-ws/
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/
  */
 declare namespace ws {
     /**
      * Open WebSocket connection.
-     * https://k6.io/docs/javascript-api/k6-ws/connect-url-params-callback/
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/connect/
      * @param url - Request URL.
      * @param callback - Logic to execute with socket.
      * @returns HTTP response to connection request.
@@ -303,7 +303,7 @@ declare namespace ws {
 
     /**
      * Open WebSocket connection.
-     * https://k6.io/docs/javascript-api/k6-ws/connect-url-params-callback/
+     * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/connect/
      * @param url - Request URL.
      * @param params - Request parameters.
      * @param callback - Logic to execute with socket.