Skip to content

Commit 0ac53c5

Browse files
committed
deploy: 30946ae
1 parent 50b2648 commit 0ac53c5

File tree

2 files changed

+72
-72
lines changed

2 files changed

+72
-72
lines changed

async_api/index.html

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1429,7 +1429,7 @@ <h2 id="returns">Returns</h2>
14291429
- `page.goto()`
14301430
- `page.reload()`
14311431
- `page.set_content()`
1432-
- `page.wait_for_navigation()`
1432+
- `page.expect_navigation()`
14331433

14341434
&gt; NOTE: `page.set_default_navigation_timeout()` and `page.set_default_timeout()` take priority over
14351435
`browser_context.set_default_navigation_timeout()`.
@@ -2078,7 +2078,7 @@ <h2 id="returns">Returns</h2>
20782078
) -&gt; typing.Any:
20792079
&#34;&#34;&#34;BrowserContext.wait_for_event
20802080

2081-
&gt; NOTE: In most cases, you should use `browser_context.wait_for_event()`.
2081+
&gt; NOTE: In most cases, you should use `browser_context.expect_event()`.
20822082

20832083
Waits for given `event` to fire. If predicate is provided, it passes event&#39;s value into the `predicate` function and
20842084
waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the `event` is
@@ -3090,7 +3090,7 @@ <h2 id="parameters">Parameters</h2>
30903090
- <code>page.goto()</code>
30913091
- <code>page.reload()</code>
30923092
- <code>page.set_content()</code>
3093-
- <code>page.wait_for_navigation()</code></p>
3093+
- <code>page.expect_navigation()</code></p>
30943094
<blockquote>
30953095
<p>NOTE: <code>page.set_default_navigation_timeout()</code> and <code>page.set_default_timeout()</code> take priority over
30963096
<code>browser_context.set_default_navigation_timeout()</code>.</p>
@@ -3113,7 +3113,7 @@ <h2 id="parameters">Parameters</h2>
31133113
- `page.goto()`
31143114
- `page.reload()`
31153115
- `page.set_content()`
3116-
- `page.wait_for_navigation()`
3116+
- `page.expect_navigation()`
31173117

31183118
&gt; NOTE: `page.set_default_navigation_timeout()` and `page.set_default_timeout()` take priority over
31193119
`browser_context.set_default_navigation_timeout()`.
@@ -3424,7 +3424,7 @@ <h2 id="parameters">Parameters</h2>
34243424
<dd>
34253425
<div class="desc"><p>BrowserContext.wait_for_event</p>
34263426
<blockquote>
3427-
<p>NOTE: In most cases, you should use <code>browser_context.wait_for_event()</code>.</p>
3427+
<p>NOTE: In most cases, you should use <code>browser_context.expect_event()</code>.</p>
34283428
</blockquote>
34293429
<p>Waits for given <code>event</code> to fire. If predicate is provided, it passes event's value into the <code>predicate</code> function and
34303430
waits for <code>predicate(event)</code> to return a truthy value. Will throw an error if the socket is closed before the <code>event</code> is
@@ -3453,7 +3453,7 @@ <h2 id="returns">Returns</h2>
34533453
) -&gt; typing.Any:
34543454
&#34;&#34;&#34;BrowserContext.wait_for_event
34553455

3456-
&gt; NOTE: In most cases, you should use `browser_context.wait_for_event()`.
3456+
&gt; NOTE: In most cases, you should use `browser_context.expect_event()`.
34573457

34583458
Waits for given `event` to fire. If predicate is provided, it passes event&#39;s value into the `predicate` function and
34593459
waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the `event` is
@@ -16846,7 +16846,7 @@ <h2 id="parameters">Parameters</h2>
1684616846
- `page.goto()`
1684716847
- `page.reload()`
1684816848
- `page.set_content()`
16849-
- `page.wait_for_navigation()`
16849+
- `page.expect_navigation()`
1685016850

1685116851
&gt; NOTE: `page.set_default_navigation_timeout()` takes priority over `page.set_default_timeout()`,
1685216852
`browser_context.set_default_timeout()` and `browser_context.set_default_navigation_timeout()`.
@@ -16900,7 +16900,7 @@ <h2 id="parameters">Parameters</h2>
1690016900
The method finds an element matching the specified selector within the page. If no elements match the selector, the
1690116901
return value resolves to `null`.
1690216902

16903-
Shortcut for main frame&#39;s `frame.$()`.
16903+
Shortcut for main frame&#39;s `frame.query_selector()`.
1690416904

1690516905
Parameters
1690616906
----------
@@ -16929,7 +16929,7 @@ <h2 id="parameters">Parameters</h2>
1692916929
The method finds all elements matching the specified selector within the page. If no elements match the selector, the
1693016930
return value resolves to `[]`.
1693116931

16932-
Shortcut for main frame&#39;s `frame.$$()`.
16932+
Shortcut for main frame&#39;s `frame.query_selector_all()`.
1693316933

1693416934
Parameters
1693516935
----------
@@ -17417,7 +17417,7 @@ <h2 id="parameters">Parameters</h2>
1741717417
The method finds an element matching the specified selector within the page and passes it as a first argument to
1741817418
`pageFunction`. If no elements match the selector, the method throws an error. Returns the value of `pageFunction`.
1741917419

17420-
If `pageFunction` returns a [Promise], then `page.$eval()` would wait for the promise to resolve and return its
17420+
If `pageFunction` returns a [Promise], then `page.eval_on_selector()` would wait for the promise to resolve and return its
1742117421
value.
1742217422

1742317423
Examples:
@@ -17428,7 +17428,7 @@ <h2 id="parameters">Parameters</h2>
1742817428
html = await page.eval_on_selector(\&#34;.main-container\&#34;, \&#34;(e, suffix) =&gt; e.outer_html + suffix\&#34;, \&#34;hello\&#34;)
1742917429
```
1743017430

17431-
Shortcut for main frame&#39;s `frame.$eval()`.
17431+
Shortcut for main frame&#39;s `frame.eval_on_selector()`.
1743217432

1743317433
Parameters
1743417434
----------
@@ -17476,7 +17476,7 @@ <h2 id="parameters">Parameters</h2>
1747617476
The method finds all elements matching the specified selector within the page and passes an array of matched elements as
1747717477
a first argument to `pageFunction`. Returns the result of `pageFunction` invocation.
1747817478

17479-
If `pageFunction` returns a [Promise], then `page.$$eval()` would wait for the promise to resolve and return its
17479+
If `pageFunction` returns a [Promise], then `page.eval_on_selector_all()` would wait for the promise to resolve and return its
1748017480
value.
1748117481

1748217482
Examples:
@@ -18001,7 +18001,7 @@ <h2 id="parameters">Parameters</h2>
1800118001
) -&gt; typing.Any:
1800218002
&#34;&#34;&#34;Page.wait_for_event
1800318003

18004-
&gt; NOTE: In most cases, you should use `page.wait_for_event()`.
18004+
&gt; NOTE: In most cases, you should use `page.expect_event()`.
1800518005

1800618006
Waits for given `event` to fire. If predicate is provided, it passes event&#39;s value into the `predicate` function and
1800718007
waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the `event` is
@@ -18452,7 +18452,7 @@ <h2 id="parameters">Parameters</h2>
1845218452
By default, `page.close()` **does not** run `beforeunload` handlers.
1845318453

1845418454
&gt; NOTE: if `runBeforeUnload` is passed as true, a `beforeunload` dialog might be summoned and should be handled manually
18455-
via [`event: Page.dialog`] event.
18455+
via `page.on(&#39;dialog&#39;)` event.
1845618456

1845718457
Parameters
1845818458
----------
@@ -19748,7 +19748,7 @@ <h2 id="parameters">Parameters</h2>
1974819748
&gt; NOTE: Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is
1974919749
considered a navigation.
1975019750

19751-
Shortcut for main frame&#39;s `frame.wait_for_navigation()`.
19751+
Shortcut for main frame&#39;s `frame.expect_navigation()`.
1975219752

1975319753
Parameters
1975419754
----------
@@ -20674,7 +20674,7 @@ <h2 id="parameters">Parameters</h2>
2067420674
<p>By default, <code>page.close()</code> <strong>does not</strong> run <code>beforeunload</code> handlers.</p>
2067520675
<blockquote>
2067620676
<p>NOTE: if <code>runBeforeUnload</code> is passed as true, a <code>beforeunload</code> dialog might be summoned and should be handled manually
20677-
via [<code>event: Page.dialog</code>] event.</p>
20677+
via <code>page.on('dialog')</code> event.</p>
2067820678
</blockquote>
2067920679
<h2 id="parameters">Parameters</h2>
2068020680
<dl>
@@ -20695,7 +20695,7 @@ <h2 id="parameters">Parameters</h2>
2069520695
By default, `page.close()` **does not** run `beforeunload` handlers.
2069620696

2069720697
&gt; NOTE: if `runBeforeUnload` is passed as true, a `beforeunload` dialog might be summoned and should be handled manually
20698-
via [`event: Page.dialog`] event.
20698+
via `page.on(&#39;dialog&#39;)` event.
2069920699

2070020700
Parameters
2070120701
----------
@@ -21099,14 +21099,14 @@ <h2 id="parameters">Parameters</h2>
2109921099
<div class="desc"><p>Page.eval_on_selector</p>
2110021100
<p>The method finds an element matching the specified selector within the page and passes it as a first argument to
2110121101
<code>pageFunction</code>. If no elements match the selector, the method throws an error. Returns the value of <code>pageFunction</code>.</p>
21102-
<p>If <code>pageFunction</code> returns a [Promise], then <code>page.$eval()</code> would wait for the promise to resolve and return its
21102+
<p>If <code>pageFunction</code> returns a [Promise], then <code>page.eval_on_selector()</code> would wait for the promise to resolve and return its
2110321103
value.</p>
2110421104
<p>Examples:</p>
2110521105
<pre><code class="language-py">search_value = await page.eval_on_selector(&quot;#search&quot;, &quot;el =&gt; el.value&quot;)
2110621106
preload_href = await page.eval_on_selector(&quot;link[rel=preload]&quot;, &quot;el =&gt; el.href&quot;)
2110721107
html = await page.eval_on_selector(&quot;.main-container&quot;, &quot;(e, suffix) =&gt; e.outer_html + suffix&quot;, &quot;hello&quot;)
2110821108
</code></pre>
21109-
<p>Shortcut for main frame's <code>frame.$eval()</code>.</p>
21109+
<p>Shortcut for main frame's <code>frame.eval_on_selector()</code>.</p>
2111021110
<h2 id="parameters">Parameters</h2>
2111121111
<dl>
2111221112
<dt><strong><code>selector</code></strong> :&ensp;<code>str</code></dt>
@@ -21141,7 +21141,7 @@ <h2 id="returns">Returns</h2>
2114121141
The method finds an element matching the specified selector within the page and passes it as a first argument to
2114221142
`pageFunction`. If no elements match the selector, the method throws an error. Returns the value of `pageFunction`.
2114321143

21144-
If `pageFunction` returns a [Promise], then `page.$eval()` would wait for the promise to resolve and return its
21144+
If `pageFunction` returns a [Promise], then `page.eval_on_selector()` would wait for the promise to resolve and return its
2114521145
value.
2114621146

2114721147
Examples:
@@ -21152,7 +21152,7 @@ <h2 id="returns">Returns</h2>
2115221152
html = await page.eval_on_selector(\&#34;.main-container\&#34;, \&#34;(e, suffix) =&gt; e.outer_html + suffix\&#34;, \&#34;hello\&#34;)
2115321153
```
2115421154

21155-
Shortcut for main frame&#39;s `frame.$eval()`.
21155+
Shortcut for main frame&#39;s `frame.eval_on_selector()`.
2115621156

2115721157
Parameters
2115821158
----------
@@ -21196,7 +21196,7 @@ <h2 id="returns">Returns</h2>
2119621196
<div class="desc"><p>Page.eval_on_selector_all</p>
2119721197
<p>The method finds all elements matching the specified selector within the page and passes an array of matched elements as
2119821198
a first argument to <code>pageFunction</code>. Returns the result of <code>pageFunction</code> invocation.</p>
21199-
<p>If <code>pageFunction</code> returns a [Promise], then <code>page.$$eval()</code> would wait for the promise to resolve and return its
21199+
<p>If <code>pageFunction</code> returns a [Promise], then <code>page.eval_on_selector_all()</code> would wait for the promise to resolve and return its
2120021200
value.</p>
2120121201
<p>Examples:</p>
2120221202
<pre><code class="language-py">div_counts = await page.eval_on_selector_all(&quot;div&quot;, &quot;(divs, min) =&gt; divs.length &gt;= min&quot;, 10)
@@ -21235,7 +21235,7 @@ <h2 id="returns">Returns</h2>
2123521235
The method finds all elements matching the specified selector within the page and passes an array of matched elements as
2123621236
a first argument to `pageFunction`. Returns the result of `pageFunction` invocation.
2123721237

21238-
If `pageFunction` returns a [Promise], then `page.$$eval()` would wait for the promise to resolve and return its
21238+
If `pageFunction` returns a [Promise], then `page.eval_on_selector_all()` would wait for the promise to resolve and return its
2123921239
value.
2124021240

2124121241
Examples:
@@ -21758,7 +21758,7 @@ <h2 id="returns">Returns</h2>
2175821758
<p>NOTE: Usage of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/History_API">History API</a> to change the URL is
2175921759
considered a navigation.</p>
2176021760
</blockquote>
21761-
<p>Shortcut for main frame's <code>frame.wait_for_navigation()</code>.</p>
21761+
<p>Shortcut for main frame's <code>frame.expect_navigation()</code>.</p>
2176221762
<h2 id="parameters">Parameters</h2>
2176321763
<dl>
2176421764
<dt><strong><code>url</code></strong> :&ensp;<code>Union[Callable[[str], bool], Pattern, str, NoneType]</code></dt>
@@ -21808,7 +21808,7 @@ <h2 id="returns">Returns</h2>
2180821808
&gt; NOTE: Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is
2180921809
considered a navigation.
2181021810

21811-
Shortcut for main frame&#39;s `frame.wait_for_navigation()`.
21811+
Shortcut for main frame&#39;s `frame.expect_navigation()`.
2181221812

2181321813
Parameters
2181421814
----------
@@ -23847,7 +23847,7 @@ <h2 id="parameters">Parameters</h2>
2384723847
<div class="desc"><p>Page.query_selector</p>
2384823848
<p>The method finds an element matching the specified selector within the page. If no elements match the selector, the
2384923849
return value resolves to <code>null</code>.</p>
23850-
<p>Shortcut for main frame's <code>frame.$()</code>.</p>
23850+
<p>Shortcut for main frame's <code>frame.query_selector()</code>.</p>
2385123851
<h2 id="parameters">Parameters</h2>
2385223852
<dl>
2385323853
<dt><strong><code>selector</code></strong> :&ensp;<code>str</code></dt>
@@ -23870,7 +23870,7 @@ <h2 id="returns">Returns</h2>
2387023870
The method finds an element matching the specified selector within the page. If no elements match the selector, the
2387123871
return value resolves to `null`.
2387223872

23873-
Shortcut for main frame&#39;s `frame.$()`.
23873+
Shortcut for main frame&#39;s `frame.query_selector()`.
2387423874

2387523875
Parameters
2387623876
----------
@@ -23901,7 +23901,7 @@ <h2 id="returns">Returns</h2>
2390123901
<div class="desc"><p>Page.query_selector_all</p>
2390223902
<p>The method finds all elements matching the specified selector within the page. If no elements match the selector, the
2390323903
return value resolves to <code>[]</code>.</p>
23904-
<p>Shortcut for main frame's <code>frame.$$()</code>.</p>
23904+
<p>Shortcut for main frame's <code>frame.query_selector_all()</code>.</p>
2390523905
<h2 id="parameters">Parameters</h2>
2390623906
<dl>
2390723907
<dt><strong><code>selector</code></strong> :&ensp;<code>str</code></dt>
@@ -23922,7 +23922,7 @@ <h2 id="returns">Returns</h2>
2392223922
The method finds all elements matching the specified selector within the page. If no elements match the selector, the
2392323923
return value resolves to `[]`.
2392423924

23925-
Shortcut for main frame&#39;s `frame.$$()`.
23925+
Shortcut for main frame&#39;s `frame.query_selector_all()`.
2392623926

2392723927
Parameters
2392823928
----------
@@ -24416,7 +24416,7 @@ <h2 id="parameters">Parameters</h2>
2441624416
- <code>page.goto()</code>
2441724417
- <code>page.reload()</code>
2441824418
- <code>page.set_content()</code>
24419-
- <code>page.wait_for_navigation()</code></p>
24419+
- <code>page.expect_navigation()</code></p>
2442024420
<blockquote>
2442124421
<p>NOTE: <code>page.set_default_navigation_timeout()</code> takes priority over <code>page.set_default_timeout()</code>,
2442224422
<code>browser_context.set_default_timeout()</code> and <code>browser_context.set_default_navigation_timeout()</code>.</p>
@@ -24439,7 +24439,7 @@ <h2 id="parameters">Parameters</h2>
2443924439
- `page.goto()`
2444024440
- `page.reload()`
2444124441
- `page.set_content()`
24442-
- `page.wait_for_navigation()`
24442+
- `page.expect_navigation()`
2444324443

2444424444
&gt; NOTE: `page.set_default_navigation_timeout()` takes priority over `page.set_default_timeout()`,
2444524445
`browser_context.set_default_timeout()` and `browser_context.set_default_navigation_timeout()`.
@@ -25132,7 +25132,7 @@ <h2 id="parameters">Parameters</h2>
2513225132
<dd>
2513325133
<div class="desc"><p>Page.wait_for_event</p>
2513425134
<blockquote>
25135-
<p>NOTE: In most cases, you should use <code>page.wait_for_event()</code>.</p>
25135+
<p>NOTE: In most cases, you should use <code>page.expect_event()</code>.</p>
2513625136
</blockquote>
2513725137
<p>Waits for given <code>event</code> to fire. If predicate is provided, it passes event's value into the <code>predicate</code> function and
2513825138
waits for <code>predicate(event)</code> to return a truthy value. Will throw an error if the socket is closed before the <code>event</code> is
@@ -25161,7 +25161,7 @@ <h2 id="returns">Returns</h2>
2516125161
) -&gt; typing.Any:
2516225162
&#34;&#34;&#34;Page.wait_for_event
2516325163

25164-
&gt; NOTE: In most cases, you should use `page.wait_for_event()`.
25164+
&gt; NOTE: In most cases, you should use `page.expect_event()`.
2516525165

2516625166
Waits for given `event` to fire. If predicate is provided, it passes event&#39;s value into the `predicate` function and
2516725167
waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the `event` is
@@ -28365,7 +28365,7 @@ <h3>Class variables</h3>
2836528365
) -&gt; typing.Any:
2836628366
&#34;&#34;&#34;WebSocket.wait_for_event
2836728367

28368-
&gt; NOTE: In most cases, you should use `web_socket.wait_for_event()`.
28368+
&gt; NOTE: In most cases, you should use `web_socket.expect_event()`.
2836928369

2837028370
Waits for given `event` to fire. If predicate is provided, it passes event&#39;s value into the `predicate` function and
2837128371
waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the `event` is
@@ -28553,7 +28553,7 @@ <h2 id="returns">Returns</h2>
2855328553
<dd>
2855428554
<div class="desc"><p>WebSocket.wait_for_event</p>
2855528555
<blockquote>
28556-
<p>NOTE: In most cases, you should use <code>web_socket.wait_for_event()</code>.</p>
28556+
<p>NOTE: In most cases, you should use <code>web_socket.expect_event()</code>.</p>
2855728557
</blockquote>
2855828558
<p>Waits for given <code>event</code> to fire. If predicate is provided, it passes event's value into the <code>predicate</code> function and
2855928559
waits for <code>predicate(event)</code> to return a truthy value. Will throw an error if the socket is closed before the <code>event</code> is
@@ -28582,7 +28582,7 @@ <h2 id="returns">Returns</h2>
2858228582
) -&gt; typing.Any:
2858328583
&#34;&#34;&#34;WebSocket.wait_for_event
2858428584

28585-
&gt; NOTE: In most cases, you should use `web_socket.wait_for_event()`.
28585+
&gt; NOTE: In most cases, you should use `web_socket.expect_event()`.
2858628586

2858728587
Waits for given `event` to fire. If predicate is provided, it passes event&#39;s value into the `predicate` function and
2858828588
waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the `event` is

0 commit comments

Comments
 (0)