UNPKG

1.9 kBTypeScriptView Raw
1/**
2 * An interface that contains options used when initializing a Channel instance.
3 */
4export interface ChannelOptions {
5 'grpc.ssl_target_name_override'?: string;
6 'grpc.primary_user_agent'?: string;
7 'grpc.secondary_user_agent'?: string;
8 'grpc.default_authority'?: string;
9 'grpc.keepalive_time_ms'?: number;
10 'grpc.keepalive_timeout_ms'?: number;
11 'grpc.keepalive_permit_without_calls'?: number;
12 'grpc.service_config'?: string;
13 'grpc.max_concurrent_streams'?: number;
14 'grpc.initial_reconnect_backoff_ms'?: number;
15 'grpc.max_reconnect_backoff_ms'?: number;
16 'grpc.use_local_subchannel_pool'?: number;
17 'grpc.max_send_message_length'?: number;
18 'grpc.max_receive_message_length'?: number;
19 'grpc.enable_http_proxy'?: number;
20 'grpc.http_connect_target'?: string;
21 'grpc.http_connect_creds'?: string;
22 'grpc-node.max_session_memory'?: number;
23 [key: string]: any;
24}
25/**
26 * This is for checking provided options at runtime. This is an object for
27 * easier membership checking.
28 */
29export declare const recognizedOptions: {
30 'grpc.ssl_target_name_override': boolean;
31 'grpc.primary_user_agent': boolean;
32 'grpc.secondary_user_agent': boolean;
33 'grpc.default_authority': boolean;
34 'grpc.keepalive_time_ms': boolean;
35 'grpc.keepalive_timeout_ms': boolean;
36 'grpc.keepalive_permit_without_calls': boolean;
37 'grpc.service_config': boolean;
38 'grpc.max_concurrent_streams': boolean;
39 'grpc.initial_reconnect_backoff_ms': boolean;
40 'grpc.max_reconnect_backoff_ms': boolean;
41 'grpc.use_local_subchannel_pool': boolean;
42 'grpc.max_send_message_length': boolean;
43 'grpc.max_receive_message_length': boolean;
44 'grpc.enable_http_proxy': boolean;
45 'grpc-node.max_session_memory': boolean;
46};
47export declare function channelOptionsEqual(options1: ChannelOptions, options2: ChannelOptions): boolean;