Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: DRY the timeout object section #535

Merged
merged 2 commits into from
Jul 25, 2018
Merged

docs: DRY the timeout object section #535

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a95e0da
docs: DRY the timeout object section
jstewmon Jul 25, 2018
a2e4bbb
update timeout docs to mention got.TimeoutError
jstewmon Jul 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,9 +186,9 @@ Query string object that will be added to the request URL. This will override th

Type: `number` `Object`

Milliseconds to wait for the server to end the response before aborting request with `ETIMEDOUT` error (a.k.a. `request` property). By default there's no timeout.
Milliseconds to wait for the server to end the response before aborting request with [`got.TimeoutError`](#gottimeouterror) error (a.k.a. `request` property). By default there's no timeout.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated these when I was working on #534, but I apparently lost the diff somewhere along the way.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. Seems good. Is it ready to merge?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, sorry for tacking that on to this PR. I didn't expect you to review so quickly. I'm not working on any more changes. :-)


This also accepts an object with separate `lookup`, `connect`, `socket`, `response` and `request` fields to specify granular timeouts for each phase of the request.
This also accepts an `object` with the following fields to constrain the duration of each phase of the request lifecycle:

- `lookup` starts when a socket is assigned and ends when the hostname has been resolved. Does not apply when using a Unix domain socket.
- `connect` starts when `lookup` completes (or when the socket is assigned if lookup does not apply to the request) and ends when the socket is connected.
Expand Down Expand Up @@ -412,7 +412,7 @@ Extends parent options. Avoid using [object spread](https://developer.mozilla.or
```js
const a = {headers: {cat: 'meow'}};
const b = {headers: {dog: 'woof'}};

{...a, ...b} // => {headers: {dog: 'woof'}}
got.assignOptions(a, b) // => {headers: {cat: 'meow', dog: 'woof'}}
```
Expand Down Expand Up @@ -455,6 +455,9 @@ When given an unsupported protocol.

When the request is aborted with `.cancel()`.

#### got.TimeoutError

When the request is aborted due to a [timeout](#timeout)

## Aborting the request

Expand Down