yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix docs for $foo methods that assumed css selectors (#2039)

Browse Source
This commit is contained in:
Dmitry Gozman 2020-04-29 15:24:59 -07:00 committed by GitHub
parent b94f9108f1
commit 3fefa7b7ff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/api.md
View File

@ -845,7 +845,7 @@ Emitted when a dedicated [WebWorker](https://developer.mozilla.org/en-US/docs/We
- `selector` <[string]> A selector to query page for - `selector` <[string]> A selector to query page for
- returns: <[Promise]<?[ElementHandle]>> - returns: <[Promise]<?[ElementHandle]>>
The method runs `document.querySelector` within the page. If no element matches the selector, the return value resolves to `null`. The method finds an element matching the specified selector within the page. See [Working with selectors](#working-with-selectors) for more details. If no elements match the selector, the return value resolves to `null`.
Shortcut for [page.mainFrame().$(selector)](#frameselector). Shortcut for [page.mainFrame().$(selector)](#frameselector).
@ -853,7 +853,7 @@ Shortcut for [page.mainFrame().$(selector)](#frameselector).
- `selector` <[string]> A selector to query page for - `selector` <[string]> A selector to query page for
- returns: <[Promise]<[Array]<[ElementHandle]>>> - returns: <[Promise]<[Array]<[ElementHandle]>>>
The method runs `document.querySelectorAll` within the page. If no elements match the selector, the return value resolves to `[]`. The method finds all elements matching the specified selector within the page. See [Working with selectors](#working-with-selectors) for more details. If no elements match the selector, the return value resolves to `[]`.
Shortcut for [page.mainFrame().$$(selector)](#frameselector-1). Shortcut for [page.mainFrame().$$(selector)](#frameselector-1).
@ -863,7 +863,7 @@ Shortcut for [page.mainFrame().$$(selector)](#frameselector-1).
- `arg` <[Serializable]|[JSHandle]> Optional argument to pass to `pageFunction` - `arg` <[Serializable]|[JSHandle]> Optional argument to pass to `pageFunction`
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction` - returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
This method runs `document.querySelector` within the page and passes it as the first argument to `pageFunction`. If there's no element matching `selector`, the method throws an error. The method finds an element matching the specified selector within the page and passes it as a first argument to `pageFunction`. See [Working with selectors](#working-with-selectors) for more details. If no elements match the selector, the method throws an error.
If `pageFunction` returns a [Promise], then `page.$eval` would wait for the promise to resolve and return its value. If `pageFunction` returns a [Promise], then `page.$eval` would wait for the promise to resolve and return its value.
@ -882,7 +882,7 @@ Shortcut for [page.mainFrame().$eval(selector, pageFunction)](#frameevalselector
- `arg` <[Serializable]|[JSHandle]> Optional argument to pass to `pageFunction` - `arg` <[Serializable]|[JSHandle]> Optional argument to pass to `pageFunction`
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction` - returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
This method runs `Array.from(document.querySelectorAll(selector))` within the page and passes it as the first argument to `pageFunction`. The method finds all elements matching the specified selector within the page and passes an array of matched elements as a first argument to `pageFunction`. See [Working with selectors](#working-with-selectors) for more details.
If `pageFunction` returns a [Promise], then `page.$$eval` would wait for the promise to resolve and return its value. If `pageFunction` returns a [Promise], then `page.$$eval` would wait for the promise to resolve and return its value.
@ -1941,13 +1941,13 @@ An example of getting text from an iframe element:
- `selector` <[string]> A selector to query frame for - `selector` <[string]> A selector to query frame for
- returns: <[Promise]<?[ElementHandle]>> Promise which resolves to ElementHandle pointing to the frame element. - returns: <[Promise]<?[ElementHandle]>> Promise which resolves to ElementHandle pointing to the frame element.
The method queries frame for the selector. If there's no such element within the frame, the method will resolve to `null`. The method finds an element matching the specified selector within the frame. See [Working with selectors](#working-with-selectors) for more details. If no elements match the selector, the return value resolves to `null`.
#### frame.$$(selector) #### frame.$$(selector)
- `selector` <[string]> A selector to query frame for - `selector` <[string]> A selector to query frame for
- returns: <[Promise]<[Array]<[ElementHandle]>>> Promise which resolves to ElementHandles pointing to the frame elements. - returns: <[Promise]<[Array]<[ElementHandle]>>> Promise which resolves to ElementHandles pointing to the frame elements.
The method runs `document.querySelectorAll` within the frame. If no elements match the selector, the return value resolves to `[]`. The method finds all elements matching the specified selector within the frame. See [Working with selectors](#working-with-selectors) for more details. If no elements match the selector, the return value resolves to `[]`.
#### frame.$eval(selector, pageFunction[, arg]) #### frame.$eval(selector, pageFunction[, arg])
- `selector` <[string]> A selector to query frame for - `selector` <[string]> A selector to query frame for
@ -1955,7 +1955,7 @@ The method runs `document.querySelectorAll` within the frame. If no elements mat
- `arg` <[Serializable]|[JSHandle]> Optional argument to pass to `pageFunction` - `arg` <[Serializable]|[JSHandle]> Optional argument to pass to `pageFunction`
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction` - returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
This method runs `document.querySelector` within the frame and passes it as the first argument to `pageFunction`. If there's no element matching `selector`, the method throws an error. The method finds an element matching the specified selector within the frame and passes it as a first argument to `pageFunction`. See [Working with selectors](#working-with-selectors) for more details. If no elements match the selector, the method throws an error.
If `pageFunction` returns a [Promise], then `frame.$eval` would wait for the promise to resolve and return its value. If `pageFunction` returns a [Promise], then `frame.$eval` would wait for the promise to resolve and return its value.
@ -1972,7 +1972,7 @@ const html = await frame.$eval('.main-container', (e, suffix) => e.outerHTML + s
- `arg` <[Serializable]|[JSHandle]> Optional argument to pass to `pageFunction` - `arg` <[Serializable]|[JSHandle]> Optional argument to pass to `pageFunction`
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction` - returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
This method runs `Array.from(document.querySelectorAll(selector))` within the frame and passes it as the first argument to `pageFunction`. The method finds all elements matching the specified selector within the frame and passes an array of matched elements as a first argument to `pageFunction`. See [Working with selectors](#working-with-selectors) for more details.
If `pageFunction` returns a [Promise], then `frame.$$eval` would wait for the promise to resolve and return its value. If `pageFunction` returns a [Promise], then `frame.$$eval` would wait for the promise to resolve and return its value.
@ -2538,13 +2538,13 @@ ElementHandle instances can be used as an argument in [`page.$eval()`](#pageeval
- `selector` <[string]> A selector to query element for - `selector` <[string]> A selector to query element for
- returns: <[Promise]<?[ElementHandle]>> - returns: <[Promise]<?[ElementHandle]>>
The method runs `element.querySelector` within the page. If no element matches the selector, the return value resolves to `null`. The method finds an element matching the specified selector in the `ElementHandle`'s subtree. See [Working with selectors](#working-with-selectors) for more details. If no elements match the selector, the return value resolves to `null`.
#### elementHandle.$$(selector) #### elementHandle.$$(selector)
- `selector` <[string]> A selector to query element for - `selector` <[string]> A selector to query element for
- returns: <[Promise]<[Array]<[ElementHandle]>>> - returns: <[Promise]<[Array]<[ElementHandle]>>>
The method runs `element.querySelectorAll` within the page. If no elements match the selector, the return value resolves to `[]`. The method finds all elements matching the specified selector in the `ElementHandle`s subtree. See [Working with selectors](#working-with-selectors) for more details. If no elements match the selector, the return value resolves to `[]`.
#### elementHandle.$eval(selector, pageFunction[, arg]) #### elementHandle.$eval(selector, pageFunction[, arg])
- `selector` <[string]> A selector to query page for - `selector` <[string]> A selector to query page for
@ -2552,7 +2552,7 @@ The method runs `element.querySelectorAll` within the page. If no elements match
- `arg` <[Serializable]|[JSHandle]> Optional argument to pass to `pageFunction` - `arg` <[Serializable]|[JSHandle]> Optional argument to pass to `pageFunction`
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction` - returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
This method runs `document.querySelector` within the element and passes it as the first argument to `pageFunction`. If there's no element matching `selector`, the method throws an error. The method finds an element matching the specified selector in the `ElementHandle`s subtree and passes it as a first argument to `pageFunction`. See [Working with selectors](#working-with-selectors) for more details. If no elements match the selector, the method throws an error.
If `pageFunction` returns a [Promise], then `frame.$eval` would wait for the promise to resolve and return its value. If `pageFunction` returns a [Promise], then `frame.$eval` would wait for the promise to resolve and return its value.
@ -2569,7 +2569,7 @@ expect(await tweetHandle.$eval('.retweets', node => node.innerText)).toBe('10');
- `arg` <[Serializable]|[JSHandle]> Optional argument to pass to `pageFunction` - `arg` <[Serializable]|[JSHandle]> Optional argument to pass to `pageFunction`
- returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction` - returns: <[Promise]<[Serializable]>> Promise which resolves to the return value of `pageFunction`
This method runs `document.querySelectorAll` within the element and passes it as the first argument to `pageFunction`. If there's no element matching `selector`, the method throws an error. The method finds all elements matching the specified selector in the `ElementHandle`'s subtree and passes an array of matched elements as a first argument to `pageFunction`. See [Working with selectors](#working-with-selectors) for more details.
If `pageFunction` returns a [Promise], then `frame.$$eval` would wait for the promise to resolve and return its value. If `pageFunction` returns a [Promise], then `frame.$$eval` would wait for the promise to resolve and return its value.