docs: remove unhelpful api pages (#9933)

puppeteer · Mar 28, 2023 · a99abc9 · a99abc9
1 parent 9af680d
commit a99abc9
Show file tree

Hide file tree

Showing 342 changed files with 1,160 additions and 5,168 deletions.
diff --git a/docs/api/puppeteer.boundingbox.height.md b/docs/api/puppeteer.boundingbox.height.md
diff --git a/docs/api/puppeteer.boundingbox.md b/docs/api/puppeteer.boundingbox.md
@@ -14,7 +14,7 @@ export interface BoundingBox extends Point
 
 ## Properties
 
-| Property                                    | Modifiers | Type   | Description                          | Default |
-| ------------------------------------------- | --------- | ------ | ------------------------------------ | ------- |
-| [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.  |         |
+| Property | Modifiers | Type   | Description                          | Default |
+| -------- | --------- | ------ | ------------------------------------ | ------- |
+| height   |           | number | the height of the element in pixels. |         |
+| width    |           | number | the width of the element in pixels.  |         |
diff --git a/docs/api/puppeteer.boundingbox.width.md b/docs/api/puppeteer.boundingbox.width.md
diff --git a/docs/api/puppeteer.boxmodel.border.md b/docs/api/puppeteer.boxmodel.border.md
diff --git a/docs/api/puppeteer.boxmodel.content.md b/docs/api/puppeteer.boxmodel.content.md
diff --git a/docs/api/puppeteer.boxmodel.height.md b/docs/api/puppeteer.boxmodel.height.md
diff --git a/docs/api/puppeteer.boxmodel.margin.md b/docs/api/puppeteer.boxmodel.margin.md
diff --git a/docs/api/puppeteer.boxmodel.md b/docs/api/puppeteer.boxmodel.md
@@ -12,11 +12,11 @@ export interface BoxModel
 
 ## Properties
 
-| Property                                   | Modifiers | Type                              | Description | Default |
-| ------------------------------------------ | --------- | --------------------------------- | ----------- | ------- |
-| [border](./puppeteer.boxmodel.border.md)   |           | [Point](./puppeteer.point.md)\[\] |             |         |
-| [content](./puppeteer.boxmodel.content.md) |           | [Point](./puppeteer.point.md)\[\] |             |         |
-| [height](./puppeteer.boxmodel.height.md)   |           | number                            |             |         |
-| [margin](./puppeteer.boxmodel.margin.md)   |           | [Point](./puppeteer.point.md)\[\] |             |         |
-| [padding](./puppeteer.boxmodel.padding.md) |           | [Point](./puppeteer.point.md)\[\] |             |         |
-| [width](./puppeteer.boxmodel.width.md)     |           | number                            |             |         |
+| Property | Modifiers | Type                              | Description | Default |
+| -------- | --------- | --------------------------------- | ----------- | ------- |
+| border   |           | [Point](./puppeteer.point.md)\[\] |             |         |
+| content  |           | [Point](./puppeteer.point.md)\[\] |             |         |
+| height   |           | number                            |             |         |
+| margin   |           | [Point](./puppeteer.point.md)\[\] |             |         |
+| padding  |           | [Point](./puppeteer.point.md)\[\] |             |         |
+| width    |           | number                            |             |         |
diff --git a/docs/api/puppeteer.boxmodel.padding.md b/docs/api/puppeteer.boxmodel.padding.md
diff --git a/docs/api/puppeteer.boxmodel.width.md b/docs/api/puppeteer.boxmodel.width.md
diff --git a/docs/api/puppeteer.browserconnectoptions.defaultviewport.md b/docs/api/puppeteer.browserconnectoptions.defaultviewport.md
diff --git a/docs/api/puppeteer.browserconnectoptions.ignorehttpserrors.md b/docs/api/puppeteer.browserconnectoptions.ignorehttpserrors.md
diff --git a/docs/api/puppeteer.browserconnectoptions.md b/docs/api/puppeteer.browserconnectoptions.md
@@ -14,10 +14,10 @@ export interface BrowserConnectOptions
 
 ## Properties
 
-| Property                                                                     | Modifiers | Type                                                        | Description                                                                                            | Default |
-| ---------------------------------------------------------------------------- | --------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------- |
-| [defaultViewport?](./puppeteer.browserconnectoptions.defaultviewport.md)     |           | [Viewport](./puppeteer.viewport.md) \| null                 | _(Optional)_ Sets the viewport for each page.                                                          |         |
-| [ignoreHTTPSErrors?](./puppeteer.browserconnectoptions.ignorehttpserrors.md) |           | boolean                                                     | _(Optional)_ Whether to ignore HTTPS errors during navigation.                                         | false   |
-| [protocolTimeout?](./puppeteer.browserconnectoptions.protocoltimeout.md)     |           | number                                                      | _(Optional)_ Timeout setting for individual protocol (CDP) calls.                                      | 180000  |
-| [slowMo?](./puppeteer.browserconnectoptions.slowmo.md)                       |           | number                                                      | _(Optional)_ Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. |         |
-| [targetFilter?](./puppeteer.browserconnectoptions.targetfilter.md)           |           | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | _(Optional)_ 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.                                                          |         |
+| ignoreHTTPSErrors | <code>optional</code> | boolean                                                     | Whether to ignore HTTPS errors during navigation.                                         | false   |
+| protocolTimeout   | <code>optional</code> | number                                                      | Timeout setting for individual protocol (CDP) calls.                                      | 180000  |
+| 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.                  |         |
diff --git a/docs/api/puppeteer.browserconnectoptions.protocoltimeout.md b/docs/api/puppeteer.browserconnectoptions.protocoltimeout.md
diff --git a/docs/api/puppeteer.browserconnectoptions.slowmo.md b/docs/api/puppeteer.browserconnectoptions.slowmo.md
diff --git a/docs/api/puppeteer.browserconnectoptions.targetfilter.md b/docs/api/puppeteer.browserconnectoptions.targetfilter.md
diff --git a/docs/api/puppeteer.browsercontext.id.md b/docs/api/puppeteer.browsercontext.id.md
diff --git a/docs/api/puppeteer.browsercontext.md b/docs/api/puppeteer.browsercontext.md
@@ -39,9 +39,9 @@ await context.close();
 
 ## Properties
 
-| Property                               | Modifiers             | Type                | Description |
-| -------------------------------------- | --------------------- | ------------------- | ----------- |
-| [id](./puppeteer.browsercontext.id.md) | <code>readonly</code> | string \| undefined |             |
+| Property | Modifiers             | Type                | Description |
+| -------- | --------------------- | ------------------- | ----------- |
+| id       | <code>readonly</code> | string \| undefined |             |
 
 ## Methods
 

diff --git a/docs/api/puppeteer.browsercontextoptions.md b/docs/api/puppeteer.browsercontextoptions.md
@@ -14,7 +14,7 @@ export interface BrowserContextOptions
 
 ## Properties
 
-| Property                                                                 | Modifiers | Type       | Description                                                                                                                               | Default |
-| ------------------------------------------------------------------------ | --------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------- |
-| [proxyBypassList?](./puppeteer.browsercontextoptions.proxybypasslist.md) |           | string\[\] | _(Optional)_ Bypass the proxy for the given list of hosts.                                                                                |         |
-| [proxyServer?](./puppeteer.browsercontextoptions.proxyserver.md)         |           | string     | _(Optional)_ Proxy server with optional port to use for all requests. Username and password can be set in <code>Page.authenticate</code>. |         |
+| Property        | Modifiers             | Type       | Description                                                                                                                  | Default |
+| --------------- | --------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------- | ------- |
+| proxyBypassList | <code>optional</code> | string\[\] | Bypass the proxy for the given list of hosts.                                                                                |         |
+| proxyServer     | <code>optional</code> | string     | Proxy server with optional port to use for all requests. Username and password can be set in <code>Page.authenticate</code>. |         |
diff --git a/docs/api/puppeteer.browsercontextoptions.proxybypasslist.md b/docs/api/puppeteer.browsercontextoptions.proxybypasslist.md
diff --git a/docs/api/puppeteer.browsercontextoptions.proxyserver.md b/docs/api/puppeteer.browsercontextoptions.proxyserver.md
diff --git a/docs/api/puppeteer.browserfetcheroptions.host.md b/docs/api/puppeteer.browserfetcheroptions.host.md
diff --git a/docs/api/puppeteer.browserfetcheroptions.md b/docs/api/puppeteer.browserfetcheroptions.md
@@ -12,10 +12,10 @@ export interface BrowserFetcherOptions
 
 ## Properties
 
-| Property                                                                     | Modifiers | Type                                | Description                                                                                       | Default                                                                                                                          |
-| ---------------------------------------------------------------------------- | --------- | ----------------------------------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
-| [host?](./puppeteer.browserfetcheroptions.host.md)                           |           | string                              | _(Optional)_ Determines the host that will be used for downloading.                               | <p>Either</p><p>- https://storage.googleapis.com or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central</p> |
-| [path](./puppeteer.browserfetcheroptions.path.md)                            |           | string                              | Determines the path to download browsers to.                                                      |                                                                                                                                  |
-| [platform?](./puppeteer.browserfetcheroptions.platform.md)                   |           | [Platform](./puppeteer.platform.md) | _(Optional)_ Determines which platform the browser will be suited for.                            | Auto-detected.                                                                                                                   |
-| [product?](./puppeteer.browserfetcheroptions.product.md)                     |           | 'chrome' \| 'firefox'               | _(Optional)_ Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. | <code>&quot;chrome&quot;</code>.                                                                                                 |
-| [useMacOSARMBinary?](./puppeteer.browserfetcheroptions.usemacosarmbinary.md) |           | boolean                             | _(Optional)_ Enables the use of the Chromium binary for macOS ARM.                                |                                                                                                                                  |
+| Property          | Modifiers             | Type                                | Description                                                                          | Default                                                                                                                          |
+| ----------------- | --------------------- | ----------------------------------- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
+| host              | <code>optional</code> | string                              | Determines the host that will be used for downloading.                               | <p>Either</p><p>- https://storage.googleapis.com or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central</p> |
+| path              |                       | string                              | Determines the path to download browsers to.                                         |                                                                                                                                  |
+| platform          | <code>optional</code> | [Platform](./puppeteer.platform.md) | Determines which platform the browser will be suited for.                            | Auto-detected.                                                                                                                   |
+| product           | <code>optional</code> | 'chrome' \| 'firefox'               | Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. | <code>&quot;chrome&quot;</code>.                                                                                                 |
+| useMacOSARMBinary | <code>optional</code> | boolean                             | Enables the use of the Chromium binary for macOS ARM.                                |                                                                                                                                  |
diff --git a/docs/api/puppeteer.browserfetcheroptions.path.md b/docs/api/puppeteer.browserfetcheroptions.path.md