@types/k6 0.44.2 → 0.45.0

k6/experimental/browser/request.d.ts

@@ -1,101 +1,101 @@
-import { ResourceType, ResourceTiming } from "./";
-import { Response } from "./response";
-import { Frame } from "./frame";
+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>;
+    /**
+     * 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;
+    /**
+     * @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 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 }>;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * @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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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 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 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;
+    /**
+     * 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;
+    /**
+     * URL of the request.
+     * @returns request URL
+     */
+    url(): string;
 }

k6/experimental/browser/response.d.ts

@@ -1,115 +1,115 @@
 import { SecurityDetailsObject } from './';
-import { Request } from "./request";
-import { Frame } from "./frame";
+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;
+    /**
+     * 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

@@ -4,10 +4,10 @@
  * 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;
+    /**
+     * 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

@@ -1,13 +1,13 @@
-import { PageFunction } from ".";
-import { JSHandle } from "./js_handle";
+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;
+    /**
+     * Get the URL of the web worker.
+     * @return The URL of the web worker.
+     */
+    url(): string;
 }

k6/experimental/grpc.d.ts

@@ -0,0 +1,154 @@
+// === Response ===
+// ----------------
+
+/**
+ * gRPC response.
+ */
+export interface Response {
+    status: number;
+
+    message: object;
+
+    headers: object;
+
+    trailers: object;
+
+    error: object;
+}
+
+export interface ConnectParams {
+    plaintext?: boolean;
+
+    reflect?: boolean;
+
+    timeout?: string | number;
+
+    maxReceiveSize?: number;
+
+    maxSendSize?: number;
+}
+
+export interface Params {
+    /**
+     * @deprecated Use metadata instead.
+     */
+    headers?: object;
+
+    metadata?: object;
+
+    tags?: object;
+
+    timeout?: string | number;
+}
+
+export interface GrpcError {
+    code: number;
+    details: string[] | object[];
+    message: string;
+}
+
+/**
+ * This module provides classes for Remote Procedure Calls over HTTP/2.
+ * https://k6.io/docs/javascript-api/k6-experimental/grpc/
+ */
+declare namespace grpc {
+    /**
+     * gRPC client to interact with a gRPC server.
+     * https://k6.io/docs/javascript-api/k6-experimental/grpc/client/
+     */
+    class Client {
+        protected __brand: never;
+
+        constructor();
+
+        /** Opens a connection to a gRPC server. */
+        connect(address: string, params?: ConnectParams): void;
+
+        /** Loads and parses the protocol buffer descriptors. */
+        load(importPaths: string[], ...protoFiles: string[]): void;
+
+        /** Loads a protoset and parses the protocol buffer descriptors */
+        loadProtoset(protosetPath: string): void;
+
+        /** Invokes an unary RPC request. */
+        invoke(url: string, request: object, params?: Params): Response;
+
+        /** Close the connection. */
+        close(): void;
+    }
+
+    /**
+     * StreamEvent describes the possible events that can be emitted
+     * by a gRPC stream.
+     */
+    enum StreamEvent {
+        /**
+         * Event fired when data has been received from the server.
+         */
+        Data = 'data',
+
+        /**
+         * Event fired when a stream has been closed due to an error.
+         */
+        Error = 'error',
+
+        /**
+         * Event fired when the stream closes.
+         */
+        End = 'end',
+    }
+
+    /**
+     * Stream allows you to use streaming RPCs.
+     */
+    class Stream {
+        /**
+         * The gRPC stream constructor, representing a single gRPC stream.
+         *
+         * @param client - the gRPC client to use, it must be connected.
+         * @param url - the RPC method to call.
+         * @param params - the parameters to use for the RPC call.
+         */
+        constructor(client: Client, url: string, params?: Params);
+
+        /**
+         * Set up handler functions for various events on the gRPC stream.
+         *
+         * @param event - the event to listen for
+         * @param listener - the callback to invoke when the event is emitted
+         */
+        on(event: StreamEvent, listener: (data: object | GrpcError | undefined) => void): void;
+
+        /**
+         * Writes a request to the stream.
+         *
+         * @param request - the request (message) to send to the server
+         */
+        write(request: object): void;
+
+        /**
+         * Signals to the server that the client has finished sending messages.
+         */
+        end(): void;
+    }
+
+    const StatusOK: number;
+    const StatusCanceled: number;
+    const StatusUnknown: number;
+    const StatusInvalidArgument: number;
+    const StatusDeadlineExceeded: number;
+    const StatusNotFound: number;
+    const StatusAlreadyExists: number;
+    const StatusPermissionDenied: number;
+    const StatusResourceExhausted: number;
+    const StatusFailedPrecondition: number;
+    const StatusAborted: number;
+    const StatusOutOfRange: number;
+    const StatusUnimplemented: number;
+    const StatusInternal: number;
+    const StatusUnavailable: number;
+    const StatusDataLoss: number;
+    const StatusUnauthenticated: number;
+}
+
+export default grpc;