@types/k6 0.44.1 → 0.44.3

k6/http.d.ts

@@ -12,7 +12,7 @@ import { Selection } from './html';
 export function del<RT extends ResponseType | undefined>(
     url: string | HttpURL,
     body?: RequestBody | null,
-    params?: RefinedParams<RT> | null
+    params?: RefinedParams<RT> | null,
 ): RefinedResponse<RT>;
 
 /**
@@ -24,9 +24,9 @@ export function del<RT extends ResponseType | undefined>(
  * @example
  * http.head('https://test.k6.io')
  */
- export function head<RT extends ResponseType | undefined>(
+export function head<RT extends ResponseType | undefined>(
     url: string | HttpURL,
-    params?: RefinedParams<RT> | null
+    params?: RefinedParams<RT> | null,
 ): RefinedResponse<RT>;
 
 /**
@@ -40,7 +40,7 @@ export function del<RT extends ResponseType | undefined>(
  */
 export function get<RT extends ResponseType | undefined>(
     url: string | HttpURL,
-    params?: RefinedParams<RT> | null
+    params?: RefinedParams<RT> | null,
 ): RefinedResponse<RT>;
 
 /**
@@ -54,7 +54,7 @@ export function get<RT extends ResponseType | undefined>(
 export function options<RT extends ResponseType | undefined>(
     url: string | HttpURL,
     body?: RequestBody | null,
-    params?: RefinedParams<RT> | null
+    params?: RefinedParams<RT> | null,
 ): RefinedResponse<RT>;
 
 /**
@@ -68,7 +68,7 @@ export function options<RT extends ResponseType | undefined>(
 export function patch<RT extends ResponseType | undefined>(
     url: string | HttpURL,
     body?: RequestBody | null,
-    params?: RefinedParams<RT> | null
+    params?: RefinedParams<RT> | null,
 ): RefinedResponse<RT>;
 
 /**
@@ -86,7 +86,7 @@ export function patch<RT extends ResponseType | undefined>(
 export function post<RT extends ResponseType | undefined>(
     url: string | HttpURL,
     body?: RequestBody | null,
-    params?: RefinedParams<RT> | null
+    params?: RefinedParams<RT> | null,
 ): RefinedResponse<RT>;
 
 /**
@@ -100,7 +100,7 @@ export function post<RT extends ResponseType | undefined>(
 export function put<RT extends ResponseType | undefined>(
     url: string | HttpURL,
     body?: RequestBody | null,
-    params?: RefinedParams<RT> | null
+    params?: RefinedParams<RT> | null,
 ): RefinedResponse<RT>;
 
 /**
@@ -120,7 +120,7 @@ export function request<RT extends ResponseType | undefined>(
     method: string,
     url: string | HttpURL,
     body?: RequestBody | null,
-    params?: RefinedParams<RT> | null
+    params?: RefinedParams<RT> | null,
 ): RefinedResponse<RT>;
 
 /**
@@ -140,7 +140,7 @@ export function asyncRequest<RT extends ResponseType | undefined>(
     method: string,
     url: string | HttpURL,
     body?: RequestBody | null,
-    params?: RefinedParams<RT> | null
+    params?: RefinedParams<RT> | null,
 ): Promise<RefinedResponse<RT>>;
 
 /**
@@ -346,7 +346,7 @@ export type BatchRequest = string | HttpURL | ArrayBatchRequest | ObjectBatchReq
 /**
  * Array form batch request specification.
  */
-export type ArrayBatchRequest = [ string, string | HttpURL, (RequestBody | null)?, (Params | null)? ];
+export type ArrayBatchRequest = [string, string | HttpURL, (RequestBody | null)?, (Params | null)?];
 
 /**
  * Object form batch request specification.
@@ -388,9 +388,9 @@ export type RefinedBatchRequest<RT extends ResponseType | undefined> =
  */
 export type ArrayRefinedBatchRequest<RT extends ResponseType | undefined> = [
     string,
-    string | HttpURL ,
+    string | HttpURL,
     (RequestBody | null)?,
-    (RefinedParams<RT> | null)?
+    (RefinedParams<RT> | null)?,
 ];
 
 /**
@@ -792,8 +792,8 @@ export interface ExpectedStatusesObject {
 /**
  * Returned value from http.url method.
  */
- interface HttpURL {
-  __brand: "http-url";
+interface HttpURL {
+    __brand: 'http-url';
 }
 
 /**
@@ -812,7 +812,7 @@ declare namespace http {
     function del<RT extends ResponseType | undefined>(
         url: string | HttpURL,
         body?: RequestBody | null,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -826,7 +826,7 @@ declare namespace http {
      */
     function head<RT extends ResponseType | undefined>(
         url: string | HttpURL,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -840,7 +840,7 @@ declare namespace http {
      */
     function get<RT extends ResponseType | undefined>(
         url: string | HttpURL,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -854,7 +854,7 @@ declare namespace http {
     function options<RT extends ResponseType | undefined>(
         url: string | HttpURL,
         body?: RequestBody | null,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -868,7 +868,7 @@ declare namespace http {
     function patch<RT extends ResponseType | undefined>(
         url: string | HttpURL,
         body?: RequestBody | null,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -886,7 +886,7 @@ declare namespace http {
     function post<RT extends ResponseType | undefined>(
         url: string | HttpURL,
         body?: RequestBody | null,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -900,7 +900,7 @@ declare namespace http {
     function put<RT extends ResponseType | undefined>(
         url: string | HttpURL,
         body?: RequestBody | null,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -920,7 +920,7 @@ declare namespace http {
         method: string,
         url: string | HttpURL,
         body?: RequestBody | null,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -940,7 +940,7 @@ declare namespace http {
         method: string,
         url: string | HttpURL,
         body?: RequestBody | null,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): Promise<RefinedResponse<RT>>;
 
     /**
@@ -952,7 +952,7 @@ declare namespace http {
      * @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;
+    function url(strings: TemplateStringsArray, ...args: Array<string | number | boolean>): HttpURL;
 
     /**
      * Batch multiple HTTP requests together,

k6/options.d.ts

@@ -30,7 +30,7 @@ export interface Options {
         /** 0, inf, or any time duration(60s, 5m30s, 10m, 2h). */
         ttl: string;
 
-        select: 'first' | 'random' |  'roundRobin';
+        select: 'first' | 'random' | 'roundRobin';
 
         policy: 'preferIPv4' | 'preferIPv6' | 'onlyIPv4' | 'onlyIPv6' | 'any';
     };
@@ -87,7 +87,7 @@ export interface Options {
     rps?: number;
 
     /** Scenario specifications. */
-    scenarios?: { [name: string]: Scenario};
+    scenarios?: { [name: string]: Scenario };
 
     /** Setup function timeout. */
     setupTimeout?: string;
@@ -188,7 +188,14 @@ export interface Certificate {
     password?: string;
 }
 
-export type ExecutorOptions = "shared-iterations" | "per-vu-iterations" | "constant-vus" | "ramping-vus" | "constant-arrival-rate" | "ramping-arrival-rate" | "externally-controlled";
+export type ExecutorOptions =
+    | 'shared-iterations'
+    | 'per-vu-iterations'
+    | 'constant-vus'
+    | 'ramping-vus'
+    | 'constant-arrival-rate'
+    | 'ramping-arrival-rate'
+    | 'externally-controlled';
 
 /**
  * BaseScenario.
@@ -243,7 +250,7 @@ export abstract class BaseScenario {
  * https://k6.io/docs/using-k6/scenarios/executors/shared-iterations/
  */
 export interface SharedIterationsScenario extends BaseScenario {
-    executor: "shared-iterations";
+    executor: 'shared-iterations';
     /**
      * Number of VUs to run concurrently.
      *
@@ -272,7 +279,7 @@ export interface SharedIterationsScenario extends BaseScenario {
  * https://k6.io/docs/using-k6/scenarios/executors/per-vu-iterations/
  */
 export interface PerVUIterationsScenario extends BaseScenario {
-    executor: "per-vu-iterations";
+    executor: 'per-vu-iterations';
     /**
      * Number of VUs to run concurrently.
      *
@@ -301,7 +308,7 @@ export interface PerVUIterationsScenario extends BaseScenario {
  * https://k6.io/docs/using-k6/scenarios/executors/constant-vus/
  */
 export interface ConstantVUsScenario extends BaseScenario {
-    executor: "constant-vus";
+    executor: 'constant-vus';
 
     /**
      * Number of VUs to run concurrently.
@@ -322,7 +329,7 @@ export interface ConstantVUsScenario extends BaseScenario {
  * https://k6.io/docs/using-k6/scenarios/executors/ramping-vus/
  */
 export interface RampingVUsScenario extends BaseScenario {
-    executor: "ramping-vus";
+    executor: 'ramping-vus';
 
     /** Array of objects that specify the number of VUs to ramp up or down to. */
     stages: Stage[];
@@ -348,7 +355,7 @@ export interface RampingVUsScenario extends BaseScenario {
  * https://k6.io/docs/using-k6/scenarios/executors/constant-arrival-rate/
  */
 export interface ConstantArrivalRateScenario extends BaseScenario {
-    executor: "constant-arrival-rate";
+    executor: 'constant-arrival-rate';
 
     /** Total scenario duration (excluding `gracefulStop`) */
     duration: string;
@@ -380,7 +387,7 @@ export interface ConstantArrivalRateScenario extends BaseScenario {
  * https://k6.io/docs/using-k6/scenarios/executors/ramping-arrival-rate/
  */
 export interface RampingArrivalRateScenario extends BaseScenario {
-    executor: "ramping-arrival-rate";
+    executor: 'ramping-arrival-rate';
 
     /** Maximum number of VUs to allow during the test run. */
     maxVUs?: number;
@@ -408,7 +415,7 @@ export interface RampingArrivalRateScenario extends BaseScenario {
  * https://k6.io/docs/using-k6/scenarios/executors/externally-controlled/
  */
 export interface ExternallyControlledScenario extends BaseScenario {
-    executor: "externally-controlled";
+    executor: 'externally-controlled';
 
     /**
      * Number of VUs to run concurrently.
@@ -424,10 +431,11 @@ export interface ExternallyControlledScenario extends BaseScenario {
     maxVUs?: number;
 }
 
-export type Scenario = SharedIterationsScenario |
-                       PerVUIterationsScenario |
-                       ConstantVUsScenario |
-                       RampingVUsScenario |
-                       ConstantArrivalRateScenario |
-                       RampingArrivalRateScenario |
-                       ExternallyControlledScenario;
+export type Scenario =
+    | SharedIterationsScenario
+    | PerVUIterationsScenario
+    | ConstantVUsScenario
+    | RampingVUsScenario
+    | ConstantArrivalRateScenario
+    | RampingArrivalRateScenario
+    | ExternallyControlledScenario;

k6/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/k6",
-    "version": "0.44.1",
+    "version": "0.44.3",
     "description": "TypeScript definitions for k6",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6",
     "license": "MIT",
@@ -60,6 +60,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "682e46b4410e1338c96b7b05df4cb618809adceb3857d43f06b155bfbd799e21",
+    "typesPublisherContentHash": "361534b19bc50893282724e8e2785b8c69f23e9233af269e95c9050d7957d763",
     "typeScriptVersion": "4.3"
 }

k6/ws.d.ts

@@ -248,7 +248,7 @@ export interface MessageEventHandler {
 /**
  * BinaryMessage event handler.
  */
- export interface BinaryMessageEventHandler {
+export interface BinaryMessageEventHandler {
     /** @param message - Message. */
     (message: ArrayBuffer): void;
 }