Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/experimentalbreadcrumb arrow grpcbreadcrumb arrow Response
Open source

Response

Caution

Starting on k6 v0.49, the experimental module k6/experimental/grpc has been graduated, and its functionality is now available in the k6/net/grpc module. The k6/experimental/grpc is deprecated and will be removed in v0.51.0.

To migrate your scripts, replace all k6/experimental/grpc imports with k6/net/grpc.

NameTypeDescription
Response.statusnumberThe response gRPC status code. Use the gRPC status constants to check equality.
Response.messageobjectThe successful protobuf message, serialized to JSON. Will be null if status !== grpc.StatusOK.
Response.headersobjectKey-value pairs representing all the metadata headers returned by the gRPC server.
Response.trailersobjectKey-value pairs representing all the metadata trailers returned by the gRPC server.
Response.errorobjectIf status !== grpc.StatusOK then the error protobuf message, serialized to JSON; otherwise null.

Example

JavaScript
JavaScript 
import grpc from 'k6/experimental/grpc';
import { check, sleep } from 'k6';

const client = new grpc.Client();
client.load(['definitions'], 'hello.proto');

export default () => {
  client.connect('grpcbin.test.k6.io:9001', {
    // plaintext: false
  });

  const data = { greeting: 'Bert' };
  const response = client.invoke('hello.HelloService/SayHello', data);

  check(response, {
    'status is OK': (r) => r && r.status === grpc.StatusOK,
  });

  client.close();
  sleep(1);
};