Add optional timeouts to clients in server APIs #560
Conversation
|
| * @param apiKey - API Key, can be set in env var LIVEKIT_API_KEY | ||
| * @param secret - API Secret, can be set in env var LIVEKIT_API_SECRET | ||
| * @param options - client options | ||
| * @param options.requestTimeout - optional timeout, in seconds, for all server requests |
There was a problem hiding this comment.
Instead of describing the usage here, could you do it just above the field definition in the ClientOptions type?
Would also be nice if we could share the ClientOptions type across different implementations instead of redefining it in each client module.
| type Options = { | ||
| /** Prefix for the RPC requests */ | ||
| prefix?: string; | ||
| /** Timeout for fetch requests, in seconds. Must resolve to a positive integer millisecond value. */ |
There was a problem hiding this comment.
The "must resolve to a positive integer millisecond value" part feels slightly confusing to me.
2 participants
This adds a timeout parameter as part of a new
optionsargument to each Server API client.The RPC client constructor is modified to accept this timeout option, and applies it to all requests if supplied. This interface changes in a breaking way, but
TwirpRPCisn't exported from the module.The timeout value is expected to be seconds, which matches the existing timeouts in the RoomServiceClient. There's no up-front validation of the input values; an invalid value will result in an error thrown by node.js when used.
Resolves #548.