Cerbos JavaScript SDK
    Preparing search index...

    Interface ChannelOptions

    Advanced settings to configure a gRPC client.

    Index

    Properties

    "grpc-node.flow_control_window"?: number

    Initial window size (in bytes) for HTTP/2 stream-level flow control.

    65_535

    "grpc-node.retry_max_attempts_limit"?: number

    Maximum number of attempts when retrying requests.

    5

    "grpc-node.tls_enable_trace"?: number

    0 (disabled)

    "grpc.client_idle_timeout_ms"?: number

    Timeout (in milliseconds) after the last RPC finishes on the client channel at which the channel goes back into IDLE state.

    Minimum value is 1 second.

    1_800_000 (30 minutes)

    "grpc.default_authority"?: string

    Default value for the :authority HTTP/2 pseudo-header.

    "grpc.dns_min_time_between_resolutions_ms"?: number

    Minimum amount of time between DNS resolutions (in milliseconds).

    30_000 (30 seconds)

    "grpc.enable_channelz"?: number

    Set to 0 to disable channel-level debug information.

    1 (enabled)

    "grpc.enable_http_proxy"?: number

    Set to 0 to disable HTTP proxies.

    1 (enabled)

    "grpc.enable_retries"?: number

    Set to 0 to prevent the client from retrying requests.

    1 (enabled)

    "grpc.initial_reconnect_backoff_ms"?: number

    The time between the first and second connection attempts (in milliseconds).

    1_000 (1 second)

    "grpc.keepalive_permit_without_calls"?: number

    Set to 1 to send keepalive pings from the client without any outstanding streams.

    0 (disabled)

    "grpc.keepalive_time_ms"?: number

    Duration (in milliseconds) after which client pings the server to see if the transport is still alive.

    -1 (disabled)

    "grpc.keepalive_timeout_ms"?: number

    Duration (in milliseconds) after which to close the transport if a keepalive ping has not been acknowleged by the server.

    "grpc.lb.ring_hash.ring_size_cap"?: number

    Cap the minimum and maximum ring size values set in the load balander policy config to this value.

    4096

    "grpc.max_receive_message_length"?: number

    Maximum size (in bytes) of messages that can be received on the channel.

    4_194_304 (4 MiB)

    "grpc.max_reconnect_backoff_ms"?: number

    The maximum time between subsequent connection attempts (in milliseconds).

    120_000 (2 minutes)

    "grpc.max_send_message_length"?: number

    Maximum size (in bytes) of messages that can be sent on the channel.

    -1 (unlimited)

    "grpc.per_rpc_retry_buffer_size"?: number

    Per-RPC retry buffer size (in bytes).

    1_048_576 (1 MiB)

    "grpc.retry_buffer_size"?: number

    Total retry buffer size (in bytes).

    16_777_216 (16 MiB)

    "grpc.service_config"?: string

    Service config data in JSON form.

    This value will be ignored if service config is found via DNS.

    "grpc.service_config_disable_resolution"?: number

    Set to 1 to disable looking up service config via DNS.

    0 (enabled)

    "grpc.ssl_target_name_override"?: string

    Override the target name used for SSL hostname checking.

    This should only be used for testing.

    "grpc.use_local_subchannel_pool"?: number

    If set to 0, this channel uses the global subchannel pool. Otherwise, it uses a local subchannel pool within the channel.

    0 (disabled)