Skip to content

Commit

Permalink
More description changes
Browse files Browse the repository at this point in the history
  • Loading branch information
olegbespalov committed Jan 22, 2024
1 parent f2be224 commit bcc1c6b
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions docs/sources/next/javascript-api/k6-net-grpc/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'k6/net/grpc'
excerpt: 'k6 gRPC API'
description: 'k6 gRPC API'
weight: 11
---

Expand All @@ -19,9 +19,9 @@ The `k6/net/grpc` module provides a [gRPC](https://grpc.io/) client for Remote P
| [Response](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc/response) | Returned by RPC requests. |
| [Constants](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc/constants) | Define constants to distinguish between [gRPC Response](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc/response) statuses. |
| [Stream](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc/stream) | Creates a new GRPC stream. |
| [Stream.on(event, handler)](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc/stream/stream-on) | Adds a new listener to one of the possible stream events. |
| [Stream.on(event, handler)](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc/stream/stream-on) | Adds a new listener to one of the possible stream events. |
| [Stream.write(message)](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc/stream/stream-write) | Writes a message to the stream. |
| [Stream.end()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc/stream/stream-end) | Signals to the server that the client has finished sending. |
| [Stream.end()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc/stream/stream-end) | Signals to the server that the client has finished sending. |

## gRPC metrics

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Client
excerpt: 'Client is a gRPC client that can interact with a gRPC server.'
description: 'Client is a gRPC client that can interact with a gRPC server.'
weight: 10
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Client.close()'
excerpt: 'Close the connection to the gRPC service. Tear down all underlying connections.'
description: 'Close the connection to the gRPC service. Tear down all underlying connections.'
weight: 40
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Client.connect(address [,params])'
excerpt: 'Opens a connection to a gRPC server; will block until a connection is made or a connection error is thrown.'
description: 'Opens a connection to a gRPC server; will block until a connection is made or a connection error is thrown.'
weight: 20
slug: 'client-connect'
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Client.invoke(url, request [,params])'
excerpt: 'Invokes an unary RPC request to the given method.'
description: 'Invokes an unary RPC request to the given method.'
weight: 30
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Client.loadProtoset(protosetPath)'
slug: 'client-loadprotoset'
excerpt: 'Loads and parses the protoset file (serialized FileDescriptor set) so they are available to the client to marshal/unmarshal the correct request and response data structures for the RPC schema.'
description: 'Loads and parses the protoset file (serialized FileDescriptor set) so they are available to the client to marshal/unmarshal the correct request and response data structures for the RPC schema.'
weight: 11
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Client.load(importPaths, ...protoFiles)'
excerpt: 'Loads and parses the protocol buffer descriptors so they are available to the client to marshal/unmarshal the correct request and response data structures for the RPC schema.'
description: 'Loads and parses the protocol buffer descriptors so they are available to the client to marshal/unmarshal the correct request and response data structures for the RPC schema.'
weight: 10
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/next/javascript-api/k6-net-grpc/constants.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Constants'
excerpt: 'Define constants to distinguish between gRPC Response'
description: 'Define constants to distinguish between gRPC Response'
weight: 40
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/next/javascript-api/k6-net-grpc/params.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Params'
head_title: 'gRPC.params'
excerpt: 'Params is an object used by the gRPC methods that generate RPC requests.'
description: 'Params is an object used by the gRPC methods that generate RPC requests.'
weight: 20
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/next/javascript-api/k6-net-grpc/response.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Response'
head_title: 'gRPC.Response'
excerpt: 'The response object of a gRPC request.'
description: 'The response object of a gRPC request.'
weight: 30
---

Expand Down

0 comments on commit bcc1c6b

Please sign in to comment.