@types/k6 1.1.1 → 1.3.0

k6/net/grpc/index.d.ts

@@ -104,6 +104,21 @@ export interface GrpcError {
     message: string;
 }
 
+/**
+ * Health check status values as defined by the gRPC Health Checking Protocol.
+ */
+export type HealthCheckStatus = "SERVING" | "NOT_SERVING" | "UNKNOWN";
+
+/**
+ * Response from a gRPC health check.
+ */
+export interface HealthCheckResponse {
+    /**
+     * The health status of the service.
+     */
+    Status: HealthCheckStatus;
+}
+
 /**
  * gRPC client to interact with a gRPC server.
  * https://grafana.com/docs/k6/latest/javascript-api/k6-net-grpc/client/
@@ -130,6 +145,15 @@ export class Client {
 
     /** Close the connection. */
     close(): void;
+
+    /**
+     * Performs a health check on the gRPC service.
+     * Uses the standard gRPC Health Checking Protocol.
+     *
+     * @param service - Optional service name to check. If not provided, checks overall server health.
+     * @returns The health check response
+     */
+    healthCheck(service?: string): HealthCheckResponse;
 }
 
 /**
@@ -215,4 +239,9 @@ export const StatusUnavailable: number;
 export const StatusDataLoss: number;
 export const StatusUnauthenticated: number;
 
+export const HealthCheckServing: HealthCheckStatus;
+export const HealthCheckNotServing: HealthCheckStatus;
+export const HealthCheckUnknown: HealthCheckStatus;
+export const HealthCheckServiceUnkown: HealthCheckStatus;
+
 export * as default from "k6/net/grpc";

k6/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/k6",
-    "version": "1.1.1",
+    "version": "1.3.0",
     "description": "TypeScript definitions for k6",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6",
     "license": "MIT",
@@ -34,6 +34,11 @@
             "name": "Joan López de la Franca Beltran",
             "githubUsername": "joanlopez",
             "url": "https://github.com/joanlopez"
+        },
+        {
+            "name": "Agnès Toulet",
+            "githubUsername": "AgnesToulet",
+            "url": "https://github.com/AgnesToulet"
         }
     ],
     "type": "module",
@@ -69,6 +74,6 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "cab96a60a1aff1fc779fe38bef4441c8b03f85e11e14c181e7a5e23e146b7e64",
-    "typeScriptVersion": "5.1"
+    "typesPublisherContentHash": "ee731b1f19868e1c260b125502af21d2ad85651007c16c914bde66d975a5081f",
+    "typeScriptVersion": "5.2"
 }