From ce01e84381528fae06909e4f16bd9e19b63d804a Mon Sep 17 00:00:00 2001 From: Lucas Hill Date: Wed, 30 Aug 2017 23:08:46 -0700 Subject: [PATCH] [doc] Clarify networkIdleInflight default in docs. (#630) --- docs/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index 514b64d410b..34b1ea57396 100644 --- a/docs/api.md +++ b/docs/api.md @@ -557,7 +557,7 @@ Navigate to the next page in history. - `waitUntil` <[string]> When to consider navigation succeeded, defaults to `load`. Could be either: - `load` - consider navigation to be finished when the `load` event is fired. - `networkidle` - consider navigation to be finished when the network activity stays "idle" for at least `networkIdleTimeout` ms. - - `networkIdleInflight` <[number]> Maximum amount of inflight requests which are considered "idle". Takes effect only with `waitUntil: 'networkidle'` parameter. + - `networkIdleInflight` <[number]> Maximum amount of inflight requests which are considered "idle". Takes effect only with `waitUntil: 'networkidle'` parameter. Defaults to 2. - `networkIdleTimeout` <[number]> A timeout to wait before completing navigation. Takes effect only with `waitUntil: 'networkidle'` parameter. Defaults to 1000 ms. - returns: <[Promise]<[Response]>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.