Skip to content

Commit 1d99260

Browse files
authored
Add gRPC blockquote (#1229)
1 parent f116abd commit 1d99260

File tree

5 files changed

+32
-11
lines changed

5 files changed

+32
-11
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import Blockquote from 'components/shared/blockquote';
2+
import React from 'react';
3+
4+
const GrpcBlockquote = () => (
5+
<Blockquote mod="info">
6+
<h4>A module with streaming support exists</h4>
7+
<p>
8+
The new{' '}
9+
<a href="https://k6.io/docs/javascript-api/k6-experimental/grpc/">
10+
k6/experimental/grpc
11+
</a>{' '}
12+
module extends{' '}
13+
<a href="https://k6.io/docs/javascript-api/k6-net-grpc/">k6/net/grpc</a>{' '}
14+
to support{' '}
15+
<a href="https://k6.io/docs/javascript-api/k6-experimental/grpc/stream/">
16+
gRPC streaming
17+
</a>
18+
. We recommend using the new module.
19+
</p>
20+
</Blockquote>
21+
);
22+
23+
export default GrpcBlockquote;
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import GrpcBlockquote from './grpc-blockquote.view';
2+
3+
export default GrpcBlockquote;

src/components/templates/doc-page/doc-page-content/doc-page-content.view.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import Collapsible from 'components/shared/collapsible';
1212
import CryptoBlockquote from 'components/shared/crypto-blockquote';
1313
import DescriptionList from 'components/shared/description-list';
1414
import ExperimentalBlockquote from 'components/shared/experimental-blockquote';
15+
import GrpcBlockquote from 'components/shared/grpc-blockquote';
1516
import { HeadingLandmark } from 'components/shared/heading';
1617
import InstallationInstructions from 'components/shared/installation-instructions';
1718
import LdScript from 'components/shared/ld-script';
@@ -45,6 +46,7 @@ const componentsForNativeReplacement = {
4546
BlockingAwsBlockquote,
4647
CryptoBlockquote,
4748
WsBlockquote,
49+
GrpcBlockquote,
4850
InstallationInstructions,
4951
Tooltip,
5052
BNIT,

src/data/markdown/docs/02 javascript api/11 k6-net-grpc.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,10 @@ title: "k6/net/grpc"
33
excerpt: "k6 gRPC API"
44
---
55

6-
The `k6/net/grpc` module, added in k6 v0.29.0, provides a [gRPC](https://grpc.io/) client for Remote Procedure Calls (RPC) over HTTP/2.
6+
<GrpcBlockquote />
77

8-
<Blockquote mod='info'>
8+
The `k6/net/grpc` module provides a [gRPC](https://grpc.io/) client for Remote Procedure Calls (RPC) over HTTP/2.
99

10-
#### An extension with much better API exists
11-
12-
[xk6-grpc](https://github.com/grafana/xk6-grpc) implements gRPC streaming APIs.
13-
14-
Currently, it's available as an experimental module [`k6/experimental/grpc`](/javascript-api/k6-experimental/grpc/). It is also likely that it will at some point become part of the core of k6.
15-
</Blockquote>
1610

1711
| Class/Method | Description |
1812
|--------------|-------------|

src/data/markdown/docs/02 javascript api/11 k6-net-grpc/10-Client.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@ title: Client
33
excerpt: 'Client is a gRPC client that can interact with a gRPC server.'
44
---
55

6-
`Client` is a gRPC client that can interact with a gRPC server.
7-
8-
> ⚠️ **Note**: Only unary RPCs are currently supported, i.e. there is no support for client, server or bidirectional streaming.
6+
<GrpcBlockquote />
97

8+
`Client` is a gRPC client that can interact with a gRPC server. Only unary RPCs are currently supported in this module.
109

1110

1211
| Method | Description |

0 commit comments

Comments
 (0)