Skip to content

Commit

Permalink
docs: Upgrading to Docusaurus V3 (puppeteer#11434)
Browse files Browse the repository at this point in the history 
Co-authored-by: Alex Rudenko <alexrudenko@chromium.org>
  • Loading branch information
@TheJoin95 @OrKoN
TheJoin95 and OrKoN committed Nov 29, 2023
1 parent f67ee9f commit 39e3d4b
Show file tree
Hide file tree
Showing 56 changed files with 8,110 additions and 14,868 deletions.
6 changes: 3 additions & 3 deletions docs/api/puppeteer.autofilldata.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ export interface AutofillData

## Properties

| Property | Modifiers | Type | Description | Default |
| ---------- | --------- | --------------------------------------------------------------------------------------- | ----------- | ------- |
| creditCard | | { number: string; name: string; expiryMonth: string; expiryYear: string; cvc: string; } | | |
| Property | Modifiers | Type | Description | Default |
| ---------- | --------- | ------------------------------------------------------------------------------------------------- | ----------- | ------- |
| creditCard | | &#123; number: string; name: string; expiryMonth: string; expiryYear: string; cvc: string; &#125; | | |
16 changes: 8 additions & 8 deletions docs/api/puppeteer.browserconnectoptions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ export interface BrowserConnectOptions

## Properties

| Property | Modifiers | Type | Description | Default |
| ----------------- | --------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------- | --------------------------- |
| defaultViewport | <code>optional</code> | [Viewport](./puppeteer.viewport.md) \| null | Sets the viewport for each page. | '{width: 800, height: 600}' |
| ignoreHTTPSErrors | <code>optional</code> | boolean | Whether to ignore HTTPS errors during navigation. | <code>false</code> |
| protocol | <code>optional</code> | [ProtocolType](./puppeteer.protocoltype.md) | | 'cdp' |
| protocolTimeout | <code>optional</code> | number | Timeout setting for individual protocol (CDP) calls. | <code>180_000</code> |
| slowMo | <code>optional</code> | number | Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. | |
| targetFilter | <code>optional</code> | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | Callback to decide if Puppeteer should connect to a given target or not. | |
| Property | Modifiers | Type | Description | Default |
| ----------------- | --------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------- |
| defaultViewport | <code>optional</code> | [Viewport](./puppeteer.viewport.md) \| null | Sets the viewport for each page. | '&#123;width: 800, height: 600&#125;' |
| ignoreHTTPSErrors | <code>optional</code> | boolean | Whether to ignore HTTPS errors during navigation. | <code>false</code> |
| protocol | <code>optional</code> | [ProtocolType](./puppeteer.protocoltype.md) | | 'cdp' |
| protocolTimeout | <code>optional</code> | number | Timeout setting for individual protocol (CDP) calls. | <code>180_000</code> |
| slowMo | <code>optional</code> | number | Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. | |
| targetFilter | <code>optional</code> | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | Callback to decide if Puppeteer should connect to a given target or not. | |
10 changes: 5 additions & 5 deletions docs/api/puppeteer.coverageentry.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ export interface CoverageEntry

## Properties

| Property | Modifiers | Type | Description | Default |
| -------- | --------- | -------------------------------------------- | --------------------------------------------- | ------- |
| ranges | | Array&lt;{ start: number; end: number; }&gt; | The covered range as start and end positions. | |
| text | | string | The content of the style sheet or script. | |
| url | | string | The URL of the style sheet or script. | |
| Property | Modifiers | Type | Description | Default |
| -------- | --------- | ------------------------------------------------------ | --------------------------------------------- | ------- |
| ranges | | Array&lt;&#123; start: number; end: number; &#125;&gt; | The covered range as start and end positions. | |
| text | | string | The content of the style sheet or script. | |
| url | | string | The URL of the style sheet or script. | |
6 changes: 3 additions & 3 deletions docs/api/puppeteer.csscoverage.start.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ class CSSCoverage {

## Parameters

| Parameter | Type | Description |
| --------- | -------------------------------- | ------------ |
| options | { resetOnNavigation?: boolean; } | _(Optional)_ |
| Parameter | Type | Description |
| --------- | ------------------------------------------ | ------------ |
| options | &#123; resetOnNavigation?: boolean; &#125; | _(Optional)_ |

**Returns:**

Expand Down
2 changes: 1 addition & 1 deletion docs/api/puppeteer.elementhandle.draganddrop.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class ElementHandle {
| --------- | ------------------------------------------------------------ | ------------ |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| target | [ElementHandle](./puppeteer.elementhandle.md)&lt;Node&gt; | |
| options | { delay: number; } | _(Optional)_ |
| options | &#123; delay: number; &#125; | _(Optional)_ |

**Returns:**

Expand Down
2 changes: 1 addition & 1 deletion docs/api/puppeteer.elementhandle.isintersectingviewport.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class ElementHandle {
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| options | { threshold?: number; } | _(Optional)_ Threshold for the intersection between 0 (no intersection) and 1 (full intersection). Defaults to 1. |
| options | &#123; threshold?: number; &#125; | _(Optional)_ Threshold for the intersection between 0 (no intersection) and 1 (full intersection). Defaults to 1. |

**Returns:**

Expand Down
6 changes: 3 additions & 3 deletions docs/api/puppeteer.elementhandle.screenshot.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ class ElementHandle {

## Parameters

| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------------------------------------- | ----------- |
| options | Readonly&lt;[ScreenshotOptions](./puppeteer.screenshotoptions.md)&gt; &amp; { encoding: 'base64'; } | |
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------------------------------------------- | ----------- |
| options | Readonly&lt;[ScreenshotOptions](./puppeteer.screenshotoptions.md)&gt; &amp; &#123; encoding: 'base64'; &#125; | |

**Returns:**

Expand Down
8 changes: 4 additions & 4 deletions docs/api/puppeteer.elementhandle.waitforxpath.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ class ElementHandle {

## Parameters

| Parameter | Type | Description |
| --------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| xpath | string | A [xpath](https://developer.mozilla.org/en-US/docs/Web/XPath) of an element to wait for |
| options | { visible?: boolean; hidden?: boolean; timeout?: number; } | _(Optional)_ Optional waiting parameters |
| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| xpath | string | A [xpath](https://developer.mozilla.org/en-US/docs/Web/XPath) of an element to wait for |
| options | &#123; visible?: boolean; hidden?: boolean; timeout?: number; &#125; | _(Optional)_ Optional waiting parameters |

**Returns:**

Expand Down
8 changes: 4 additions & 4 deletions docs/api/puppeteer.frame.goto.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ class Frame {

## Parameters

| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
| url | string | URL to navigate the frame to. The URL should include scheme, e.g. <code>https://</code> |
| options | { referer?: string; referrerPolicy?: string; timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; } | _(Optional)_ Options to configure waiting behavior. |
| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| url | string | URL to navigate the frame to. The URL should include scheme, e.g. <code>https://</code> |
| options | &#123; referer?: string; referrerPolicy?: string; timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; &#125; | _(Optional)_ Options to configure waiting behavior. |

**Returns:**

Expand Down
8 changes: 4 additions & 4 deletions docs/api/puppeteer.frame.setcontent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ class Frame {

## Parameters

| Parameter | Type | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| html | string | HTML markup to assign to the page. |
| options | { timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; } | _(Optional)_ Options to configure how long before timing out and at what point to consider the content setting successful. |
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| html | string | HTML markup to assign to the page. |
| options | &#123; timeout?: number; waitUntil?: [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) \| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md)\[\]; &#125; | _(Optional)_ Options to configure how long before timing out and at what point to consider the content setting successful. |

**Returns:**

Expand Down
2 changes: 1 addition & 1 deletion docs/api/puppeteer.httprequest.failure.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class HTTPRequest {

**Returns:**

{ errorText: string; } \| null
&#123; errorText: string; &#125; \| null

`null` unless the request failed. If the request fails this can return an object with `errorText` containing a human-readable error message, e.g. `net::ERR_FAILED`. It is not guaranteed that there will be failure text if the request fails.

Expand Down
6 changes: 3 additions & 3 deletions docs/api/puppeteer.jscoverage.start.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ class JSCoverage {

## Parameters

| Parameter | Type | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| options | { resetOnNavigation?: boolean; reportAnonymousScripts?: boolean; includeRawScriptCoverage?: boolean; useBlockCoverage?: boolean; } | _(Optional)_ |
| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| options | &#123; resetOnNavigation?: boolean; reportAnonymousScripts?: boolean; includeRawScriptCoverage?: boolean; useBlockCoverage?: boolean; &#125; | _(Optional)_ |

**Returns:**

Expand Down
2 changes: 1 addition & 1 deletion docs/api/puppeteer.mouse.draganddrop.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class Mouse {
| --------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| start | [Point](./puppeteer.point.md) | point to drag from |
| target | [Point](./puppeteer.point.md) | point to drop on |
| options | { delay?: number; } | _(Optional)_ An object of options. Accepts delay which, if specified, is the time to wait between <code>dragover</code> and <code>drop</code> in milliseconds. Defaults to 0. |
| options | &#123; delay?: number; &#125; | _(Optional)_ An object of options. Accepts delay which, if specified, is the time to wait between <code>dragover</code> and <code>drop</code> in milliseconds. Defaults to 0. |

**Returns:**

Expand Down
6 changes: 3 additions & 3 deletions docs/api/puppeteer.page.close.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ class Page {

## Parameters

| Parameter | Type | Description |
| --------- | ------------------------------ | ------------ |
| options | { runBeforeUnload?: boolean; } | _(Optional)_ |
| Parameter | Type | Description |
| --------- | ---------------------------------------- | ------------ |
| options | &#123; runBeforeUnload?: boolean; &#125; | _(Optional)_ |

**Returns:**

Expand Down
6 changes: 3 additions & 3 deletions docs/api/puppeteer.page.emulateidlestate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ class Page {

## Parameters

| Parameter | Type | Description |
| --------- | ----------------------------------------------------- | --------------------------------------------------------------- |
| overrides | { isUserActive: boolean; isScreenUnlocked: boolean; } | _(Optional)_ Mock idle state. If not set, clears idle overrides |
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
| overrides | &#123; isUserActive: boolean; isScreenUnlocked: boolean; &#125; | _(Optional)_ Mock idle state. If not set, clears idle overrides |

**Returns:**

Expand Down
Loading

0 comments on commit 39e3d4b

Please sign in to comment.