@types/k6 0.42.0 → 0.43.0

k6/README.md

@@ -8,7 +8,7 @@ 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: Tue, 20 Dec 2022 10:32:45 GMT
+ * Last updated: Mon, 20 Feb 2023 16:02:34 GMT
  * Dependencies: none
  * Global values: none
 

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/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,4 +1,4 @@
-// Type definitions for k6 0.42
+// Type definitions for k6 0.43
 // Project: https://k6.io/docs/
 // Definitions by: na-- <https://github.com/na-->
 //                 Mihail Stoykov <https://github.com/MStoykov>
@@ -43,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.42.0",
+    "version": "0.43.0",
     "description": "TypeScript definitions for k6",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6",
     "license": "MIT",
@@ -55,6 +55,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "bd01e241b4cf17bb45abc7afdebf3e34a2071064217df356345d3378b4d5b7ae",
+    "typesPublisherContentHash": "9a5f8c5ed0a28eaa972298a4b9dbd230251a9bde3528c3f1531dfad264024ad0",
     "typeScriptVersion": "4.2"
 }