Skip to content

Commit

Permalink
docs: add warning to keepAlive options
Browse files Browse the repository at this point in the history
  • Loading branch information
Andreas Richter committed Oct 26, 2020
1 parent e764b95 commit 7fbedde
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ const { fetch } = require('gofer');
E.g. `my-hostname` turns into `my-hostname.<searchDomain>.` but
`my.fully.qualified.name.` won't be touched.
* `keepAlive`: if set to `true`, enables HTTP keep-alive
⚠ Enabling `keepAlive` can lead to `MaxListenersExceededWarning: Possible EventEmitter memory leak detected.` warnings.

[basicauth]: https://en.wikipedia.org/wiki/Basic_access_authentication
[tls]: https://nodejs.org/api/tls.html#tls_new_tls_tlssocket_socket_options
Expand Down Expand Up @@ -90,8 +91,7 @@ Returns a stream for the data as it arrives

## `Gofer`

This class can be used directly
but it's mainly meant to be the base class for individual service clients.
This class can be used directly, but it's mainly meant to be the base class for individual service clients.
Example:

```js
Expand Down

0 comments on commit 7fbedde

Please sign in to comment.