forked from puppeteer/puppeteer
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): document v10.1 and v9.1.1
- Loading branch information
1 parent
4762424
commit 4593413
Showing
1,421 changed files
with
34,038 additions
and
8 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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,12 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) | ||
|
||
## API Reference | ||
|
||
## Packages | ||
|
||
| Package | Description | | ||
| --- | --- | | ||
| [puppeteer](./puppeteer.md) | | | ||
|
30 changes: 30 additions & 0 deletions
30
website/versioned_docs/version-10.1.0/puppeteer.accessibility.md
This file contains 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,30 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Accessibility](./puppeteer.accessibility.md) | ||
|
||
## Accessibility class | ||
|
||
The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or [switches](https://en.wikipedia.org/wiki/Switch_access). | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare class Accessibility | ||
``` | ||
|
||
## Remarks | ||
|
||
Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might have wildly different output. | ||
|
||
Blink - Chrome's rendering engine - has a concept of "accessibility tree", which is then translated into different platform-specific APIs. Accessibility namespace gives users access to the Blink Accessibility Tree. | ||
|
||
Most of the accessibility tree gets filtered out when converting from Blink AX Tree to Platform-specific AX-Tree or by assistive technologies themselves. By default, Puppeteer tries to approximate this filtering, exposing only the "interesting" nodes of the tree. | ||
|
||
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Accessibility` class. | ||
|
||
## Methods | ||
|
||
| Method | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [snapshot(options)](./puppeteer.accessibility.snapshot.md) | | Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page. | | ||
|
61 changes: 61 additions & 0 deletions
61
website/versioned_docs/version-10.1.0/puppeteer.accessibility.snapshot.md
This file contains 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,61 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Accessibility](./puppeteer.accessibility.md) > [snapshot](./puppeteer.accessibility.snapshot.md) | ||
|
||
## Accessibility.snapshot() method | ||
|
||
Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
snapshot(options?: SnapshotOptions): Promise<SerializedAXNode>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| options | [SnapshotOptions](./puppeteer.snapshotoptions.md) | | | ||
|
||
<b>Returns:</b> | ||
|
||
Promise<[SerializedAXNode](./puppeteer.serializedaxnode.md)> | ||
|
||
An AXNode object representing the snapshot. | ||
|
||
## Remarks | ||
|
||
\*\*NOTE\*\* The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Puppeteer will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`. | ||
|
||
## Example 1 | ||
|
||
An example of dumping the entire accessibility tree: | ||
|
||
```js | ||
const snapshot = await page.accessibility.snapshot(); | ||
console.log(snapshot); | ||
|
||
``` | ||
|
||
## Example 2 | ||
|
||
An example of logging the focused node's name: | ||
|
||
```js | ||
const snapshot = await page.accessibility.snapshot(); | ||
const node = findFocusedNode(snapshot); | ||
console.log(node && node.name); | ||
|
||
function findFocusedNode(node) { | ||
if (node.focused) | ||
return node; | ||
for (const child of node.children || []) { | ||
const foundNode = findFocusedNode(child); | ||
return foundNode; | ||
} | ||
return null; | ||
} | ||
|
||
``` | ||
|
12 changes: 12 additions & 0 deletions
12
website/versioned_docs/version-10.1.0/puppeteer.actionresult.md
This file contains 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,12 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [ActionResult](./puppeteer.actionresult.md) | ||
|
||
## ActionResult type | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type ActionResult = 'continue' | 'abort' | 'respond'; | ||
``` |
13 changes: 13 additions & 0 deletions
13
website/versioned_docs/version-10.1.0/puppeteer.boundingbox.height.md
This file contains 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,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) > [height](./puppeteer.boundingbox.height.md) | ||
|
||
## BoundingBox.height property | ||
|
||
the height of the element in pixels. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
height: number; | ||
``` |
22 changes: 22 additions & 0 deletions
22
website/versioned_docs/version-10.1.0/puppeteer.boundingbox.md
This file contains 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,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) | ||
|
||
## BoundingBox interface | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface BoundingBox | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [height](./puppeteer.boundingbox.height.md) | number | the height of the element in pixels. | | ||
| [width](./puppeteer.boundingbox.width.md) | number | the width of the element in pixels. | | ||
| [x](./puppeteer.boundingbox.x.md) | number | the x coordinate of the element in pixels. | | ||
| [y](./puppeteer.boundingbox.y.md) | number | the y coordinate of the element in pixels. | | ||
|
13 changes: 13 additions & 0 deletions
13
website/versioned_docs/version-10.1.0/puppeteer.boundingbox.width.md
This file contains 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,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) > [width](./puppeteer.boundingbox.width.md) | ||
|
||
## BoundingBox.width property | ||
|
||
the width of the element in pixels. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
width: number; | ||
``` |
13 changes: 13 additions & 0 deletions
13
website/versioned_docs/version-10.1.0/puppeteer.boundingbox.x.md
This file contains 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,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) > [x](./puppeteer.boundingbox.x.md) | ||
|
||
## BoundingBox.x property | ||
|
||
the x coordinate of the element in pixels. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
x: number; | ||
``` |
13 changes: 13 additions & 0 deletions
13
website/versioned_docs/version-10.1.0/puppeteer.boundingbox.y.md
This file contains 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,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) > [y](./puppeteer.boundingbox.y.md) | ||
|
||
## BoundingBox.y property | ||
|
||
the y coordinate of the element in pixels. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
y: number; | ||
``` |
14 changes: 14 additions & 0 deletions
14
website/versioned_docs/version-10.1.0/puppeteer.boxmodel.border.md
This file contains 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,14 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [border](./puppeteer.boxmodel.border.md) | ||
|
||
## BoxModel.border property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
border: Array<{ | ||
x: number; | ||
y: number; | ||
}>; | ||
``` |
14 changes: 14 additions & 0 deletions
14
website/versioned_docs/version-10.1.0/puppeteer.boxmodel.content.md
This file contains 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,14 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [content](./puppeteer.boxmodel.content.md) | ||
|
||
## BoxModel.content property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
content: Array<{ | ||
x: number; | ||
y: number; | ||
}>; | ||
``` |
11 changes: 11 additions & 0 deletions
11
website/versioned_docs/version-10.1.0/puppeteer.boxmodel.height.md
This file contains 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,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [height](./puppeteer.boxmodel.height.md) | ||
|
||
## BoxModel.height property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
height: number; | ||
``` |
14 changes: 14 additions & 0 deletions
14
website/versioned_docs/version-10.1.0/puppeteer.boxmodel.margin.md
This file contains 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,14 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [margin](./puppeteer.boxmodel.margin.md) | ||
|
||
## BoxModel.margin property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
margin: Array<{ | ||
x: number; | ||
y: number; | ||
}>; | ||
``` |
24 changes: 24 additions & 0 deletions
24
website/versioned_docs/version-10.1.0/puppeteer.boxmodel.md
This file contains 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,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) | ||
|
||
## BoxModel interface | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface BoxModel | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [border](./puppeteer.boxmodel.border.md) | Array<{ x: number; y: number; }> | | | ||
| [content](./puppeteer.boxmodel.content.md) | Array<{ x: number; y: number; }> | | | ||
| [height](./puppeteer.boxmodel.height.md) | number | | | ||
| [margin](./puppeteer.boxmodel.margin.md) | Array<{ x: number; y: number; }> | | | ||
| [padding](./puppeteer.boxmodel.padding.md) | Array<{ x: number; y: number; }> | | | ||
| [width](./puppeteer.boxmodel.width.md) | number | | | ||
|
14 changes: 14 additions & 0 deletions
14
website/versioned_docs/version-10.1.0/puppeteer.boxmodel.padding.md
This file contains 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,14 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [padding](./puppeteer.boxmodel.padding.md) | ||
|
||
## BoxModel.padding property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
padding: Array<{ | ||
x: number; | ||
y: number; | ||
}>; | ||
``` |
11 changes: 11 additions & 0 deletions
11
website/versioned_docs/version-10.1.0/puppeteer.boxmodel.width.md
This file contains 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,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [width](./puppeteer.boxmodel.width.md) | ||
|
||
## BoxModel.width property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
width: number; | ||
``` |
17 changes: 17 additions & 0 deletions
17
website/versioned_docs/version-10.1.0/puppeteer.browser.browsercontexts.md
This file contains 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,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [browserContexts](./puppeteer.browser.browsercontexts.md) | ||
|
||
## Browser.browserContexts() method | ||
|
||
Returns an array of all open browser contexts. In a newly created browser, this will return a single instance of [BrowserContext](./puppeteer.browsercontext.md). | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
browserContexts(): BrowserContext[]; | ||
``` | ||
<b>Returns:</b> | ||
|
||
[BrowserContext](./puppeteer.browsercontext.md)\[\] | ||
|
17 changes: 17 additions & 0 deletions
17
website/versioned_docs/version-10.1.0/puppeteer.browser.close.md
This file contains 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,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [close](./puppeteer.browser.close.md) | ||
|
||
## Browser.close() method | ||
|
||
Closes Chromium and all of its pages (if any were opened). The [Browser](./puppeteer.browser.md) object itself is considered to be disposed and cannot be used anymore. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
close(): Promise<void>; | ||
``` | ||
<b>Returns:</b> | ||
|
||
Promise<void> | ||
|
Oops, something went wrong.