From d1762316e279d9a0dd224ca0a2eafc843f6a8bda Mon Sep 17 00:00:00 2001 From: Michael Lumish Date: Fri, 7 Jan 2022 12:21:12 -0800 Subject: [PATCH] grpc-js: Document recently-added channel options --- packages/grpc-js/README.md | 3 +++ packages/grpc-js/src/channel-options.ts | 3 +++ 2 files changed, 6 insertions(+) diff --git a/packages/grpc-js/README.md b/packages/grpc-js/README.md index 4799b0f4..71ec937e 100644 --- a/packages/grpc-js/README.md +++ b/packages/grpc-js/README.md @@ -56,6 +56,9 @@ Many channel arguments supported in `grpc` are not supported in `@grpc/grpc-js`. - `grpc.max_send_message_length` - `grpc.max_receive_message_length` - `grpc.enable_http_proxy` + - `grpc.default_compression_algorithm` + - `grpc.enable_channelz` + - `grpc-node.max_session_memory` - `channelOverride` - `channelFactoryOverride` diff --git a/packages/grpc-js/src/channel-options.ts b/packages/grpc-js/src/channel-options.ts index e1c16d12..68831722 100644 --- a/packages/grpc-js/src/channel-options.ts +++ b/packages/grpc-js/src/channel-options.ts @@ -36,6 +36,9 @@ export interface ChannelOptions { 'grpc.max_send_message_length'?: number; 'grpc.max_receive_message_length'?: number; 'grpc.enable_http_proxy'?: number; + /* http_connect_target and http_connect_creds are used for passing data + * around internally, and should not be documented as public-facing options + */ 'grpc.http_connect_target'?: string; 'grpc.http_connect_creds'?: string; 'grpc.default_compression_algorithm'?: CompressionAlgorithms;