Skip to content

Commit

Permalink
Document idle options in README
Browse files Browse the repository at this point in the history
  • Loading branch information
blakeembrey committed Nov 15, 2021
1 parent 0d5158b commit a756412
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ const res = await transport()(req, done);

The `transport` function sends the Servie `Request` to a remote server.

- `keepAlive?: number` Duration to keep connection alive for re-use (default: `5000`)
- `keepAlive?: number` Keep connection alive for re-use with delay between probe (default: `5000`, 5 seconds)
- `idleSocketTimeout?: number` Maximum duration for a socket to have no traffic (default: `300_000`, 5 minutes)
- `idleRequestTimeout?: number` Maximum duration for a HTTP request to have no traffic (default: `30_000`, 30 seconds)
- `servername?: string` Override remote server name for TLS
- `rejectUnauthorized?: boolean` Rejects unauthorized TLS connections
- `negotiateHttpVersion?: NegotiateHttpVersion` Configure HTTP version negotiation (default: `HTTP2_FOR_HTTPS`)
Expand Down

0 comments on commit a756412

Please sign in to comment.