This is an automated email from the ASF dual-hosted git repository. glynnbird pushed a commit to branch fetch in repository https://gitbox.apache.org/repos/asf/couchdb-nano.git
commit c329cc1742021d41276dfa933674b0b07a19285c Author: Glynn Bird <[email protected]> AuthorDate: Fri Dec 16 13:45:07 2022 +0000 added description of each agentOptions attribute --- lib/nano.d.ts | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/lib/nano.d.ts b/lib/nano.d.ts index 4dbd3a5..58635d4 100644 --- a/lib/nano.d.ts +++ b/lib/nano.d.ts @@ -30,24 +30,59 @@ declare function nano( declare namespace nano { /** AgentOptionsConnect options */ interface AgentOptionsConnect extends ConnectionOptions { + /** An IPC endpoint, either Unix domain socket or Windows named pipe. + * Default: null */ socketPath: string, + /** Maximum number of TLS cached sessions. Use 0 to disable TLS session + * caching. Default: 100 */ maxCachedSessions: number, + /** Connection timeout in ms. Default: 10000 */ timeout?: number, + /** Default: null */ servername: string } /** AgentOptions options */ interface AgentOptions { + /** The timeout after which a request will time out, in milliseconds. + * Monitors time between receiving body data. Use 0 to disable it entirely. + * Default: 30000 */ bodyTimeout?: number, + /** The amount of time the parser will wait to receive the complete + * HTTP headers while not sending the request. Default: 30000 */ headersTimeout?: number, + /** The maximum allowed keepAliveTimeout in ms when overridden by keep-alive hints + * from the server. Default: 600000 */ keepAliveMaxTimeout?: number, + /** The timeout in ms after which a socket without active requests will time out. + * Monitors time between activity on a connected socket. This value may be + * overridden by keep-alive hints from the server. Default: 4000 */ keepAliveTimeout?: number, + /** A number subtracted from server keep-alive hints when overriding + * keepAliveTimeout to account for timing inaccuracies caused by + * e.g. transport latency. Default: 1000 */ keepAliveTimeoutThreshold?: number, + /** The maximum length of request headers in bytes. Default: 16384 */ maxHeaderSize?: number, + /** The maximum length of response body in bytes. Set to -1 to disable. Default: -1 */ maxResponseSize?: number, + /** The amount of concurrent requests to be sent over the single TCP/TLS + * connection according to RFC7230. Carefully consider your workload and + * environment before enabling concurrent requests as pipelining may reduce + * performance if used incorrectly. Pipelining is sensitive to network stack + * settings as well as head of line blocking caused by e.g. long running r + * equests. Set to 0 to disable keep-alive connections. Default: 1 */ pipelining?: number, + /** Connection options */ connect?: AgentOptionsConnect, + /** Whether to treat request content length mismatches as errors. If true, + * an error is thrown when the request content-length header doesn't match + * the length of the request body. Default: true */ strictContentLength?: boolean, + /** The number of Client instances to create. + * When set to null, the Pool instance will create an unlimited amount + * of Client instances. */ connections: null, + /** The number of HTTP redirection to follow - Default: 0 */ maxRedirections?: null }
