Skip to content

Commit

Permalink
chore(docs): document v10.1 and v9.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
tasneemkoushar committed Aug 10, 2021
1 parent 4762424 commit 4593413
Show file tree
Hide file tree
Showing 1,421 changed files with 34,038 additions and 8 deletions.
5 changes: 5 additions & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -1163,8 +1163,12 @@ module.exports = {
"HTTPRequest": [
'puppeteer.httprequest',
'puppeteer.httprequest.abort',
'puppeteer.httprequest.aborterrorreason',
'puppeteer.httprequest.continue',
'puppeteer.httprequest.continuerequestoverrides',
'puppeteer.httprequest.enqueueinterceptaction',
'puppeteer.httprequest.failure',
'puppeteer.httprequest.finalizeinterceptions',
'puppeteer.httprequest.frame',
'puppeteer.httprequest.headers',
'puppeteer.httprequest.isnavigationrequest',
Expand All @@ -1174,6 +1178,7 @@ module.exports = {
'puppeteer.httprequest.resourcetype',
'puppeteer.httprequest.respond',
'puppeteer.httprequest.response',
'puppeteer.httprequest.responseforrequest',
'puppeteer.httprequest.url',
],
"HTTPRespose": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Represents an HTTP request sent by a page.
<b>Signature:</b>

```typescript
export declare class HTTPRequest
export declare class HTTPRequest
```

## Remarks
Expand Down Expand Up @@ -37,12 +37,8 @@ The constructor for this class is marked as internal. Third-party code should no
| Method | Modifiers | Description |
| --- | --- | --- |
| [abort(errorCode, priority)](./puppeteer.httprequest.abort.md) | | Aborts a request. |
| [abortErrorReason()](./puppeteer.httprequest.aborterrorreason.md) | | |
| [continue(overrides, priority)](./puppeteer.httprequest.continue.md) | | Continues request with optional request overrides. |
| [continueRequestOverrides()](./puppeteer.httprequest.continuerequestoverrides.md) | | |
| [enqueueInterceptAction(pendingHandler)](./puppeteer.httprequest.enqueueinterceptaction.md) | | Adds an async request handler to the processing queue. Deferred handlers are not guaranteed to execute in any particular order, but they are guarnateed to resolve before the request interception is finalized. |
| [failure()](./puppeteer.httprequest.failure.md) | | Access information about the request's failure. |
| [finalizeInterceptions()](./puppeteer.httprequest.finalizeinterceptions.md) | | Awaits pending interception handlers and then decides how to fulfill the request interception. |
| [frame()](./puppeteer.httprequest.frame.md) | | |
| [headers()](./puppeteer.httprequest.headers.md) | | |
| [isNavigationRequest()](./puppeteer.httprequest.isnavigationrequest.md) | | |
Expand All @@ -52,6 +48,3 @@ The constructor for this class is marked as internal. Third-party code should no
| [resourceType()](./puppeteer.httprequest.resourcetype.md) | | Contains the request's resource type as it was perceived by the rendering engine. |
| [respond(response, priority)](./puppeteer.httprequest.respond.md) | | Fulfills a request with the given response. |
| [response()](./puppeteer.httprequest.response.md) | | |
| [responseForRequest()](./puppeteer.httprequest.responseforrequest.md) | | |
| [url()](./puppeteer.httprequest.url.md) | | |

12 changes: 12 additions & 0 deletions website/versioned_docs/version-10.1.0/index.md
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 website/versioned_docs/version-10.1.0/puppeteer.accessibility.md
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) &gt; [puppeteer](./puppeteer.md) &gt; [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. |

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) &gt; [puppeteer](./puppeteer.md) &gt; [Accessibility](./puppeteer.accessibility.md) &gt; [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&lt;[SerializedAXNode](./puppeteer.serializedaxnode.md)&gt;

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 website/versioned_docs/version-10.1.0/puppeteer.actionresult.md
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) &gt; [puppeteer](./puppeteer.md) &gt; [ActionResult](./puppeteer.actionresult.md)

## ActionResult type


<b>Signature:</b>

```typescript
export declare type ActionResult = 'continue' | 'abort' | 'respond';
```
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) &gt; [puppeteer](./puppeteer.md) &gt; [BoundingBox](./puppeteer.boundingbox.md) &gt; [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 website/versioned_docs/version-10.1.0/puppeteer.boundingbox.md
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) &gt; [puppeteer](./puppeteer.md) &gt; [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. |

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) &gt; [puppeteer](./puppeteer.md) &gt; [BoundingBox](./puppeteer.boundingbox.md) &gt; [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 website/versioned_docs/version-10.1.0/puppeteer.boundingbox.x.md
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) &gt; [puppeteer](./puppeteer.md) &gt; [BoundingBox](./puppeteer.boundingbox.md) &gt; [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 website/versioned_docs/version-10.1.0/puppeteer.boundingbox.y.md
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) &gt; [puppeteer](./puppeteer.md) &gt; [BoundingBox](./puppeteer.boundingbox.md) &gt; [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 website/versioned_docs/version-10.1.0/puppeteer.boxmodel.border.md
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) &gt; [puppeteer](./puppeteer.md) &gt; [BoxModel](./puppeteer.boxmodel.md) &gt; [border](./puppeteer.boxmodel.border.md)

## BoxModel.border property

<b>Signature:</b>

```typescript
border: Array<{
x: number;
y: number;
}>;
```
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) &gt; [puppeteer](./puppeteer.md) &gt; [BoxModel](./puppeteer.boxmodel.md) &gt; [content](./puppeteer.boxmodel.content.md)

## BoxModel.content property

<b>Signature:</b>

```typescript
content: Array<{
x: number;
y: number;
}>;
```
11 changes: 11 additions & 0 deletions website/versioned_docs/version-10.1.0/puppeteer.boxmodel.height.md
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) &gt; [puppeteer](./puppeteer.md) &gt; [BoxModel](./puppeteer.boxmodel.md) &gt; [height](./puppeteer.boxmodel.height.md)

## BoxModel.height property

<b>Signature:</b>

```typescript
height: number;
```
14 changes: 14 additions & 0 deletions website/versioned_docs/version-10.1.0/puppeteer.boxmodel.margin.md
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) &gt; [puppeteer](./puppeteer.md) &gt; [BoxModel](./puppeteer.boxmodel.md) &gt; [margin](./puppeteer.boxmodel.margin.md)

## BoxModel.margin property

<b>Signature:</b>

```typescript
margin: Array<{
x: number;
y: number;
}>;
```
24 changes: 24 additions & 0 deletions website/versioned_docs/version-10.1.0/puppeteer.boxmodel.md
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) &gt; [puppeteer](./puppeteer.md) &gt; [BoxModel](./puppeteer.boxmodel.md)

## BoxModel interface


<b>Signature:</b>

```typescript
export interface BoxModel
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [border](./puppeteer.boxmodel.border.md) | Array&lt;{ x: number; y: number; }&gt; | |
| [content](./puppeteer.boxmodel.content.md) | Array&lt;{ x: number; y: number; }&gt; | |
| [height](./puppeteer.boxmodel.height.md) | number | |
| [margin](./puppeteer.boxmodel.margin.md) | Array&lt;{ x: number; y: number; }&gt; | |
| [padding](./puppeteer.boxmodel.padding.md) | Array&lt;{ x: number; y: number; }&gt; | |
| [width](./puppeteer.boxmodel.width.md) | number | |

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) &gt; [puppeteer](./puppeteer.md) &gt; [BoxModel](./puppeteer.boxmodel.md) &gt; [padding](./puppeteer.boxmodel.padding.md)

## BoxModel.padding property

<b>Signature:</b>

```typescript
padding: Array<{
x: number;
y: number;
}>;
```
11 changes: 11 additions & 0 deletions website/versioned_docs/version-10.1.0/puppeteer.boxmodel.width.md
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) &gt; [puppeteer](./puppeteer.md) &gt; [BoxModel](./puppeteer.boxmodel.md) &gt; [width](./puppeteer.boxmodel.width.md)

## BoxModel.width property

<b>Signature:</b>

```typescript
width: number;
```
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) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [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 website/versioned_docs/version-10.1.0/puppeteer.browser.close.md
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) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [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&lt;void&gt;

0 comments on commit 4593413

Please sign in to comment.