Skip to content

Commit

Permalink
chore: update types
Browse files Browse the repository at this point in the history
  • Loading branch information
@OrKoN
OrKoN committed Nov 20, 2023
1 parent 285150a commit a835641
Show file tree
Hide file tree
Showing 15 changed files with 150 additions and 69 deletions.
7 changes: 5 additions & 2 deletions docs/api/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ sidebar_label: API
| --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [ActionOptions](./puppeteer.actionoptions.md) | |
| [AutofillData](./puppeteer.autofilldata.md) | |
| [BaseLaunchOptions](./puppeteer.baselaunchoptions.md) | Generic launch options that can be passed when launching any browser. |
| [BoundingBox](./puppeteer.boundingbox.md) | |
| [BoxModel](./puppeteer.boxmodel.md) | |
| [BrowserConnectOptions](./puppeteer.browserconnectoptions.md) | Generic browser options that can be passed when launching any browser or when connecting to an existing browser instance. |
Expand All @@ -92,6 +93,7 @@ sidebar_label: API
| [CustomQueryHandler](./puppeteer.customqueryhandler.md) | |
| [Device](./puppeteer.device.md) | |
| [ElementScreenshotOptions](./puppeteer.elementscreenshotoptions.md) | |
| [ExtraPreferences](./puppeteer.extrapreferences.md) | |
| [FrameAddScriptTagOptions](./puppeteer.frameaddscripttagoptions.md) | |
| [FrameAddStyleTagOptions](./puppeteer.frameaddstyletagoptions.md) | |
| [FrameEvents](./puppeteer.frameevents.md) | |
Expand All @@ -104,7 +106,6 @@ sidebar_label: API
| [JSCoverageOptions](./puppeteer.jscoverageoptions.md) | Set of configurable options for JS coverage. |
| [KeyboardTypeOptions](./puppeteer.keyboardtypeoptions.md) | |
| [KeyDownOptions](./puppeteer.keydownoptions.md) | |
| [LaunchOptions](./puppeteer.launchoptions.md) | Generic launch options that can be passed when launching any browser. |
| [LocatorEvents](./puppeteer.locatorevents.md) | |
| [LocatorOptions](./puppeteer.locatoroptions.md) | |
| [LocatorScrollOptions](./puppeteer.locatorscrolloptions.md) | |
Expand All @@ -123,7 +124,6 @@ sidebar_label: API
| [PDFOptions](./puppeteer.pdfoptions.md) | Valid options to configure PDF generation via [Page.pdf()](./puppeteer.page.pdf.md). |
| [Point](./puppeteer.point.md) | |
| [PuppeteerErrors](./puppeteer.puppeteererrors.md) | |
| [PuppeteerLaunchOptions](./puppeteer.puppeteerlaunchoptions.md) | |
| [RemoteAddress](./puppeteer.remoteaddress.md) | |
| [ResponseForRequest](./puppeteer.responseforrequest.md) | Required response data to fulfill a request with. |
| [ScreencastOptions](./puppeteer.screencastoptions.md) | |
Expand Down Expand Up @@ -188,6 +188,7 @@ sidebar_label: API
| [InterceptResolutionStrategy](./puppeteer.interceptresolutionstrategy.md) | |
| [KeyInput](./puppeteer.keyinput.md) | All the valid keys that can be passed to functions that take user input, such as [keyboard.press](./puppeteer.keyboard.press.md) |
| [KeyPressOptions](./puppeteer.keypressoptions.md) | |
| [LaunchOptions](./puppeteer.launchoptions.md) | |
| [LocatorClickOptions](./puppeteer.locatorclickoptions.md) | |
| [LowerCasePaperFormat](./puppeteer.lowercasepaperformat.md) | |
| [Mapper](./puppeteer.mapper.md) | |
Expand All @@ -198,6 +199,8 @@ sidebar_label: API
| [Predicate](./puppeteer.predicate.md) | |
| [Product](./puppeteer.product.md) | Supported products. |
| [ProtocolLifeCycleEvent](./puppeteer.protocollifecycleevent.md) | |
| [ProtocolType](./puppeteer.protocoltype.md) | |
| [PuppeteerLaunchOptions](./puppeteer.puppeteerlaunchoptions.md) | |
| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) | |
| [PuppeteerNodeLaunchOptions](./puppeteer.puppeteernodelaunchoptions.md) | Utility type exposed to enable users to define options that can be passed to <code>puppeteer.launch</code> without having to list the set of all types. |
| [Quad](./puppeteer.quad.md) | |
Expand Down
30 changes: 30 additions & 0 deletions docs/api/puppeteer.baselaunchoptions.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
sidebar_label: BaseLaunchOptions
---

# BaseLaunchOptions interface

Generic launch options that can be passed when launching any browser.

#### Signature:

```typescript
export interface BaseLaunchOptions
```

## Properties

| Property | Modifiers | Type | Description | Default |
| ------------------ | --------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| channel | <code>optional</code> | [ChromeReleaseChannel](./puppeteer.chromereleasechannel.md) | Chrome Release Channel | |
| dumpio | <code>optional</code> | boolean | If true, pipes the browser process stdout and stderr to <code>process.stdout</code> and <code>process.stderr</code>. | <code>false</code> |
| env | <code>optional</code> | Record&lt;string, string \| undefined&gt; | Specify environment variables that will be visible to the browser. | The contents of <code>process.env</code>. |
| executablePath | <code>optional</code> | string | Path to a browser executable to use instead of the bundled Chromium. Note that Puppeteer is only guaranteed to work with the bundled Chromium, so use this setting at your own risk. | |
| extraPrefsFirefox | <code>optional</code> | Record&lt;string, unknown&gt; | [Additional preferences](https://searchfox.org/mozilla-release/source/modules/libpref/init/all.js) that can be passed when launching with Firefox. | |
| handleSIGHUP | <code>optional</code> | boolean | Close the browser process on <code>SIGHUP</code>. | <code>true</code> |
| handleSIGINT | <code>optional</code> | boolean | Close the browser process on <code>Ctrl+C</code>. | <code>true</code> |
| handleSIGTERM | <code>optional</code> | boolean | Close the browser process on <code>SIGTERM</code>. | <code>true</code> |
| ignoreDefaultArgs | <code>optional</code> | boolean \| string\[\] | If <code>true</code>, do not use <code>puppeteer.defaultArgs()</code> when creating a browser. If an array is provided, these args will be filtered out. Use this with care - you probably want the default arguments Puppeteer uses. | <code>false</code> |
| pipe | <code>optional</code> | boolean | Connect to a browser over a pipe instead of a WebSocket. | <code>false</code> |
| timeout | <code>optional</code> | number | Maximum time in milliseconds to wait for the browser to start. Pass <code>0</code> to disable the timeout. | <code>30_000</code> (30 seconds). |
| waitForInitialPage | <code>optional</code> | boolean | Whether to wait for the initial page to be ready. Useful when a user explicitly disables that (e.g. <code>--no-startup-window</code> for Chrome). | <code>true</code> |
17 changes: 17 additions & 0 deletions docs/api/puppeteer.extrapreferences.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_label: ExtraPreferences
---

# ExtraPreferences interface

#### Signature:

```typescript
export interface ExtraPreferences
```

## Properties

| Property | Modifiers | Type | Description | Default |
| ----------------- | --------------------- | ----------------------------- | ----------- | ------- |
| extraPrefsFirefox | <code>optional</code> | Record&lt;string, unknown&gt; | | |

0 comments on commit a835641

Please sign in to comment.