@types/k6 0.44.1 → 0.44.3

k6/experimental/browser/request.d.ts

@@ -0,0 +1,101 @@
+import { ResourceType, ResourceTiming } from './';
+import { Response } from './response';
+import { Frame } from './frame';
+
+/**
+ * Request class represents requests which are sent by a page.
+ */
+export class Request {
+    /**
+     * An object with HTTP headers associated with the request. All header names are
+     * lower-case.
+     * @returns The headers object.
+     */
+    allHeaders(): Record<string, string>;
+
+    /**
+     * @returns the Frame that initiated this request
+     */
+    frame(): Frame;
+
+    /**
+     * An object with HTTP headers associated with the request. All header names are
+     * lower-case.
+     * @returns An object with HTTP headers associated with the request.
+     */
+    headers(): Record<string, string>;
+
+    /**
+     * An array with all the request HTTP headers. Unlike `Request.allHeaders()`,
+     * header names are not lower-cased. Headers with multiple entries, such as
+     * `Set-Cookie`, appear in the array multiple times.
+     * @returns An array of all the request HTTP headers.
+     */
+    headersArray(): Array<{ name: string; value: string }>;
+
+    /**
+     * Retuns the value of the header matching the name. The name is case insensitive.
+     * @param name Header name to retrieve value for.
+     * @returns The value of the header matching the name.
+     */
+    headerValue(name: string): string | null;
+
+    /**
+     * @returns a boolean stating whether the request is for a navigation
+     */
+    isNavigationRequest(): boolean;
+
+    /**
+     * Request's method (GET, POST, etc.)
+     * @returns request's method name
+     */
+    method(): string;
+
+    /**
+     * Contains the request's post body, if any.
+     * @returns request's post body
+     */
+    postData(): string;
+
+    /**
+     * Request's post body in a binary form, if any.
+     * @returns an ArrayBuffer with request's post data
+     */
+    postDataBuffer(): ArrayBuffer | null;
+
+    /**
+     * Contains the request's resource type as it was perceived by the rendering engine.
+     * ResourceType will be one of the following: `document`, `stylesheet`, `image`,
+     * `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`,
+     * `websocket`, `manifest`, `other`.
+     * @returns resource type name
+     */
+    resourceType(): ResourceType;
+
+    /**
+     * Returns the matching `Response` object, or `null` if the response was not received
+     * due to error.
+     * @returns The `Response` object, or `null` if the response was not received due to error.
+     */
+    response(): Response | null;
+
+    /**
+     * Returns resource size information for given request.
+     * @returns Resource size information for given request.
+     */
+    size(): { body: number; headers: number };
+
+    /**
+     * Returns resource timing information for given request. Most of the timing values
+     * become available upon the response, `responseEnd` becomes available when request
+     * finishes.
+     * @returns Resource timing information for given request.
+     */
+    timing(): ResourceTiming;
+
+    /**
+     * URL of the request.
+     * @returns request URL
+     */
+    url(): string;
+}

k6/experimental/browser/response.d.ts

@@ -0,0 +1,115 @@
+import { SecurityDetailsObject } from './';
+import { Request } from './request';
+import { Frame } from './frame';
+
+/**
+ * Response class represents responses which are received by page.
+ */
+export class Response {
+    /**
+     * An object with HTTP headers associated with the response. All header names are
+     * lower-case.
+     * @returns The headers object.
+     */
+    allHeaders(): Record<string, string>;
+
+    /**
+     * Returns the response body.
+     * @returns A buffer with response body.
+     */
+    body(): ArrayBuffer;
+
+    /**
+     * @returns the Frame that initiated this response
+     */
+    frame(): Frame;
+
+    /**
+     * An object with HTTP headers associated with the response. All header names are
+     * lower-case.
+     * @returns The headers object.
+     */
+    headers(): Record<string, string>;
+
+    /**
+     * An array with all the request HTTP response headers. Unlike `Response.headers()`, header
+     * names are not lower-cased. Headers with multiple entries, such as `Set-Cookie`,
+     * appear in the array multiple times.
+     * @returns An array of all the request HTTP headers.
+     */
+    headersArray(): Array<{ name: string; value: string }>;
+
+    /**
+     * Returns the value of the header matching the name. The name is case insensitive.
+     * If multiple headers have the same name (except `Set-Cookie`), they are returned
+     * as a list separated by ``,``. For `Set-Cookie`, the `\n` separator is used. If
+     * no headers are found, `null` is returned.
+     * @param name Header name to retrieve value for.
+     * @returns The header value for the given name.
+     */
+    headerValue(name: string): string | null;
+
+    /**
+     * Returns all values of the headers matching the name, for example `set-cookie`.
+     * The name is case insensitive.
+     * @param name Header name to retrieve values for.
+     * @returns An array of header values for the given name.
+     */
+    headerValues(name: string): string[];
+
+    /**
+     * Returns the JSON representation of response body. Throws if response body is not
+     * parsable via `JSON.parse`.
+     * @returns JSON representation of response body.
+     */
+    json(): any;
+
+    /**
+     * Contains a boolean stating whether the response was successful (status in the
+     * range 200-299) or not.
+     * @returns a boolean stating whether the response was successful
+     */
+    ok(): boolean;
+
+    /**
+     * The request that was used to produce the response.
+     * @returns the matching `Request` object
+     */
+    request(): Request;
+
+    /**
+     * Security details associated with this response.
+     * @returns A matching `SecurityDetailsObject`
+     */
+    securityDetails(): SecurityDetailsObject | null;
+
+    /**
+     * Returns the IP address and port of the server for this response.
+     * @returns The IP address and port of the server
+     */
+    serverAddr(): { ipAddress: string; port: number } | null;
+
+    /**
+     * Contains the status code of the response (e.g., 200 for a success).
+     * @returns the status code of the response
+     */
+    status(): number;
+
+    /**
+     * Contains the status text of the response (e.g. usually an "OK" for a success).
+     * @returns the status text of the response
+     */
+    statusText(): string;
+
+    /**
+     * The size of the response body and the headers.
+     * @returns The size of the response body and the headers.
+     */
+    size(): { body: number; headers: number };
+
+    /**
+     * Contains the URL of the response.
+     * @returns the URL of the response
+     */
+    url(): string;
+}

k6/experimental/browser/touchscreen.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Touchscreen provides an api for interacting with a virtual touchscreen. It
+ * operates in main-frame CSS pixels relative to the top-left corner of the
+ * viewport.
+ */
+export class Touchscreen {
+    /**
+     * Taps on the specified position (`x`,`y`), which internally dispatches a `touchstart` and `touchend` event.
+     * @param x The x position.
+     * @param y The y position.
+     */
+    tap(x: number, y: number): void;
+}

k6/experimental/browser/worker.d.ts

@@ -0,0 +1,13 @@
+import { PageFunction } from '.';
+import { JSHandle } from './js_handle';
+
+/**
+ * The Worker class represents a [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API).
+ */
+export class Worker {
+    /**
+     * Get the URL of the web worker.
+     * @return The URL of the web worker.
+     */
+    url(): string;
+}

k6/experimental/tracing.d.ts

@@ -54,7 +54,7 @@ export class Client {
     del<RT extends ResponseType | undefined>(
         url: string | HttpURL,
         body?: RequestBody | null,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -66,7 +66,7 @@ export class Client {
      */
     head<RT extends ResponseType | undefined>(
         url: string | HttpURL,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -78,7 +78,7 @@ export class Client {
      */
     get<RT extends ResponseType | undefined>(
         url: string | HttpURL,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -92,7 +92,7 @@ export class Client {
     options<RT extends ResponseType | undefined>(
         url: string | HttpURL,
         body?: RequestBody | null,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -106,7 +106,7 @@ export class Client {
     patch<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 class Client {
     post<RT extends ResponseType | undefined>(
         url: string | HttpURL,
         body?: RequestBody | null,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -134,7 +134,7 @@ export class Client {
     put<RT extends ResponseType | undefined>(
         url: string | HttpURL,
         body?: RequestBody | null,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -150,7 +150,7 @@ export class Client {
         method: string,
         url: string | HttpURL,
         body?: RequestBody | null,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): RefinedResponse<RT>;
 
     /**
@@ -169,7 +169,7 @@ export class Client {
         method: string,
         url: string | HttpURL,
         body?: RequestBody | null,
-        params?: RefinedParams<RT> | null
+        params?: RefinedParams<RT> | null,
     ): Promise<RefinedResponse<RT>>;
 }
 
@@ -202,5 +202,5 @@ export interface Options {
  * Returned value from http.url method.
  */
 export interface HttpURL {
-    __brand: "http-url";
+    __brand: 'http-url';
 }

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',
 }