@types/k6 0.41.0 → 0.43.0

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: Thu, 03 Nov 2022 14:32:55 GMT
+ * Last updated: Mon, 20 Feb 2023 16:02:34 GMT
  * Dependencies: none
  * Global values: none
 
 # Credits
-These definitions were written by [na--](https://github.com/na--), [Mihail Stoykov](https://github.com/MStoykov), [Ivan](https://github.com/codebien), [Théo Crevon](https://github.com/oleiade), [Oleg Bespalov](https://github.com/olegbespalov), [Pepe Cano](https://github.com/ppcano), and [Nicole van der Hoeven](https://github.com/nicolevanderhoeven).
+These definitions were written by [na--](https://github.com/na--), [Mihail Stoykov](https://github.com/MStoykov), [Ivan](https://github.com/codebien), [Ivan Mirić](https://github.com/imiric), [Théo Crevon](https://github.com/oleiade), [Oleg Bespalov](https://github.com/olegbespalov), [Pepe Cano](https://github.com/ppcano), and [Nicole van der Hoeven](https://github.com/nicolevanderhoeven).

k6/experimental/redis.d.ts

@@ -2,7 +2,7 @@
  * This module provides a redis client allowing users to interact with redis,
  * directly from their k6 scripts.
  *
- * https://k6.io/docs/javascript-api/k6-redis/
+ * https://k6.io/docs/javascript-api/k6-experimental/redis/
  */
 
 /**
@@ -10,7 +10,7 @@
  *
  * It exposes a promise-based API, allowing users to interact with Redis in an asynchronous manner.
  *
- * https://k6.io/docs/javascript-api/k6-redis/client
+ * https://k6.io/docs/javascript-api/k6-experimental/redis/client
  */
 export class Client {
     protected __brand: never;
@@ -29,7 +29,7 @@ export class Client {
      *
      * If the key already exists, it is overwritten.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-set
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-set
      *
      * @param key - key to set
      * @param value - value to set
@@ -41,7 +41,7 @@ export class Client {
     /**
      * Gets the value of a key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-get
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-get
      *
      * @param key - key to get
      * @returns a promise that resolves to the value of the key.
@@ -52,7 +52,7 @@ export class Client {
      * Atomically sets the value of a key and returns the value
      * previously stored at that key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-getset
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-getset
      *
      * @param key - key to get and set
      * @param value - value to set
@@ -65,7 +65,7 @@ export class Client {
      *
      * A key is ignored if it does not exist.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-del
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-del
      *
      * @param keys - keys to delete
      * @returns a promise that resolves to the number of keys that were removed.
@@ -75,7 +75,7 @@ export class Client {
     /**
      * Get the value of a key and delete it.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-getdel
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-getdel
      *
      * @param key - the key to get and delete
      * @returns a promise that resolves to the value of the key that was deleted.
@@ -85,7 +85,7 @@ export class Client {
     /**
      * Returns the number of the provided keys arguments that exist.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-exists
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-exists
      *
      * @param keys - the keys to check the existence of
      * @returns a promise that resolves to the number of keys that exist.
@@ -98,7 +98,7 @@ export class Client {
      * If the key does not exist, it is set to 0 before performing the operation.
      * If the key exists but cannot be treated as a number, the returned promise will be rejected.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-incr
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-incr
      *
      * @param key - key to increment the value of
      * @returns a promise that resolves to the value of the key after the increment.
@@ -111,7 +111,7 @@ export class Client {
      * If the key does not exist, it is set to 0 before performing the operation.
      * If the key exists but cannot be treated as a number, the returned promise will be rejected.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-incrby
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-incrby
      *
      * @param key - key to increment the value of
      * @param increment - amount to increment the value of the key by
@@ -125,7 +125,7 @@ export class Client {
      * If the key does not exist, it is set to 0 before performing the operation.
      * If the key exists but cannot be treated as a number, the returned promise will be rejected.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-decr
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-decr
      *
      * @param key - key to decrement the value of
      * @returns a promise that resolves to the value of the key after the decrement.
@@ -138,7 +138,7 @@ export class Client {
      * If the key does not exist, it is set to 0 before performing the operation.
      * If the key exists but cannot be treated as a number, the returned promise will be rejected.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-decrby
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-decrby
      *
      * @param key - key to decrement the value of
      * @param decrement - amount to decrement the value of the key by
@@ -151,7 +151,7 @@ export class Client {
      *
      * If the database is empty, the returned promise will be rejected.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-randomkey
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-randomkey
      *
      * @returns a promise that resolves to a random key.
      */
@@ -160,7 +160,7 @@ export class Client {
     /**
      * Returns the values of all the specified keys.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-mget
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-mget
      *
      * @param keys - the keys to get the values of
      * @returns a promise that resolves to an array of the values of the keys.
@@ -173,7 +173,7 @@ export class Client {
      * Calling expire with a non-positive timeout value will result in the being deleted rather
      * than expired.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-expire
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-expire
      *
      * @param key - key to set the time to live of
      * @param seconds - value to set the time to live of the key to (in seconds)
@@ -184,7 +184,7 @@ export class Client {
     /**
      * Returns the remaining time to live of a key that has a timeout.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-ttl
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-ttl
      *
      * @param key - the key to get the time to live of
      * @returns a promise that resolves to the time to live of the key, in seconds.
@@ -194,7 +194,7 @@ export class Client {
     /**
      * Removes the existing timeout on a key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-persist
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-persist
      *
      * @param key - the key to remove the timeout of.
      * @returns a promise that resolves to true if the operation succeeded, false otherwise.
@@ -206,7 +206,7 @@ export class Client {
      *
      * If the key exists but does not hold a list, the returned promise will be rejected.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-lpush
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-lpush
      *
      * @param key - key holding the list to prepend to
      * @param values - values to prepend to the list
@@ -219,7 +219,7 @@ export class Client {
      *
      * If the key exists but does not hold a list, the returned promise will be rejected.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-rpush
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-rpush
      *
      * @param key - key holding the list to append to
      * @param values - values to append to the list
@@ -230,7 +230,7 @@ export class Client {
     /**
      * Removes and returns the value at the head of the list stored at key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-lpop
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-lpop
      *
      * @param key - key holding the list to pop the head of
      * @returns a promise that resolves to the value that was popped.
@@ -240,7 +240,7 @@ export class Client {
     /**
      * Removes and returns the value at the tail of the list stored at key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-rpop
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-rpop
      *
      * @param key - key holding the list to pop the tail of
      * @returns a promise that resolves to the value that was popped.
@@ -253,7 +253,7 @@ export class Client {
      * The offsets are zero-based. These offsets can be negative numbers indicating
      * offsets starting at the end of the list.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-lrange
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-lrange
      *
      * @param key - key holding the list to get the range of
      * @param start - index of the first element to return
@@ -268,7 +268,7 @@ export class Client {
      * The offsets are zero-based. These offsets can be negative numbers indicating
      * offsets starting at the end of the list.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-lindex
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-lindex
      *
      * @param key - key holding the list to get the element of
      * @param index - index of the element to get
@@ -279,7 +279,7 @@ export class Client {
     /**
      * Sets the value of an element in the list stored at key to new value.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-lset
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-lset
      *
      * @param key - key holding the list to set the element of
      * @param index - index of the element to set
@@ -295,7 +295,7 @@ export class Client {
      * If the `count` is 0, all occurrences of `value` are removed.
      * If the `count` is negative, elements are removed from the tail of the list (from right to left).
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-lrem
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-lrem
      *
      * @param key - key holding the list to remove the element of
      * @param count - the number of elements matching the value to remove
@@ -309,7 +309,7 @@ export class Client {
      *
      * If the key does not exist, it is interpreted as an empty list and 0 is returned.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-llen
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-llen
      *
      * @param key - key holding the list to get the length  of
      * @returns a promise that resolves to the length of the list.
@@ -322,7 +322,7 @@ export class Client {
      * If the key does not exist, a new key holding a hash is created.
      * If the field already exists, it is overwritten.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-hset
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-hset
      *
      * @param key - key holding the hash to set the field's value of
      * @param field - field to set the value of
@@ -337,7 +337,7 @@ export class Client {
      * If the key does not exist, a new key holding a hash is created.
      * If the field already exists, the returned promise will be rejected.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-hsetnx
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-hsetnx
      *
      * @param key - key holding the hash to set the field's value of
      * @param field - field to set the value of
@@ -350,7 +350,7 @@ export class Client {
      *
      * Returns the value of the specified hash field.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-hget
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-hget
      *
      * @param key - key holding the hash to get the field's value of
      * @param field - field to get the value of
@@ -361,7 +361,7 @@ export class Client {
     /**
      * Deletes the specified fields from the hash stored at key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-hdel
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-hdel
      *
      * @param key - key holding the hash to delete the fields of
      * @param fields - fields to delete from the hash
@@ -372,7 +372,7 @@ export class Client {
     /**
      * Returns all fields and values of the hash stored at key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-hgetall
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-hgetall
      *
      * @param key - the key holding the hash to get the fields of
      * @returns a promise that resolves to an object of field/value pairs.
@@ -382,7 +382,7 @@ export class Client {
     /**
      * Returns all fields of the hash stored at key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-hkeys
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-hkeys
      *
      * @param key - the key holding the hash to get the fields of
      * @returns a promise that resolves to an array of field names.
@@ -392,7 +392,7 @@ export class Client {
     /**
      * Returns all values of the hash stored at key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-hvals
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-hvals
      *
      * @param key - the key holding the hash to get the fields' values of
      * @returns a promise that resolves to an array of field values.
@@ -402,7 +402,7 @@ export class Client {
     /**
      * Return the number of fields contained in the hash stored at key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-hlen
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-hlen
      *
      * @param key - the key holding the hash to get the number of fields of
      * @returns a promise that resolves to the number of fields in the hash.
@@ -416,7 +416,7 @@ export class Client {
      * If the field does not exist, it is set to 0 before the operation is performed.
      * If the field does not hold a nummerical value, the returned promise will be rejected.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-hincrby
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-hincrby
      *
      * @param key - the key holding the hash to get the number of fields of
      * @param field - the hash's field to increment the value of
@@ -431,7 +431,7 @@ export class Client {
      * Specified elements that are already a member of the set are ignored.
      * If the key does not exist, a new set is created before adding the specified elements.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-sadd
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-sadd
      *
      * @param key - the key holding the set to add a member to
      * @param members - the members to add to the set
@@ -445,7 +445,7 @@ export class Client {
      * Specified members that are not a member of this set are ignored.
      * If key does not exist, it is treated as an empty set and this command returns 0.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-srem
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-srem
      *
      * @param key - the key holding the set to remove a member from
      * @param members - the members to remove from the set
@@ -456,7 +456,7 @@ export class Client {
     /**
      * Returns whether or not the specified member is a member of the set stored at key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-sismembers
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-sismembers
      *
      * @param key - the key holding the set to check the belonging of
      * @param member - the member to check the belonging of
@@ -467,7 +467,7 @@ export class Client {
     /**
      * Returns the members of the set stored at key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-smembers
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-smembers
      *
      * @param key - the key holding the set to get the members of
      * @returns a promise that resolves to an array of members in the set.
@@ -477,7 +477,7 @@ export class Client {
     /**
      * Returns a random member of the set value stored at key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-srandmember
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-srandmember
      *
      * @param key - the key holding the set to get the random member of
      * @returns a promise that resolves to a random member of the set.
@@ -487,7 +487,7 @@ export class Client {
     /**
      * Pops a random member from the set stored at key.
      *
-     * https://k6.io/docs/javascript-api/k6-redis/client/client-spop
+     * https://k6.io/docs/javascript-api/k6-experimental/redis/client/client-spop
      *
      * @param key - the key holding the set to pop the random member of
      * @returns a promise that resolves to the popped member.
@@ -498,7 +498,7 @@ export class Client {
 /**
  * Options for configuring the redis Client.
  *
- * https://k6.io/docs/javascript-api/k6-redis/options
+ * https://k6.io/docs/javascript-api/k6-experimental/redis/options
  */
 export interface Options {
     /**

k6/experimental/tracing.d.ts

@@ -0,0 +1,206 @@
+/**
+ * This module provides ways to instrument k6 scripts HTTP calls with tracing information.
+ *
+ * It most notably exposes an `instrumentHTTP` function that can be used to wrap the `http` module's
+ * function calls with tracing information. It also exposes a `Client` class that can be used to
+ * instrument HTTP calls in a more fine-grained way.
+ *
+ * https://k6.io/docs/javascript-api/k6-experimental/tracing/
+ */
+
+import { RefinedParams, RefinedResponse, RequestBody, ResponseType } from '../http';
+
+/**
+ * The instrumentHTTP function instruments the k6 http module
+ * with tracing capabilities. It will transparently replace each
+ * of the k6 http module functions with its instrumented
+ * counterpart, in place.
+ *
+ * instrumentHTTP can only be called in the init context of the script.
+ *
+ * @param options - The options to use when instrumenting the http module.
+ */
+export function instrumentHTTP(options: Options): void;
+
+/**
+ * Client is an HTTP client class that attaches tracing information
+ * to its requests.
+ *
+ * It lets users include a tracing context in their HTTP requests
+ * so that tracing backends (such as Grafana Tempo) can incorporate
+ * their results.
+ *
+ * https://k6.io/docs/javascript-api/k6-experimental/tracing/client/
+ */
+export class Client {
+    protected __brand: never;
+
+    /**
+     * Instantiates a new tracing Client.
+     *
+     * @param options - The options to use for this Client.
+     */
+    constructor(options: Options);
+
+    /**
+     * Performs a DELETE request instrumented with trace context
+     * headers.
+     *
+     * @param url - Request URL.
+     * @param body - Discouraged. Request body. Object form encoded.
+     * @param params - Request parameters.
+     * @returns Resulting response.
+     */
+    del<RT extends ResponseType | undefined>(
+        url: string | HttpURL,
+        body?: RequestBody | null,
+        params?: RefinedParams<RT> | null
+    ): RefinedResponse<RT>;
+
+    /**
+     * Performs a HEAD request instrumented with trace context headers.
+     *
+     * @param url - Request URL.
+     * @param params - Request parameters.
+     * @returns Resulting response.
+     */
+    head<RT extends ResponseType | undefined>(
+        url: string | HttpURL,
+        params?: RefinedParams<RT> | null
+    ): RefinedResponse<RT>;
+
+    /**
+     * Performs a GET request instrumented with trace context headers.
+     *
+     * @param url - Request URL.
+     * @param params - Request parameters.
+     * @returns Resulting response.
+     */
+    get<RT extends ResponseType | undefined>(
+        url: string | HttpURL,
+        params?: RefinedParams<RT> | null
+    ): RefinedResponse<RT>;
+
+    /**
+     * Performs an OPTIONS request instrumented with trace context headers.
+     *
+     * @param url - Request URL.
+     * @param body - Request body. Object form encoded.
+     * @param params - Request parameters.
+     * @returns Resulting response.
+     */
+    options<RT extends ResponseType | undefined>(
+        url: string | HttpURL,
+        body?: RequestBody | null,
+        params?: RefinedParams<RT> | null
+    ): RefinedResponse<RT>;
+
+    /**
+     * Performs a PATCH request instrumented with trace context headers.
+     *
+     * @param url - Request URL.
+     * @param body - Request body. Object form encoded.
+     * @param params - Request parameters.
+     * @returns Resulting response.
+     */
+    patch<RT extends ResponseType | undefined>(
+        url: string | HttpURL,
+        body?: RequestBody | null,
+        params?: RefinedParams<RT> | null
+    ): RefinedResponse<RT>;
+
+    /**
+     * Performs a POST request instrumented with trace context headers.
+     *
+     * @param url - Request URL.
+     * @param body - Request body. Object form encoded.
+     * @param params - Request parameters.
+     * @returns Resulting response.
+     */
+    post<RT extends ResponseType | undefined>(
+        url: string | HttpURL,
+        body?: RequestBody | null,
+        params?: RefinedParams<RT> | null
+    ): RefinedResponse<RT>;
+
+    /**
+     * Performs a PUT request instrumented with trace context headers.
+     *
+     * @param url - Request URL.
+     * @param body - Request body. Object form encoded.
+     * @param params - Request parameters.
+     * @returns Resulting response.
+     */
+    put<RT extends ResponseType | undefined>(
+        url: string | HttpURL,
+        body?: RequestBody | null,
+        params?: RefinedParams<RT> | null
+    ): RefinedResponse<RT>;
+
+    /**
+     * Performs a HTTP request instrumented with trace context headers.
+     *
+     * @param method - HTTP method.
+     * @param url - Request URL.
+     * @param body - Request body. Object form encoded.
+     * @param params - Request parameters.
+     * @returns Resulting response.
+     */
+    request<RT extends ResponseType | undefined>(
+        method: string,
+        url: string | HttpURL,
+        body?: RequestBody | null,
+        params?: RefinedParams<RT> | null
+    ): RefinedResponse<RT>;
+
+    /**
+     * The asyncRequest method starts the process of performing a HTTP request
+     * asynchronously, returning a promise which is fulfilled once the response
+     * is available. The performed request is instrumented with trace context
+     * headers.
+     *
+     * @param method - HTTP method.
+     * @param url - Request URL.
+     * @param body - Request body. Object form encoded.
+     * @param params - Request parameters.
+     * @returns Resulting response.
+     */
+    asyncRequest<RT extends ResponseType | undefined>(
+        method: string,
+        url: string | HttpURL,
+        body?: RequestBody | null,
+        params?: RefinedParams<RT> | null
+    ): Promise<RefinedResponse<RT>>;
+}
+
+/**
+ * The Options object allows configuring the tracing instrumentation behavior.
+ *
+ * https://k6.io/docs/javascript-api/k6-experimental/tracing/options/
+ */
+export interface Options {
+    /**
+     * The trace context propagation format.
+     *
+     * Currently supported: `w3c` and `jaeger`.
+     *
+     * Defaults to `w3c`.
+     */
+    propagator: 'w3c' | 'jaeger';
+
+    /**
+     * The probability of each request having
+     * its `sampled` flag set to true.
+     * Its value should be within the `0 <= n <= 100` bounds.
+     *
+     * Defaults to `100`.
+     */
+    sampling?: number;
+}
+
+/**
+ * Returned value from http.url method.
+ */
+export interface HttpURL {
+    __brand: "http-url";
+}

k6/experimental/websockets.d.ts

@@ -1,6 +1,10 @@
+import { CookieJar } from '../http';
+
 /**
  * This module provides an experimental implementation of the WebSocket API
  * for k6.
+ *
+ * https://k6.io/docs/javascript-api/k6-experimental/websockets/
  */
 
 /**
@@ -37,13 +41,17 @@ export class WebSocket {
 
     /**
      * The Websocket constructor returns a newly created WebSocket object.
+     * https://k6.io/docs/javascript-api/k6-experimental/websockets/websocket/
      *
      * @param url - The URL to which to connect; this should be the URL to which the WebSocket server will respond.
+     * @param protocols - Either a single protocol string or an array of protocol strings. The param is reserved for future use and will be presently ignored.
+     * @param params - Used for setting various WebSocket connection parameters such as headers, cookie jar, compression, etc.
      */
-    constructor(url: string);
+    constructor(url: string, protocols?: null, params?: Params | null);
 
     /**
      * Enqueues data to be transmitted to the server over the WebSocket connection.
+     * https://k6.io/docs/javascript-api/k6-experimental/websockets/websocket/websocket-send/
      *
      * @param data - the data to send to the server
      */
@@ -52,16 +60,91 @@ export class WebSocket {
     /**
      * Bind event names to event handlers to be executed when their
      * respective event is received by the server.
+     * https://k6.io/docs/javascript-api/k6-experimental/websockets/websocket/websocket-addeventlistener/
      *
      * @param event - the event to listen for
      * @param listener - the callback to invoke when the event is emitted
      */
-    addEventListener(event: EventName, listener: (message: MessageEvent) => void): void;
+    addEventListener(event: EventName, listener: (event: MessageEvent | ErrorEvent) => void): void;
 
     /**
      * Closes the WebSocket connection or connection attempt, if any.
+     * https://k6.io/docs/javascript-api/k6-experimental/websockets/websocket/websocket-close/
+     *
+     * @param code - An integer WebSocket connection close code value indicating a reason for closure.
+     * @param reason - A human-readable string WebSocket connection close reason. No longer than 123 bytes of UTF-8 text.
+     */
+    close(code?: number, reason?: string): void;
+
+    /**
+     * Sends a ping message over the WebSocket connection.
+     * https://k6.io/docs/javascript-api/k6-experimental/websockets/websocket/websocket-ping/
+     */
+    ping(): void;
+
+    /**
+     * Sets an event handler which is invoked when a message event happens.
+     * https://k6.io/docs/javascript-api/k6-experimental/websockets/websocket/websocket-onmessage/
+     *
+     * @param event - the message event
      */
-    close(): void;
+    onmessage: (event?: MessageEvent) => void;
+
+    /**
+     * Sets an event handler which is invoked when the WebSocket connection's opens.
+     * https://k6.io/docs/javascript-api/k6-experimental/websockets/websocket/websocket-onopen/
+     */
+    onopen: () => void;
+
+    /**
+     * Sets an event handler which is invoked when the WebSocket connection's closes.
+     * https://k6.io/docs/javascript-api/k6-experimental/websockets/websocket/websocket-onclose/
+     */
+    onclose: () => void;
+
+    /**
+     * Sets an event handler which is invoked when errors occur.
+     * https://k6.io/docs/javascript-api/k6-experimental/websockets/websocket/websocket-onerror/
+     *
+     * @param event - the error event
+     */
+    onerror: (event?: ErrorEvent) => void;
+
+    /**
+     * Sets an event handler which is invoked when a ping message is received.
+     * https://k6.io/docs/javascript-api/k6-experimental/websockets/websocket/websocket-onping/
+     */
+    onping: () => void;
+
+    /**
+     * Sets an event handler which is invoked when a pong message is received.
+     * https://k6.io/docs/javascript-api/k6-experimental/websockets/websocket/websocket-onpong/
+     */
+    onpong: () => void;
+}
+
+/**
+ * k6 specific WebSocket parameters.
+ * https://k6.io/docs/javascript-api/k6-experimental/websockets/params/
+ */
+export interface Params {
+    /** Request headers. */
+    headers?: Record<string, string>;
+
+    /**
+     * Compression algorithm.
+     * If the option is left unset, it defaults to no compression.
+     */
+    compression?: CompressionAlgorithm;
+
+    /** The custom metric tags. */
+    tags?: Record<string, number | string | boolean>;
+
+    /**
+     * The cookie jar that will be used when making the initial HTTP request to establish the WebSocket connection.
+     * If empty, the default VU cookie jar will be used.
+     */
+    jar?: CookieJar;
 }
 
 /**
@@ -90,10 +173,15 @@ export enum ReadyState {
 }
 
 /**
- * Type alias describe the types of binary data that can be
+ * BinaryType describes the possible types of binary data that can be
  * transmitted over a Websocket connection.
  */
-export type BinaryType = 'arrayBuffer';
+export enum BinaryType  {
+    /**
+     * Binary data is returned in ArrayBuffer form. k6 supports only this type.
+     */
+    ArrayBuffer = 'ArrayBuffer'
+}
 
 /**
  * EventName describes the possible events that can be emitted
@@ -101,7 +189,7 @@ export type BinaryType = 'arrayBuffer';
  */
 export enum EventName {
     /**
-     * Event fired when the connection is opened and ready to communcate.
+     * Event fired when the connection is opened and ready to communicate.
      */
     Open = 'open',
 
@@ -119,10 +207,20 @@ export enum EventName {
      * Event fired when a message has been received from the server.
      */
     Message = 'message',
+
+    /**
+     * Event fired when a ping message has been received from the server.
+     */
+    Ping = 'ping',
+
+    /**
+     * Event fired when a pong message has been received from the server.
+     */
+    Pong = 'pong',
 }
 
 /**
- * MessageEvent is a simple class that holds the data of a message received from the server.
+ * MessageEvent is a simple interface that holds the data of a message received from the server.
  */
 export interface MessageEvent {
     /**
@@ -136,9 +234,9 @@ export interface MessageEvent {
     type: MessageType;
 
     /**
-     * The time when the message was received.
+     * The read-only property that returns the time (in milliseconds) at which the event was created.
      */
-    time: number;
+    timestamp: number;
 }
 
 /**
@@ -174,3 +272,34 @@ export enum MessageType {
      */
     PongMessage = 10,
 }
+
+/**
+ * ErrorEvent is a simple interface that holds the data of an error event.
+ */
+export interface ErrorEvent {
+    /**
+     * the type of the event.
+     */
+    type: MessageType;
+
+    /**
+     * The read-only property that returns the error message.
+     */
+    error: string;
+
+    /**
+     * The read-only property that returns the time (in milliseconds) at which the event was created.
+     */
+    timestamp: number;
+}
+
+/**
+ * CompressionAlgorithm describes the possible compression algorithms.
+ */
+export enum CompressionAlgorithm  {
+    /**
+     * Deflate compression algorithm.
+     * k6 supports only this compression algorithm.
+     */
+    Deflate = 'deflate'
+}

k6/http.d.ts

@@ -123,6 +123,26 @@ export function request<RT extends ResponseType | undefined>(
     params?: RefinedParams<RT> | null
 ): RefinedResponse<RT>;
 
+/**
+ * Make async request.
+ * https://k6.io/docs/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 });
+ */
+export function asyncRequest<RT extends ResponseType | undefined>(
+    method: string,
+    url: string | HttpURL,
+    body?: RequestBody | null,
+    params?: RefinedParams<RT> | null
+): Promise<RefinedResponse<RT>>;
+
 /**
  * Batch multiple HTTP requests together,
  * to issue them in parallel over multiple TCP connections.
@@ -903,6 +923,26 @@ declare namespace http {
         params?: RefinedParams<RT> | null
     ): RefinedResponse<RT>;
 
+    /**
+     * Make async request.
+     * https://k6.io/docs/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://k6.io/docs/using-k6/http-requests/#url-grouping

k6/index.d.ts

@@ -1,8 +1,9 @@
-// Type definitions for k6 0.41
+// Type definitions for k6 0.43
 // Project: https://k6.io/docs/
 // Definitions by: na-- <https://github.com/na-->
 //                 Mihail Stoykov <https://github.com/MStoykov>
 //                 Ivan <https://github.com/codebien>
+//                 Ivan Mirić <https://github.com/imiric>
 //                 Théo Crevon <https://github.com/oleiade>
 //                 Oleg Bespalov <https://github.com/olegbespalov>
 //                 Pepe Cano <https://github.com/ppcano>
@@ -42,6 +43,7 @@ import './metrics';
 import './options';
 import './experimental/redis';
 import './experimental/timers';
+import './experimental/tracing';
 import './experimental/websockets';
 import './ws';
 import './net/grpc';

k6/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/k6",
-    "version": "0.41.0",
+    "version": "0.43.0",
     "description": "TypeScript definitions for k6",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6",
     "license": "MIT",
@@ -20,6 +20,11 @@
             "url": "https://github.com/codebien",
             "githubUsername": "codebien"
         },
+        {
+            "name": "Ivan Mirić",
+            "url": "https://github.com/imiric",
+            "githubUsername": "imiric"
+        },
         {
             "name": "Théo Crevon",
             "url": "https://github.com/oleiade",
@@ -50,6 +55,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "623e25848b2cb5c033b811abcdec10262a661310553614b82b48c1e57e36a736",
-    "typeScriptVersion": "4.1"
+    "typesPublisherContentHash": "9a5f8c5ed0a28eaa972298a4b9dbd230251a9bde3528c3f1531dfad264024ad0",
+    "typeScriptVersion": "4.2"
 }