@types/k6 0.44.3 → 0.45.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: Fri, 16 Jun 2023 07:32:49 GMT
+ * Last updated: Mon, 19 Jun 2023 12:02:42 GMT
  * Dependencies: none
  * Global values: none
 

k6/execution.d.ts

@@ -101,9 +101,20 @@ declare namespace execution {
         idInTest: number;
 
         /**
-         * 	Hash to set or get VU tags.
+         * 	Map to set or get VU tags.
+         * 	@deprecated should use `metrics.tags` instead of just `tags`
          */
         tags: Record<string, number | string | boolean>;
+        metrics: {
+            /**
+             * 	Map to set or get VU tags.
+             */
+            tags: Record<string, number | string | boolean>;
+            /**
+             * 	Map to set or get VU metadata.
+             */
+            metadata: Record<string, number | string | boolean>;
+        }
     };
 }
 

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;

k6/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for k6 0.44
+// Type definitions for k6 0.45
 // Project: https://k6.io/docs/
 // Definitions by: na-- <https://github.com/na-->
 //                 Mihail Stoykov <https://github.com/MStoykov>
@@ -48,6 +48,7 @@ import './experimental/timers';
 import './experimental/tracing';
 import './experimental/webcrypto';
 import './experimental/websockets';
+import './experimental/grpc';
 import './ws';
 import './net/grpc';
 

k6/options.d.ts

@@ -242,6 +242,9 @@ export abstract class BaseScenario {
 
     /** Tags specific to this scenario. */
     tags?: { [name: string]: string };
+
+    /** Additional options for each scenario */
+    options?: ScenarioOptions;
 }
 
 /**
@@ -439,3 +442,8 @@ export type Scenario =
     | ConstantArrivalRateScenario
     | RampingArrivalRateScenario
     | ExternallyControlledScenario;
+
+export interface ScenarioOptions {
+    /** Browser specific options */
+    browser?: any;
+}

k6/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/k6",
-    "version": "0.44.3",
+    "version": "0.45.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": "361534b19bc50893282724e8e2785b8c69f23e9233af269e95c9050d7957d763",
+    "typesPublisherContentHash": "5b2bbba096263f0ef2834ce4ad15719492ad469e1ad3df1e19ecbd1a8bc532f9",
     "typeScriptVersion": "4.3"
 }