@types/k6 0.44.2 → 0.44.3

k6/experimental/webcrypto.d.ts

@@ -46,7 +46,7 @@ export interface SubtleCrypto {
     decrypt(
         algorithm: AesCtrParams | AesCbcParams | AesGcmParams,
         key: CryptoKey,
-        data: ArrayBuffer | ArrayBufferView | DataView
+        data: ArrayBuffer | ArrayBufferView | DataView,
     ): Promise<ArrayBuffer>;
 
     /**
@@ -67,7 +67,7 @@ export interface SubtleCrypto {
      */
     digest(
         algorithm: HashAlgorithmIdentifier | Algorithm<HashAlgorithmIdentifier>,
-        data: ArrayBuffer | ArrayBufferView | DataView
+        data: ArrayBuffer | ArrayBufferView | DataView,
     ): Promise<ArrayBuffer>;
 
     /**
@@ -83,7 +83,7 @@ export interface SubtleCrypto {
     encrypt(
         algorithm: AesCtrParams | AesCbcParams | AesGcmParams,
         key: CryptoKey,
-        data: ArrayBuffer | ArrayBufferView | DataView
+        data: ArrayBuffer | ArrayBufferView | DataView,
     ): Promise<ArrayBuffer>;
 
     /**
@@ -99,10 +99,7 @@ export interface SubtleCrypto {
      * @throws {TypeError} - when trying to use an invalid format.
      * @returns A promise that resolves with the exported key.
      */
-    exportKey(
-        format: "raw",
-        key: CryptoKey
-    ): Promise<ArrayBuffer>;
+    exportKey(format: 'raw', key: CryptoKey): Promise<ArrayBuffer>;
 
     /**
      * Use the `generateKey()` method to generate a new key (for symmetric
@@ -117,7 +114,7 @@ export interface SubtleCrypto {
     generateKey(
         algorithm: AesKeyGenParams | HmacKeyGenParams,
         extractable: boolean,
-        keyUsages: Array<"encrypt" | "decrypt" | "sign" | "verify">
+        keyUsages: Array<'encrypt' | 'decrypt' | 'sign' | 'verify'>,
     ): Promise<CryptoKey>;
 
     /**
@@ -135,11 +132,11 @@ export interface SubtleCrypto {
      * @returns A promise that resolves with the imported `CryptoKey`.
      */
     importKey(
-        format: "raw",
+        format: 'raw',
         keyData: ArrayBuffer | ArrayBufferView | DataView,
-        algorithm: "AES-CBC" | "AES-CTR" | "AES-GCM" | Algorithm<"AES-CBC" | "AES-CTR" | "AES-GCM"> | HmacImportParams,
+        algorithm: 'AES-CBC' | 'AES-CTR' | 'AES-GCM' | Algorithm<'AES-CBC' | 'AES-CTR' | 'AES-GCM'> | HmacImportParams,
         extractable: boolean,
-        keyUsages: Array<"encrypt" | "decrypt" | "sign" | "verify">
+        keyUsages: Array<'encrypt' | 'decrypt' | 'sign' | 'verify'>,
     ): Promise<CryptoKey>;
 
     /**
@@ -155,9 +152,9 @@ export interface SubtleCrypto {
      * @returns A promise that resolves with the signature.
      */
     sign(
-        algorithm: "HMAC" | Algorithm<"HMAC">,
+        algorithm: 'HMAC' | Algorithm<'HMAC'>,
         key: CryptoKey,
-        data: ArrayBuffer | ArrayBufferView | DataView
+        data: ArrayBuffer | ArrayBufferView | DataView,
     ): Promise<ArrayBuffer>;
 
     /**
@@ -171,10 +168,10 @@ export interface SubtleCrypto {
      * @returns A promise that resolves with a boolean indicating whether the signature is valid.
      */
     verify(
-        algorithm: "HMAC" | Algorithm<"HMAC">,
+        algorithm: 'HMAC' | Algorithm<'HMAC'>,
         key: CryptoKey,
         signature: ArrayBuffer | ArrayBufferView | DataView,
-        data: ArrayBuffer | ArrayBufferView | DataView
+        data: ArrayBuffer | ArrayBufferView | DataView,
     ): Promise<boolean>;
 }
 
@@ -182,7 +179,7 @@ export interface CryptoKey {
     /**
      * The type of key the object represents.
      */
-    readonly type: "secret" | "private" | "public";
+    readonly type: 'secret' | 'private' | 'public';
 
     /**
      * A boolean value indicating whether or not the
@@ -200,7 +197,7 @@ export interface CryptoKey {
     /**
      * An array of strings, indicating what can be done with the key.
      */
-    readonly usages: Array<"encrypt" | "decrypt" | "sign" | "verify">;
+    readonly usages: Array<'encrypt' | 'decrypt' | 'sign' | 'verify'>;
 }
 
 /**
@@ -225,7 +222,7 @@ export type AlgorithmIdentifier = string;
  * The `HashAlgorithmIdentifier` type of the Web Crypto API represents
  * the name of a hash algorithm.
  */
-export type HashAlgorithmIdentifier = "SHA-1" | "SHA-256" | "SHA-384" | "SHA-512";
+export type HashAlgorithmIdentifier = 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512';
 
 /**
  * The `AesKeyGenParams` dictionary of the Web Crypto API represents the
@@ -236,7 +233,7 @@ export interface AesKeyGenParams extends Algorithm<AlgorithmIdentifier> {
     /**
      * The name of the algorithm to use.
      */
-    name: "AES-GCM" | "AES-CBC" | "AES-CTR" | "AES-CFB" | "AES-KW";
+    name: 'AES-GCM' | 'AES-CBC' | 'AES-CTR' | 'AES-CFB' | 'AES-KW';
 
     /**
      * The length of the key, in bits.
@@ -254,7 +251,7 @@ export interface AesCtrParams extends Algorithm<AlgorithmIdentifier> {
     /**
      * The name of the algorithm to use.
      */
-    name: "AES-CTR";
+    name: 'AES-CTR';
 
     /**
      * The initial value of the counter block. This must be 16-byte
@@ -283,7 +280,7 @@ export interface AesCbcParams extends Algorithm<AlgorithmIdentifier> {
     /**
      * The name of the algorithm to use.
      */
-    name: "AES-CBC";
+    name: 'AES-CBC';
 
     /**
      * The initialization vector to use for the operation.
@@ -304,7 +301,7 @@ export interface AesGcmParams extends Algorithm<AlgorithmIdentifier> {
     /**
      * The name of the algorithm to use.
      */
-    name: "AES-GCM";
+    name: 'AES-GCM';
 
     /**
      * The initialization vector to use for the operation.
@@ -341,12 +338,12 @@ export interface HmacKeyGenParams extends Algorithm<AlgorithmIdentifier> {
     /**
      * The name of the algorithm to use.
      */
-    name: "HMAC";
+    name: 'HMAC';
 
     /**
      * A string representing the name of the digest function to use.
      */
-    hash: "SHA-1" | "SHA-256" | "SHA-384" | "SHA-512";
+    hash: 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512';
 
     /**
      * The length of the key, in bits. If the length is not specified,
@@ -366,7 +363,7 @@ export interface HmacImportParams extends Algorithm<AlgorithmIdentifier> {
     /**
      * The name of the algorithm to use.
      */
-    name: "HMAC";
+    name: 'HMAC';
 
     /**
      * The name of the digest function to use.

k6/experimental/websockets.d.ts

@@ -176,11 +176,11 @@ export enum ReadyState {
  * BinaryType describes the possible types of binary data that can be
  * transmitted over a Websocket connection.
  */
-export enum BinaryType  {
+export enum BinaryType {
     /**
      * Binary data is returned in ArrayBuffer form. k6 supports only this type.
      */
-    ArrayBuffer = 'ArrayBuffer'
+    ArrayBuffer = 'ArrayBuffer',
 }
 
 /**
@@ -296,10 +296,10 @@ export interface ErrorEvent {
 /**
  * CompressionAlgorithm describes the possible compression algorithms.
  */
-export enum CompressionAlgorithm  {
+export enum CompressionAlgorithm {
     /**
      * Deflate compression algorithm.
      * k6 supports only this compression algorithm.
      */
-    Deflate = 'deflate'
+    Deflate = 'deflate',
 }

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.2",
+    "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": "195015b205e4b6aaf08d145b291e14fb39ef2fb1ca71b6d3b1cfb305b81593fb",
+    "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;
 }