@types/k6 0.46.3 → 0.47.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: Thu, 14 Sep 2023 01:49:18 GMT
+ * Last updated: Tue, 10 Oct 2023 12:42:36 GMT
  * Dependencies: none
  * Global values: none
 

k6/experimental/browser.d.ts

@@ -603,47 +603,52 @@ export interface BrowserContext {
     browser(): Browser;
 
     /**
-     * Adds cookies into the `BrowserContext`.
+     * Adds {@link Cookie | cookies} into this {@link BrowserContext}.
+     *
+     * @param cookies The {@link Cookie | cookies} to add to this {@link BrowserContext}.
+     * @example
+     * ```js
+     * context.addCookies([
+     *   { name: 'foo', value: 'foovalue', sameSite: 'Lax', url: 'https://k6.io' },
+     *   { name: 'bar', value: 'barvalue', sameSite: 'Strict', domain: 'test.k6.io', path: '/bar' },
+     * ]);
+     * ```
      */
-    addCookies(
-        cookies: Array<{
-            name: string;
-
-            value: string;
-
-            /**
-             * either url or domain / path are required.
-             */
-            url?: string;
-
-            /**
-             * either url or domain / path are required.
-             */
-            domain?: string;
-
-            /**
-             * either url or domain / path are required.
-             */
-            path?: string;
-
-            /**
-             * Unix time in seconds.
-             */
-            expires?: number;
-
-            httpOnly?: boolean;
-
-            secure?: boolean;
-
-            sameSite?: "Strict" | "Lax" | "None";
-        }>,
-    ): void;
+    addCookies(cookies: Cookie[]): void;
 
     /**
-     * Clear the `BrowserContext`'s cookies.
+     * Clears the {@link Cookie | cookies} in this {@link BrowserContext}.
+     *
+     * @example
+     * ```js
+     * context.addCookies([{ name: 'foo', value: 'bar', url: 'https://k6.io' }]);
+     * context.cookies().length; // 1
+     * context.clearCookies();
+     * context.cookies().length; // 0
+     * ```
      */
     clearCookies(): void;
 
+    /**
+     * Retrieves the {@link Cookie | cookies} in this {@link BrowserContext} filtered by provided URLs,
+     * or all {@link Cookie | cookies} if no URLs are provided.
+     *
+     * @param urls URLs to filter {@link Cookie | cookies} by.
+     * @returns An array of {@link Cookie | cookies}.
+     * @example
+     * ```js
+     * // Get all cookies in the browser context
+     * const cookies = context.cookies();
+     *
+     * // Get all cookies for the specified URLs
+     * const cookies = context.cookies('https://k6.io', 'https://test.k6.io');
+     *
+     * // Get all cookies for the specified URLs and filter by name
+     * const cookies = context.cookies('https://k6.io', 'https://test.k6.io').filter(c => c.name === 'foo');
+     * ```
+     */
+    cookies(...urls: string[]): Cookie[];
+
     /**
      * Clears all permission overrides for the `BrowserContext`.
      */
@@ -772,6 +777,145 @@ export interface BrowserContext {
     ): Page | null;
 }
 
+/**
+ * {@link ConsoleMessage} objects are dispatched by page via the
+ * `page.on('console')` event. For each console message logged in the page,
+ * k6 browser delivers it to the registered handlers.
+ *
+ * ```js
+ * // Listen for all console log messages in the browser page and output them
+ * // in the test logs
+ * page.on('console', msg => console.log(msg.text()));
+ *
+ * // Listen for all console events and handle errors
+ * page.on('console', msg => {
+ *   if (msg.type() === 'error')
+ *     console.log(`Error text: "${msg.text()}"`);
+ * });
+ *
+ * // Deconstruct console log arguments
+ * await msg.args()[0].jsonValue(); // hello
+ * await msg.args()[1].jsonValue(); // 42
+ * ```
+ */
+export interface ConsoleMessage {
+    /**
+     * List of arguments passed to a `console` function call. See also
+     * `page.on('console')`.
+     */
+    args(): JSHandle[];
+
+    /**
+     * The page that produced this console message, if any.
+     */
+    page(): null | Page;
+
+    /**
+     * The text of the console message.
+     */
+    text(): string;
+
+    /**
+     * One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`,
+     * `'warning'`, `'dir'`, `'dirxml'`, `'table'`, `'trace'`, `'clear'`,
+     * `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`,
+     * `'profile'`, `'profileEnd'`, `'count'`, `'timeEnd'`.
+     */
+    type(): string;
+}
+
+/**
+ * {@link Cookie} represents a cookie in a {@link BrowserContext}.
+ *
+ * @see
+ * {@link BrowserContext} has methods to {@link BrowserContext.addCookies | add}, {@link BrowserContext.cookies | query} and {@link BrowserContext.clearCookies | clear} cookies.
+ */
+export interface Cookie {
+    /**
+     * The {@link Cookie | cookie}'s name.
+     *
+     * @defaultValue
+     * The default is `''`.
+     */
+    name: string;
+
+    /**
+     * The {@link Cookie | cookie}'s value.
+     *
+     * @defaultValue
+     * The default is `''`.
+     */
+    value: string;
+
+    /**
+     * The {@link Cookie | cookie}'s URL.
+     *
+     * Required unless one of {@link Cookie.domain | domain} or {@link Cookie.path | path} are specified.
+     */
+    url?: string;
+
+    /**
+     * The {@link Cookie | cookie}'s domain.
+     *
+     * Required unless one of {@link Cookie.url | url} or {@link Cookie.path | path} are specified.
+     */
+    domain?: string;
+
+    /**
+     * The {@link Cookie | cookie}'s path.
+     *
+     * Required unless one of {@link Cookie.url | url} or {@link Cookie.domain | domain} are specified.
+     *
+     * @defaultValue
+     * The default is `'/'`.
+     */
+    path?: string;
+
+    /**
+     * The {@link Cookie | cookie}'s expiration date as the number of seconds since the UNIX epoch.
+     *
+     * If omitted, the {@link Cookie | cookie} becomes a session cookie.
+     *
+     * @defaultValue
+     * The default is `-1`, meaning a session cookie.
+     */
+    expires?: number;
+
+    /**
+     * Whether the {@link Cookie | cookie} is http-only.
+     *
+     * @defaultValue
+     * The default is `false`.
+     */
+    httpOnly?: boolean;
+
+    /**
+     * Whether the {@link Cookie | cookie} is secure.
+     *
+     * @defaultValue
+     * The default is `false`.
+     */
+    secure?: boolean;
+
+    /**
+     * The {@link Cookie | cookie}'s same-site status.
+     *
+     * It can be one of `'Strict'`, `'Lax'`, or `'None'`.
+     *
+     * @defaultValue
+     * The default is `'Lax'`.
+     */
+    sameSite?: CookieSameSite;
+}
+
+/**
+ * CookieSameSite represents the same-site status of a {@link Cookie | cookie}.
+ *
+ * @defaultValue
+ * The default is `'Lax'`.
+ */
+export type CookieSameSite = "Strict" | "Lax" | "None";
+
 /**
  * ElementHandle represents an in-page DOM element.
  */
@@ -2461,6 +2605,28 @@ export interface Page {
      */
     mouse: Mouse;
 
+    /**
+     * Emitted when JavaScript within the page calls one of console API methods
+     * , e.g. `console.log` or `console.dir`. Also emitted if the page throws
+     * an error or a warning.
+     *
+     * The arguments passed into `console.log` are available on the
+     * {@link ConsoleMessage} event handler argument.
+     *
+     * **Usage**
+     *
+     * ```js
+     * page.on('console', msg => {
+     *   const values = [];
+     *   for (const arg of msg.args())
+     *     values.push(arg.jsonValue());
+     *   console.log(...values);
+     * });
+     * page.evaluate(() => console.log('hello', 5, { foo: 'bar' }));
+     * ```
+     */
+    on(event: "console", listener: (consoleMessage: ConsoleMessage) => void): void;
+
     /**
      * Returns the page that opened the current page. The first page that is
      * navigated to will have a null opener.

k6/experimental/grpc.d.ts

@@ -28,6 +28,11 @@ export interface ConnectParams {
      */
     reflect?: boolean;
 
+    /**
+     * Metadata to send with reflection request.
+     */
+    reflectMetadata?: object;
+
     /**
      * Connection timeout to use.
      */

k6/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for k6 0.46
+// Type definitions for k6 0.47
 // Project: https://k6.io/docs/
 // Definitions by: Mihail Stoykov <https://github.com/MStoykov>
 //                 Ivan <https://github.com/codebien>

k6/net/grpc.d.ts

@@ -28,6 +28,11 @@ export interface ConnectParams {
      */
     reflect?: boolean;
 
+    /**
+     * Metadata to send with reflection request.
+     */
+    reflectMetadata?: object;
+
     /**
      * Connection timeout to use.
      */

k6/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/k6",
-    "version": "0.46.3",
+    "version": "0.47.0",
     "description": "TypeScript definitions for k6",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6",
     "license": "MIT",
@@ -60,6 +60,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "7adc75fe3ab6a575e652d2a25bba71079e68f3751d3d268561f73356b442c089",
+    "typesPublisherContentHash": "b079f39833a2ebca3ed4f12e4348669f4051f51b63a4eaff08300e42a0ee50c7",
     "typeScriptVersion": "4.5"
 }