Skip to content

Commit a70b271

Browse files
authored
Merge pull request #2284 from murgatroid99/library_comparison_update
Update information in README and PACKAGE-COMPARISON docs
2 parents a403ad7 + b07b74b commit a70b271

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

PACKAGE-COMPARISON.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Feature comparison of `grpc` and `@grpc/grpc-js` packages
22

3-
Feature | `grpc` | `@grpc/grpc-js`
3+
Feature | `grpc` (deprecated) | `@grpc/grpc-js`
44
--------|--------|----------
55
Client | :heavy_check_mark: | :heavy_check_mark:
66
Server | :heavy_check_mark: | :heavy_check_mark:
@@ -9,22 +9,22 @@ Streaming RPCs | :heavy_check_mark: | :heavy_check_mark:
99
Deadlines | :heavy_check_mark: | :heavy_check_mark:
1010
Cancellation | :heavy_check_mark: | :heavy_check_mark:
1111
Automatic Reconnection | :heavy_check_mark: | :heavy_check_mark:
12-
Per-message Compression | :heavy_check_mark: | only for response messages
12+
Per-message Compression | :heavy_check_mark: | :heavy_check_mark: (except messages sent by the server)
1313
Channel State | :heavy_check_mark: | :heavy_check_mark:
1414
JWT Access and Service Account Credentials | provided by the [Google Auth Library](https://www.npmjs.com/package/google-auth-library) | provided by the [Google Auth Library](https://www.npmjs.com/package/google-auth-library)
1515
Interceptors | :heavy_check_mark: | :heavy_check_mark:
1616
Connection Keepalives | :heavy_check_mark: | :heavy_check_mark:
1717
HTTP Connect Support | :heavy_check_mark: | :heavy_check_mark:
1818
Retries | :heavy_check_mark: | :x:
1919
Stats/tracing/monitoring | :heavy_check_mark: | :x:
20-
Load Balancing | :heavy_check_mark: | Pick first and round robin
20+
Load Balancing | :heavy_check_mark: | :heavy_check_mark:
2121
Initial Metadata Options | :heavy_check_mark: | only `waitForReady`
2222

2323
Other Properties | `grpc` | `@grpc/grpc-js`
2424
-----------------|--------|----------------
2525
Pure JavaScript Code | :x: | :heavy_check_mark:
26-
Supported Node Versions | >= 4 | ^8.13.0 or >=10.10.0
27-
Supported Electron Versions | All | >= 3
26+
Supported Node Versions | >= 4 and <=14 | ^8.13.0 or >=10.10.0
27+
Supported Electron Versions | <=11.2 | >= 3
2828
Supported Platforms | Linux, Windows, MacOS | All
2929
Supported Architectures | x86, x86-64, ARM7+ | All
3030

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@
55

66
For a comparison of the features available in these two libraries, see [this document](https://github.com/grpc/grpc-node/tree/master/PACKAGE-COMPARISON.md)
77

8-
### C-based Client and Server
8+
### Pure JavaScript Client and Server
99

10-
Directory: [`packages/grpc-native-core`](https://github.com/grpc/grpc-node/tree/[email protected]/packages/grpc-native-core) (lives in the `[email protected]` branch) (see here for installation information)
10+
Directory: [`packages/grpc-js`](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js)
1111

12-
npm package: [grpc](https://www.npmjs.com/package/grpc).
12+
npm package: [@grpc/grpc-js](https://www.npmjs.com/package/@grpc/grpc-js)
1313

14-
This is the existing, feature-rich implementation of gRPC using a C++ addon. It works on all LTS versions of Node.js on most platforms that Node.js runs on.
14+
This library implements the core functionality of gRPC purely in JavaScript, without a C++ addon. It works on the latest versions of Node.js on all platforms that Node.js runs on.
1515

16-
### Pure JavaScript Client
16+
### C-based Client and Server (deprecated)
1717

18-
Directory: [`packages/grpc-js`](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js)
18+
Directory: [`packages/grpc-native-core`](https://github.com/grpc/grpc-node/tree/[email protected]/packages/grpc-native-core) (lives in the `[email protected]` branch) (see here for installation information)
1919

20-
npm package: [@grpc/grpc-js](https://www.npmjs.com/package/@grpc/grpc-js)
20+
npm package: [grpc](https://www.npmjs.com/package/grpc).
2121

22-
This library implements the core functionality of gRPC purely in JavaScript, without a C++ addon. It works on the latest version of Node.js on all platforms that Node.js runs on.
22+
This is the deprecated implementation of gRPC using a C++ addon. It works on versions of Node.js up to 14 on most platforms that Node.js runs on.
2323

2424
## Other Packages
2525

0 commit comments

Comments
 (0)