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: page.waitFor options object defination #5021

Merged
merged 5 commits into from Oct 24, 2019
Merged

docs: page.waitFor options object defination #5021

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ceb8b93
doc: page.waitFor options
theeko Oct 9, 2019
4472164
removed visibility and hidden example usages
theeko Oct 23, 2019
86b69e0
added type defs to lib/Page.js to pass ci/cd tests
theeko Oct 23, 2019
065a6ea
added visible type to lib/Page.js jsdocs
theeko Oct 23, 2019
4d339a1
prettier problem fixed
theeko Oct 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/api.md
View file
Open in desktop
Expand Up @@ -1895,6 +1895,12 @@ This is a shortcut for [page.mainFrame().url()](#frameurl)
#### page.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])
- `selectorOrFunctionOrTimeout` <[string]|[number]|[function]> A [selector], predicate or timeout to wait for
- `options` <[Object]> Optional waiting parameters
- `visible` <[boolean]> wait for element to be present in DOM and to be visible, i.e. to not have `display: none` or `visibility: hidden` CSS properties. Defaults to `false`.
Copy link
Member

Choose a reason for hiding this comment

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

What about the hidden attribute?

Maybe it's better to not explicitly list the examples (like display: none or visibility: hidden) here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed as requested. Examples are not listed anymore. Just shows default value and description.

- `timeout` <[number]> maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) method.
- `hidden` <[boolean]> wait for element to not be found in the DOM or to be hidden, i.e. have `display: none` or `visibility: hidden` CSS properties. Defaults to `false`.
- `polling` <[string]|[number]> An interval at which the `pageFunction` is executed, defaults to `raf`. If `polling` is a number, then it is treated as an interval in milliseconds at which the function would be executed. If `polling` is a string, then it can be one of the following values:
- `raf` - to constantly execute `pageFunction` in `requestAnimationFrame` callback. This is the tightest polling mode which is suitable to observe styling changes.
mathiasbynens marked this conversation as resolved.
Show resolved Hide resolved
- `mutation` - to execute `pageFunction` on every DOM mutation.
mathiasbynens marked this conversation as resolved.
Show resolved Hide resolved
- `...args` <...[Serializable]|[JSHandle]> Arguments to pass to `pageFunction`
- returns: <[Promise]<[JSHandle]>> Promise which resolves to a JSHandle of the success value

Expand Down