From 8ccd10bfa201f0bcd2c4f7052a35e6fbbdfe872e Mon Sep 17 00:00:00 2001 From: Eric Bidelman Date: Thu, 10 Aug 2017 14:49:34 -0700 Subject: [PATCH] Docs: add default networkIdleTimeout value (#234) --- docs/api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api.md b/docs/api.md index 229f4c51759..ffcb04eba4a 100644 --- a/docs/api.md +++ b/docs/api.md @@ -413,9 +413,9 @@ Navigate to the next page in history. - `timeout` <[number]> Maximum navigation time in milliseconds, defaults to 30 seconds. - `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. + - `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. - - `networkIdleTimeout` <[number]> A timeout to wait before completing navigation. Takes effect only with `waitUntil: 'networkidle'` parameter. + - `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. The `page.goto` will throw an error if: