-
Notifications
You must be signed in to change notification settings - Fork 10.4k
Create timeouts.mdx #25772
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.
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
Merged
Merged
Create timeouts.mdx #25772
Changes from 13 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
b6d8cdc
Create timeouts.mdx
kathayl b32a137
Fixed table
ToriLindsay 9591741
Update src/content/docs/browser-rendering/reference/timeouts.mdx
kathayl a31db85
Update src/content/docs/browser-rendering/reference/timeouts.mdx
kathayl ad23b75
Update src/content/docs/browser-rendering/reference/timeouts.mdx
kathayl 30fa3df
Update src/content/docs/browser-rendering/reference/timeouts.mdx
kathayl 3d28667
Update src/content/docs/browser-rendering/reference/timeouts.mdx
kathayl fde19d8
Update src/content/docs/browser-rendering/reference/timeouts.mdx
kathayl 7cc285c
Update src/content/docs/browser-rendering/reference/timeouts.mdx
kathayl ebc24be
Update src/content/docs/browser-rendering/reference/timeouts.mdx
kathayl d796847
Update src/content/docs/browser-rendering/reference/timeouts.mdx
kathayl f348e39
Fixing table cell format
ToriLindsay b3dcd4c
Update timeouts.mdx
kathayl 669d82b
Update timeouts.mdx
kathayl 9c2c71e
Update browser-rendering.yaml
kathayl de12cf5
Update browser-rendering.yaml
kathayl d76a34f
Update browser-rendering.yaml
kathayl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| pcx_content_type: reference | ||
| title: REST API timeouts | ||
| sidebar: | ||
| order: 5 | ||
| --- | ||
| import { Tabs, TabItem } from "~/components"; | ||
|
|
||
| Browser Rendering uses several independent timers to manage how long different parts of a request can take. | ||
| If any of these timers exceed their limit, the request returns a timeout error. | ||
|
|
||
| Each timer controls a specific part of the rendering lifecycle — from page load, to selector load, to action. | ||
|
|
||
| | Timer | Scope |Default |Max | | ||
| | -------------------------------------- | --------------- | --------------- | --------------- | | ||
| | `goToOptions.timeout` | Time to wait for the page to load before timeout. | 30 s | 60 s | | ||
| | `goToOptions.waitUntil` | Time until page load considered complete: <br />`load` = full page load. <br />`Event.domcontentloaded` = the `DOMContentLoaded` event has fired. <br />`Event.networkidle0` = there are no active network connections for at least 500 ms. <br />`Event.networkidle2` = there are no more than two active network connections for at least 500 ms. | — | — | | ||
| | `goToOptions.waitUntil` | Time until page load considered complete:<br><ul><li>`load` – Full page load</li><li>`domcontentloaded` – `DOMContentLoaded` event fired</li><li>`networkidle0` – No active network connections for ≥ 500 ms</li><li>`networkidle2` – ≤ 2 active network connections for ≥ 500 ms</li></ul> | — | — | | ||
| | `waitForSelector` | Time to wait for a specific element (any CSS selector) to appear on the page. | null | 60 s | | ||
| | `waitForTimeout` | Additional amount of time to wait after the page has loaded to proceed with actions. | null | 60 s | | ||
| | `actionTimeout` | Time to wait for the action itself (for example: a screenshot, PDF, or scrape) to complete after the page has loaded. | null | 5 min | | ||
| | `PDFOptions.timeout` | Same as `actionTimeout`, but only applies to the [/pdf endpoint](/browser-rendering/rest-api/pdf-endpoint/). | 30 s | 5 min | | ||
|
|
||
| ## Notes and recommendations | ||
| You can set multiple timers — as long as one is complete, the request will fire. | ||
|
|
||
| If you are not getting the expected output: | ||
| - Try increasing `goToOptions.timeout` (up to 60 s). | ||
| - If waiting for a specific element, use `waitForSelector`. Otherwise, use `goToOptions.waitUntil` set to `networkidle2` to ensure the page has finished loading dynamic content. | ||
kathayl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.