Properties
string
required
The server address to connect to (e.g.,
"localhost:50051").boolean
When
true, adds an x-idempotency-key header to mutating RPCs.any
Extra
@grpc/grpc-js channel options merged onto (and able to override)
the SDK defaults — including the built-in keepalive settings — for both
the unary and streaming channels. Tune keepalive here, e.g.
{ "grpc.keepalive_time_ms": 15000 }, without waiting for an SDK release.Called once for every server heartbeat frame on any
subscribeEvents /
watch stream. The server emits heartbeats on a fixed cadence even when
idle, so this is a liveness signal: drive a stall watchdog from it to
detect a half-open connection and re-establish the stream. Without it,
heartbeat frames are silently dropped.boolean | RetryOptions
Type:
RetryOptionsRetries retryable unary RPC failures; streaming RPCs are never retried automatically.number
Default unary RPC timeout in milliseconds; streaming RPCs are left open.
boolean
Use TLS for the gRPC channel. Defaults to
true; set false for local development.string | () => Promise<string>
required
Bearer token, or async function that returns a fresh bearer token per RPC.