Skip to content

Commit d176231

Browse files
committed
grpc-js: Document recently-added channel options
1 parent ea1a266 commit d176231

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

packages/grpc-js/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ Many channel arguments supported in `grpc` are not supported in `@grpc/grpc-js`.
5656
- `grpc.max_send_message_length`
5757
- `grpc.max_receive_message_length`
5858
- `grpc.enable_http_proxy`
59+
- `grpc.default_compression_algorithm`
60+
- `grpc.enable_channelz`
61+
- `grpc-node.max_session_memory`
5962
- `channelOverride`
6063
- `channelFactoryOverride`
6164

packages/grpc-js/src/channel-options.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ export interface ChannelOptions {
3636
'grpc.max_send_message_length'?: number;
3737
'grpc.max_receive_message_length'?: number;
3838
'grpc.enable_http_proxy'?: number;
39+
/* http_connect_target and http_connect_creds are used for passing data
40+
* around internally, and should not be documented as public-facing options
41+
*/
3942
'grpc.http_connect_target'?: string;
4043
'grpc.http_connect_creds'?: string;
4144
'grpc.default_compression_algorithm'?: CompressionAlgorithms;

0 commit comments

Comments
 (0)