diff --git a/api-extractor.json b/api-extractor.json index 1242d4a5..8cc8240a 100644 --- a/api-extractor.json +++ b/api-extractor.json @@ -27,6 +27,9 @@ }, "extractorMessageReporting": { + "ae-internal-missing-underscore": { + "logLevel": "none" + }, "default": { "logLevel": "warning" } diff --git a/new-docs/puppeteer.browserfetcher.download.md b/new-docs/puppeteer.browserfetcher.download.md index 15679730..81725d09 100644 --- a/new-docs/puppeteer.browserfetcher.download.md +++ b/new-docs/puppeteer.browserfetcher.download.md @@ -21,7 +21,7 @@ download(revision: string, progressCallback?: (x: number, y: number) => void): P Returns: -Promise<BrowserFetcherRevisionInfo> +Promise<[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md)> A promise with revision information when the revision is downloaded and extracted. diff --git a/new-docs/puppeteer.browserfetcher.platform.md b/new-docs/puppeteer.browserfetcher.platform.md index 92303f46..84e37a79 100644 --- a/new-docs/puppeteer.browserfetcher.platform.md +++ b/new-docs/puppeteer.browserfetcher.platform.md @@ -11,7 +11,7 @@ platform(): Platform; ``` Returns: -Platform +[Platform](./puppeteer.platform.md) Returns the current `Platform`. diff --git a/new-docs/puppeteer.browserfetcher.product.md b/new-docs/puppeteer.browserfetcher.product.md index 861c9b78..4066dfce 100644 --- a/new-docs/puppeteer.browserfetcher.product.md +++ b/new-docs/puppeteer.browserfetcher.product.md @@ -11,7 +11,7 @@ product(): Product; ``` Returns: -Product +[Product](./puppeteer.product.md) Returns the current `Product`. diff --git a/new-docs/puppeteer.browserfetcher.revisioninfo.md b/new-docs/puppeteer.browserfetcher.revisioninfo.md index c72e30ff..88d4ecad 100644 --- a/new-docs/puppeteer.browserfetcher.revisioninfo.md +++ b/new-docs/puppeteer.browserfetcher.revisioninfo.md @@ -18,7 +18,7 @@ revisionInfo(revision: string): BrowserFetcherRevisionInfo; Returns: -BrowserFetcherRevisionInfo +[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) The revision info for the given revision. diff --git a/new-docs/puppeteer.browserfetcheroptions.md b/new-docs/puppeteer.browserfetcheroptions.md index 71205e55..58d14dd5 100644 --- a/new-docs/puppeteer.browserfetcheroptions.md +++ b/new-docs/puppeteer.browserfetcheroptions.md @@ -4,6 +4,7 @@ ## BrowserFetcherOptions interface + Signature: ```typescript @@ -16,6 +17,6 @@ export interface BrowserFetcherOptions | --- | --- | --- | | [host](./puppeteer.browserfetcheroptions.host.md) | string | | | [path](./puppeteer.browserfetcheroptions.path.md) | string | | -| [platform](./puppeteer.browserfetcheroptions.platform.md) | Platform | | +| [platform](./puppeteer.browserfetcheroptions.platform.md) | [Platform](./puppeteer.platform.md) | | | [product](./puppeteer.browserfetcheroptions.product.md) | string | | diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.executablepath.md b/new-docs/puppeteer.browserfetcherrevisioninfo.executablepath.md new file mode 100644 index 00000000..ef45fac9 --- /dev/null +++ b/new-docs/puppeteer.browserfetcherrevisioninfo.executablepath.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [executablePath](./puppeteer.browserfetcherrevisioninfo.executablepath.md) + +## BrowserFetcherRevisionInfo.executablePath property + +Signature: + +```typescript +executablePath: string; +``` diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.folderpath.md b/new-docs/puppeteer.browserfetcherrevisioninfo.folderpath.md new file mode 100644 index 00000000..c4ab7a51 --- /dev/null +++ b/new-docs/puppeteer.browserfetcherrevisioninfo.folderpath.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [folderPath](./puppeteer.browserfetcherrevisioninfo.folderpath.md) + +## BrowserFetcherRevisionInfo.folderPath property + +Signature: + +```typescript +folderPath: string; +``` diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.local.md b/new-docs/puppeteer.browserfetcherrevisioninfo.local.md new file mode 100644 index 00000000..eed4b9cb --- /dev/null +++ b/new-docs/puppeteer.browserfetcherrevisioninfo.local.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [local](./puppeteer.browserfetcherrevisioninfo.local.md) + +## BrowserFetcherRevisionInfo.local property + +Signature: + +```typescript +local: boolean; +``` diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.md b/new-docs/puppeteer.browserfetcherrevisioninfo.md new file mode 100644 index 00000000..d17fc3df --- /dev/null +++ b/new-docs/puppeteer.browserfetcherrevisioninfo.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) + +## BrowserFetcherRevisionInfo interface + + +Signature: + +```typescript +export interface BrowserFetcherRevisionInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [executablePath](./puppeteer.browserfetcherrevisioninfo.executablepath.md) | string | | +| [folderPath](./puppeteer.browserfetcherrevisioninfo.folderpath.md) | string | | +| [local](./puppeteer.browserfetcherrevisioninfo.local.md) | boolean | | +| [product](./puppeteer.browserfetcherrevisioninfo.product.md) | string | | +| [revision](./puppeteer.browserfetcherrevisioninfo.revision.md) | string | | +| [url](./puppeteer.browserfetcherrevisioninfo.url.md) | string | | + diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.product.md b/new-docs/puppeteer.browserfetcherrevisioninfo.product.md new file mode 100644 index 00000000..eb32e35b --- /dev/null +++ b/new-docs/puppeteer.browserfetcherrevisioninfo.product.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [product](./puppeteer.browserfetcherrevisioninfo.product.md) + +## BrowserFetcherRevisionInfo.product property + +Signature: + +```typescript +product: string; +``` diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.revision.md b/new-docs/puppeteer.browserfetcherrevisioninfo.revision.md new file mode 100644 index 00000000..9fa0d1d5 --- /dev/null +++ b/new-docs/puppeteer.browserfetcherrevisioninfo.revision.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [revision](./puppeteer.browserfetcherrevisioninfo.revision.md) + +## BrowserFetcherRevisionInfo.revision property + +Signature: + +```typescript +revision: string; +``` diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.url.md b/new-docs/puppeteer.browserfetcherrevisioninfo.url.md new file mode 100644 index 00000000..aced0bfc --- /dev/null +++ b/new-docs/puppeteer.browserfetcherrevisioninfo.url.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [url](./puppeteer.browserfetcherrevisioninfo.url.md) + +## BrowserFetcherRevisionInfo.url property + +Signature: + +```typescript +url: string; +``` diff --git a/new-docs/puppeteer.browseroptions.defaultviewport.md b/new-docs/puppeteer.browseroptions.defaultviewport.md new file mode 100644 index 00000000..5cb4035c --- /dev/null +++ b/new-docs/puppeteer.browseroptions.defaultviewport.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserOptions](./puppeteer.browseroptions.md) > [defaultViewport](./puppeteer.browseroptions.defaultviewport.md) + +## BrowserOptions.defaultViewport property + +Signature: + +```typescript +defaultViewport?: Viewport; +``` diff --git a/new-docs/puppeteer.browseroptions.ignorehttpserrors.md b/new-docs/puppeteer.browseroptions.ignorehttpserrors.md new file mode 100644 index 00000000..a1951dde --- /dev/null +++ b/new-docs/puppeteer.browseroptions.ignorehttpserrors.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserOptions](./puppeteer.browseroptions.md) > [ignoreHTTPSErrors](./puppeteer.browseroptions.ignorehttpserrors.md) + +## BrowserOptions.ignoreHTTPSErrors property + +Signature: + +```typescript +ignoreHTTPSErrors?: boolean; +``` diff --git a/new-docs/puppeteer.browseroptions.md b/new-docs/puppeteer.browseroptions.md new file mode 100644 index 00000000..3decd6b9 --- /dev/null +++ b/new-docs/puppeteer.browseroptions.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserOptions](./puppeteer.browseroptions.md) + +## BrowserOptions interface + +Generic browser options that can be passed when launching any browser. + +Signature: + +```typescript +export interface BrowserOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [defaultViewport](./puppeteer.browseroptions.defaultviewport.md) | Viewport | | +| [ignoreHTTPSErrors](./puppeteer.browseroptions.ignorehttpserrors.md) | boolean | | +| [slowMo](./puppeteer.browseroptions.slowmo.md) | number | | + diff --git a/new-docs/puppeteer.browseroptions.slowmo.md b/new-docs/puppeteer.browseroptions.slowmo.md new file mode 100644 index 00000000..27a83884 --- /dev/null +++ b/new-docs/puppeteer.browseroptions.slowmo.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserOptions](./puppeteer.browseroptions.md) > [slowMo](./puppeteer.browseroptions.slowmo.md) + +## BrowserOptions.slowMo property + +Signature: + +```typescript +slowMo?: number; +``` diff --git a/new-docs/puppeteer.chromeargoptions.args.md b/new-docs/puppeteer.chromeargoptions.args.md new file mode 100644 index 00000000..5ae5f770 --- /dev/null +++ b/new-docs/puppeteer.chromeargoptions.args.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ChromeArgOptions](./puppeteer.chromeargoptions.md) > [args](./puppeteer.chromeargoptions.args.md) + +## ChromeArgOptions.args property + +Signature: + +```typescript +args?: string[]; +``` diff --git a/new-docs/puppeteer.chromeargoptions.devtools.md b/new-docs/puppeteer.chromeargoptions.devtools.md new file mode 100644 index 00000000..b1cc7c89 --- /dev/null +++ b/new-docs/puppeteer.chromeargoptions.devtools.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ChromeArgOptions](./puppeteer.chromeargoptions.md) > [devtools](./puppeteer.chromeargoptions.devtools.md) + +## ChromeArgOptions.devtools property + +Signature: + +```typescript +devtools?: boolean; +``` diff --git a/new-docs/puppeteer.chromeargoptions.headless.md b/new-docs/puppeteer.chromeargoptions.headless.md new file mode 100644 index 00000000..8636f6e6 --- /dev/null +++ b/new-docs/puppeteer.chromeargoptions.headless.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ChromeArgOptions](./puppeteer.chromeargoptions.md) > [headless](./puppeteer.chromeargoptions.headless.md) + +## ChromeArgOptions.headless property + +Signature: + +```typescript +headless?: boolean; +``` diff --git a/new-docs/puppeteer.chromeargoptions.md b/new-docs/puppeteer.chromeargoptions.md new file mode 100644 index 00000000..27e52fd0 --- /dev/null +++ b/new-docs/puppeteer.chromeargoptions.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ChromeArgOptions](./puppeteer.chromeargoptions.md) + +## ChromeArgOptions interface + +Launcher options that only apply to Chrome. + +Signature: + +```typescript +export interface ChromeArgOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [args](./puppeteer.chromeargoptions.args.md) | string\[\] | | +| [devtools](./puppeteer.chromeargoptions.devtools.md) | boolean | | +| [headless](./puppeteer.chromeargoptions.headless.md) | boolean | | +| [userDataDir](./puppeteer.chromeargoptions.userdatadir.md) | string | | + diff --git a/new-docs/puppeteer.chromeargoptions.userdatadir.md b/new-docs/puppeteer.chromeargoptions.userdatadir.md new file mode 100644 index 00000000..8d5469e2 --- /dev/null +++ b/new-docs/puppeteer.chromeargoptions.userdatadir.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ChromeArgOptions](./puppeteer.chromeargoptions.md) > [userDataDir](./puppeteer.chromeargoptions.userdatadir.md) + +## ChromeArgOptions.userDataDir property + +Signature: + +```typescript +userDataDir?: string; +``` diff --git a/new-docs/puppeteer.devicesmap.md b/new-docs/puppeteer.devicesmap.md new file mode 100644 index 00000000..e0b069cc --- /dev/null +++ b/new-docs/puppeteer.devicesmap.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [devicesMap](./puppeteer.devicesmap.md) + +## devicesMap variable + +Signature: + +```typescript +devicesMap: DevicesMap +``` diff --git a/new-docs/puppeteer.frame.click.md b/new-docs/puppeteer.frame.click.md index 10632d57..a6a205e5 100644 --- a/new-docs/puppeteer.frame.click.md +++ b/new-docs/puppeteer.frame.click.md @@ -9,7 +9,7 @@ ```typescript click(selector: string, options?: { delay?: number; - button?: MouseButtonInput; + button?: MouseButton; clickCount?: number; }): Promise; ``` @@ -19,7 +19,7 @@ click(selector: string, options?: { | Parameter | Type | Description | | --- | --- | --- | | selector | string | | -| options | { delay?: number; button?: [MouseButtonInput](./puppeteer.mousebuttoninput.md); clickCount?: number; } | | +| options | { delay?: number; button?: [MouseButton](./puppeteer.mousebutton.md); clickCount?: number; } | | Returns: diff --git a/new-docs/puppeteer.keydefinition.code.md b/new-docs/puppeteer.keydefinition.code.md deleted file mode 100644 index 3f5ee83f..00000000 --- a/new-docs/puppeteer.keydefinition.code.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [KeyDefinition](./puppeteer.keydefinition.md) > [code](./puppeteer.keydefinition.code.md) - -## KeyDefinition.code property - -Signature: - -```typescript -code?: string; -``` diff --git a/new-docs/puppeteer.keydefinition.key.md b/new-docs/puppeteer.keydefinition.key.md deleted file mode 100644 index f83d30be..00000000 --- a/new-docs/puppeteer.keydefinition.key.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [KeyDefinition](./puppeteer.keydefinition.md) > [key](./puppeteer.keydefinition.key.md) - -## KeyDefinition.key property - -Signature: - -```typescript -key?: string; -``` diff --git a/new-docs/puppeteer.keydefinition.keycode.md b/new-docs/puppeteer.keydefinition.keycode.md deleted file mode 100644 index ce43b451..00000000 --- a/new-docs/puppeteer.keydefinition.keycode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [KeyDefinition](./puppeteer.keydefinition.md) > [keyCode](./puppeteer.keydefinition.keycode.md) - -## KeyDefinition.keyCode property - -Signature: - -```typescript -keyCode?: number; -``` diff --git a/new-docs/puppeteer.keydefinition.location.md b/new-docs/puppeteer.keydefinition.location.md deleted file mode 100644 index 0f093626..00000000 --- a/new-docs/puppeteer.keydefinition.location.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [KeyDefinition](./puppeteer.keydefinition.md) > [location](./puppeteer.keydefinition.location.md) - -## KeyDefinition.location property - -Signature: - -```typescript -location?: number; -``` diff --git a/new-docs/puppeteer.keydefinition.md b/new-docs/puppeteer.keydefinition.md deleted file mode 100644 index 2219ec3b..00000000 --- a/new-docs/puppeteer.keydefinition.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [KeyDefinition](./puppeteer.keydefinition.md) - -## KeyDefinition interface - -Copyright 2017 Google Inc. All rights reserved. - -Licensed under the Apache License, Version 2.0 (the 'License'); you may not use this file except in compliance with the License. You may obtain a copy of the License at - -http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - -Signature: - -```typescript -export interface KeyDefinition -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [code](./puppeteer.keydefinition.code.md) | string | | -| [key](./puppeteer.keydefinition.key.md) | string | | -| [keyCode](./puppeteer.keydefinition.keycode.md) | number | | -| [location](./puppeteer.keydefinition.location.md) | number | | -| [shiftKey](./puppeteer.keydefinition.shiftkey.md) | string | | -| [shiftKeyCode](./puppeteer.keydefinition.shiftkeycode.md) | number | | -| [shiftText](./puppeteer.keydefinition.shifttext.md) | string | | -| [text](./puppeteer.keydefinition.text.md) | string | | - diff --git a/new-docs/puppeteer.keydefinition.shiftkey.md b/new-docs/puppeteer.keydefinition.shiftkey.md deleted file mode 100644 index 5fb41b7e..00000000 --- a/new-docs/puppeteer.keydefinition.shiftkey.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [KeyDefinition](./puppeteer.keydefinition.md) > [shiftKey](./puppeteer.keydefinition.shiftkey.md) - -## KeyDefinition.shiftKey property - -Signature: - -```typescript -shiftKey?: string; -``` diff --git a/new-docs/puppeteer.keydefinition.shiftkeycode.md b/new-docs/puppeteer.keydefinition.shiftkeycode.md deleted file mode 100644 index fedf0de3..00000000 --- a/new-docs/puppeteer.keydefinition.shiftkeycode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [KeyDefinition](./puppeteer.keydefinition.md) > [shiftKeyCode](./puppeteer.keydefinition.shiftkeycode.md) - -## KeyDefinition.shiftKeyCode property - -Signature: - -```typescript -shiftKeyCode?: number; -``` diff --git a/new-docs/puppeteer.keydefinition.shifttext.md b/new-docs/puppeteer.keydefinition.shifttext.md deleted file mode 100644 index 1a3d6c30..00000000 --- a/new-docs/puppeteer.keydefinition.shifttext.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [KeyDefinition](./puppeteer.keydefinition.md) > [shiftText](./puppeteer.keydefinition.shifttext.md) - -## KeyDefinition.shiftText property - -Signature: - -```typescript -shiftText?: string; -``` diff --git a/new-docs/puppeteer.keydefinition.text.md b/new-docs/puppeteer.keydefinition.text.md deleted file mode 100644 index b98af18f..00000000 --- a/new-docs/puppeteer.keydefinition.text.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [KeyDefinition](./puppeteer.keydefinition.md) > [text](./puppeteer.keydefinition.text.md) - -## KeyDefinition.text property - -Signature: - -```typescript -text?: string; -``` diff --git a/new-docs/puppeteer.keydefinitions.md b/new-docs/puppeteer.keydefinitions.md deleted file mode 100644 index 601076fb..00000000 --- a/new-docs/puppeteer.keydefinitions.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [keyDefinitions](./puppeteer.keydefinitions.md) - -## keyDefinitions variable - -Signature: - -```typescript -keyDefinitions: Readonly> -``` diff --git a/new-docs/puppeteer.keyinput.md b/new-docs/puppeteer.keyinput.md index 0ff88697..428dfc58 100644 --- a/new-docs/puppeteer.keyinput.md +++ b/new-docs/puppeteer.keyinput.md @@ -4,6 +4,8 @@ ## KeyInput type +All the valid keys that can be passed to functions that take user input, such as [keyboard.press](./puppeteer.keyboard.press.md) + Signature: ```typescript diff --git a/new-docs/puppeteer.launchoptions.dumpio.md b/new-docs/puppeteer.launchoptions.dumpio.md new file mode 100644 index 00000000..54408142 --- /dev/null +++ b/new-docs/puppeteer.launchoptions.dumpio.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [LaunchOptions](./puppeteer.launchoptions.md) > [dumpio](./puppeteer.launchoptions.dumpio.md) + +## LaunchOptions.dumpio property + +Signature: + +```typescript +dumpio?: boolean; +``` diff --git a/new-docs/puppeteer.launchoptions.env.md b/new-docs/puppeteer.launchoptions.env.md new file mode 100644 index 00000000..ae14781a --- /dev/null +++ b/new-docs/puppeteer.launchoptions.env.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [LaunchOptions](./puppeteer.launchoptions.md) > [env](./puppeteer.launchoptions.env.md) + +## LaunchOptions.env property + +Signature: + +```typescript +env?: Record; +``` diff --git a/new-docs/puppeteer.launchoptions.executablepath.md b/new-docs/puppeteer.launchoptions.executablepath.md new file mode 100644 index 00000000..62c61a57 --- /dev/null +++ b/new-docs/puppeteer.launchoptions.executablepath.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [LaunchOptions](./puppeteer.launchoptions.md) > [executablePath](./puppeteer.launchoptions.executablepath.md) + +## LaunchOptions.executablePath property + +Signature: + +```typescript +executablePath?: string; +``` diff --git a/new-docs/puppeteer.launchoptions.handlesighup.md b/new-docs/puppeteer.launchoptions.handlesighup.md new file mode 100644 index 00000000..92c0427c --- /dev/null +++ b/new-docs/puppeteer.launchoptions.handlesighup.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [LaunchOptions](./puppeteer.launchoptions.md) > [handleSIGHUP](./puppeteer.launchoptions.handlesighup.md) + +## LaunchOptions.handleSIGHUP property + +Signature: + +```typescript +handleSIGHUP?: boolean; +``` diff --git a/new-docs/puppeteer.launchoptions.handlesigint.md b/new-docs/puppeteer.launchoptions.handlesigint.md new file mode 100644 index 00000000..d6521475 --- /dev/null +++ b/new-docs/puppeteer.launchoptions.handlesigint.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [LaunchOptions](./puppeteer.launchoptions.md) > [handleSIGINT](./puppeteer.launchoptions.handlesigint.md) + +## LaunchOptions.handleSIGINT property + +Signature: + +```typescript +handleSIGINT?: boolean; +``` diff --git a/new-docs/puppeteer.launchoptions.handlesigterm.md b/new-docs/puppeteer.launchoptions.handlesigterm.md new file mode 100644 index 00000000..a8c7083e --- /dev/null +++ b/new-docs/puppeteer.launchoptions.handlesigterm.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [LaunchOptions](./puppeteer.launchoptions.md) > [handleSIGTERM](./puppeteer.launchoptions.handlesigterm.md) + +## LaunchOptions.handleSIGTERM property + +Signature: + +```typescript +handleSIGTERM?: boolean; +``` diff --git a/new-docs/puppeteer.launchoptions.ignoredefaultargs.md b/new-docs/puppeteer.launchoptions.ignoredefaultargs.md new file mode 100644 index 00000000..4ebdfed2 --- /dev/null +++ b/new-docs/puppeteer.launchoptions.ignoredefaultargs.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [LaunchOptions](./puppeteer.launchoptions.md) > [ignoreDefaultArgs](./puppeteer.launchoptions.ignoredefaultargs.md) + +## LaunchOptions.ignoreDefaultArgs property + +Signature: + +```typescript +ignoreDefaultArgs?: boolean | string[]; +``` diff --git a/new-docs/puppeteer.launchoptions.md b/new-docs/puppeteer.launchoptions.md new file mode 100644 index 00000000..3cef90e7 --- /dev/null +++ b/new-docs/puppeteer.launchoptions.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [LaunchOptions](./puppeteer.launchoptions.md) + +## LaunchOptions interface + +Generic launch options that can be passed when launching any browser. + +Signature: + +```typescript +export interface LaunchOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [dumpio](./puppeteer.launchoptions.dumpio.md) | boolean | | +| [env](./puppeteer.launchoptions.env.md) | Record<string, string \| undefined> | | +| [executablePath](./puppeteer.launchoptions.executablepath.md) | string | | +| [handleSIGHUP](./puppeteer.launchoptions.handlesighup.md) | boolean | | +| [handleSIGINT](./puppeteer.launchoptions.handlesigint.md) | boolean | | +| [handleSIGTERM](./puppeteer.launchoptions.handlesigterm.md) | boolean | | +| [ignoreDefaultArgs](./puppeteer.launchoptions.ignoredefaultargs.md) | boolean \| string\[\] | | +| [pipe](./puppeteer.launchoptions.pipe.md) | boolean | | +| [timeout](./puppeteer.launchoptions.timeout.md) | number | | + diff --git a/new-docs/puppeteer.launchoptions.pipe.md b/new-docs/puppeteer.launchoptions.pipe.md new file mode 100644 index 00000000..36167d15 --- /dev/null +++ b/new-docs/puppeteer.launchoptions.pipe.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [LaunchOptions](./puppeteer.launchoptions.md) > [pipe](./puppeteer.launchoptions.pipe.md) + +## LaunchOptions.pipe property + +Signature: + +```typescript +pipe?: boolean; +``` diff --git a/new-docs/puppeteer.launchoptions.timeout.md b/new-docs/puppeteer.launchoptions.timeout.md new file mode 100644 index 00000000..bbba4d7a --- /dev/null +++ b/new-docs/puppeteer.launchoptions.timeout.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [LaunchOptions](./puppeteer.launchoptions.md) > [timeout](./puppeteer.launchoptions.timeout.md) + +## LaunchOptions.timeout property + +Signature: + +```typescript +timeout?: number; +``` diff --git a/new-docs/puppeteer.md b/new-docs/puppeteer.md index c6f7335d..c5648645 100644 --- a/new-docs/puppeteer.md +++ b/new-docs/puppeteer.md @@ -50,6 +50,9 @@ | [BoundingBox](./puppeteer.boundingbox.md) | | | [BoxModel](./puppeteer.boxmodel.md) | | | [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) | | +| [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) | | +| [BrowserOptions](./puppeteer.browseroptions.md) | Generic browser options that can be passed when launching any browser. | +| [ChromeArgOptions](./puppeteer.chromeargoptions.md) | Launcher options that only apply to Chrome. | | [ClickOptions](./puppeteer.clickoptions.md) | | | [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) | | | [CoverageEntry](./puppeteer.coverageentry.md) | The CoverageEntry class represents one entry of the coverage report. | @@ -57,12 +60,15 @@ | [GeolocationOptions](./puppeteer.geolocationoptions.md) | | | [JSCoverageOptions](./puppeteer.jscoverageoptions.md) | Set of configurable options for JS coverage. | | [JSONObject](./puppeteer.jsonobject.md) | | -| [KeyDefinition](./puppeteer.keydefinition.md) | Copyright 2017 Google Inc. All rights reserved.Licensed under the Apache License, Version 2.0 (the 'License'); you may not use this file except in compliance with the License. You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | +| [LaunchOptions](./puppeteer.launchoptions.md) | Generic launch options that can be passed when launching any browser. | | [Metrics](./puppeteer.metrics.md) | | +| [MouseOptions](./puppeteer.mouseoptions.md) | | | [PressOptions](./puppeteer.pressoptions.md) | | +| [ProductLauncher](./puppeteer.productlauncher.md) | Describes a launcher - a class that is able to create and launch a browser instance. | | [RemoteAddress](./puppeteer.remoteaddress.md) | | | [SerializedAXNode](./puppeteer.serializedaxnode.md) | Represents a Node and the properties of it that are relevant to Accessibility. | | [SnapshotOptions](./puppeteer.snapshotoptions.md) | | +| [TracingOptions](./puppeteer.tracingoptions.md) | | | [WaitForOptions](./puppeteer.waitforoptions.md) | | | [WaitForTargetOptions](./puppeteer.waitfortargetoptions.md) | | | [WaitTimeoutOptions](./puppeteer.waittimeoutoptions.md) | | @@ -71,8 +77,8 @@ | Variable | Description | | --- | --- | +| [devicesMap](./puppeteer.devicesmap.md) | | | [EVALUATION\_SCRIPT\_URL](./puppeteer.evaluation_script_url.md) | | -| [keyDefinitions](./puppeteer.keydefinitions.md) | | | [puppeteerErrors](./puppeteer.puppeteererrors.md) | | ## Type Aliases @@ -80,12 +86,15 @@ | Type Alias | Description | | --- | --- | | [ConsoleMessageType](./puppeteer.consolemessagetype.md) | The supported types for console messages. | +| [DevicesMap](./puppeteer.devicesmap.md) | | | [EvaluateFn](./puppeteer.evaluatefn.md) | | | [EvaluateFnReturnType](./puppeteer.evaluatefnreturntype.md) | | | [EvaluateHandleFn](./puppeteer.evaluatehandlefn.md) | | | [JSONArray](./puppeteer.jsonarray.md) | | -| [KeyInput](./puppeteer.keyinput.md) | | -| [MouseButtonInput](./puppeteer.mousebuttoninput.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) | +| [MouseButton](./puppeteer.mousebutton.md) | | +| [Platform](./puppeteer.platform.md) | Supported platforms. | +| [Product](./puppeteer.product.md) | Supported products. | | [PuppeteerErrors](./puppeteer.puppeteererrors.md) | | | [Serializable](./puppeteer.serializable.md) | | | [SerializableOrJSHandle](./puppeteer.serializableorjshandle.md) | | diff --git a/new-docs/puppeteer.mouse._button.md b/new-docs/puppeteer.mouse._button.md deleted file mode 100644 index eec43f86..00000000 --- a/new-docs/puppeteer.mouse._button.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Mouse](./puppeteer.mouse.md) > [\_button](./puppeteer.mouse._button.md) - -## Mouse.\_button property - -Signature: - -```typescript -_button: MouseButton; -``` diff --git a/new-docs/puppeteer.mouse._client.md b/new-docs/puppeteer.mouse._client.md deleted file mode 100644 index 7c4de731..00000000 --- a/new-docs/puppeteer.mouse._client.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Mouse](./puppeteer.mouse.md) > [\_client](./puppeteer.mouse._client.md) - -## Mouse.\_client property - -Signature: - -```typescript -_client: CDPSession; -``` diff --git a/new-docs/puppeteer.mouse._keyboard.md b/new-docs/puppeteer.mouse._keyboard.md deleted file mode 100644 index db7b2e2b..00000000 --- a/new-docs/puppeteer.mouse._keyboard.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Mouse](./puppeteer.mouse.md) > [\_keyboard](./puppeteer.mouse._keyboard.md) - -## Mouse.\_keyboard property - -Signature: - -```typescript -_keyboard: Keyboard; -``` diff --git a/new-docs/puppeteer.mouse._x.md b/new-docs/puppeteer.mouse._x.md deleted file mode 100644 index cfedc193..00000000 --- a/new-docs/puppeteer.mouse._x.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Mouse](./puppeteer.mouse.md) > [\_x](./puppeteer.mouse._x.md) - -## Mouse.\_x property - -Signature: - -```typescript -_x: number; -``` diff --git a/new-docs/puppeteer.mouse._y.md b/new-docs/puppeteer.mouse._y.md deleted file mode 100644 index a6200285..00000000 --- a/new-docs/puppeteer.mouse._y.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Mouse](./puppeteer.mouse.md) > [\_y](./puppeteer.mouse._y.md) - -## Mouse.\_y property - -Signature: - -```typescript -_y: number; -``` diff --git a/new-docs/puppeteer.mouse.click.md b/new-docs/puppeteer.mouse.click.md index 4fa9645f..adc356ba 100644 --- a/new-docs/puppeteer.mouse.click.md +++ b/new-docs/puppeteer.mouse.click.md @@ -20,7 +20,7 @@ click(x: number, y: number, options?: MouseOptions & { | --- | --- | --- | | x | number | Horizontal position of the mouse. | | y | number | Vertical position of the mouse. | -| options | MouseOptions & { delay?: number; } | Optional MouseOptions. | +| options | [MouseOptions](./puppeteer.mouseoptions.md) & { delay?: number; } | Optional MouseOptions. | Returns: diff --git a/new-docs/puppeteer.mouse.down.md b/new-docs/puppeteer.mouse.down.md index b4c0f464..ac3b6a63 100644 --- a/new-docs/puppeteer.mouse.down.md +++ b/new-docs/puppeteer.mouse.down.md @@ -16,7 +16,7 @@ down(options?: MouseOptions): Promise; | Parameter | Type | Description | | --- | --- | --- | -| options | MouseOptions | Optional MouseOptions. | +| options | [MouseOptions](./puppeteer.mouseoptions.md) | Optional MouseOptions. | Returns: diff --git a/new-docs/puppeteer.mouse.md b/new-docs/puppeteer.mouse.md index a3ecd2b3..8a5044ca 100644 --- a/new-docs/puppeteer.mouse.md +++ b/new-docs/puppeteer.mouse.md @@ -73,16 +73,6 @@ await browser.defaultBrowserContext().overridePermissions( ``` -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [\_button](./puppeteer.mouse._button.md) | | MouseButton | | -| [\_client](./puppeteer.mouse._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | | -| [\_keyboard](./puppeteer.mouse._keyboard.md) | | [Keyboard](./puppeteer.keyboard.md) | | -| [\_x](./puppeteer.mouse._x.md) | | number | | -| [\_y](./puppeteer.mouse._y.md) | | number | | - ## Methods | Method | Modifiers | Description | diff --git a/new-docs/puppeteer.mouse.up.md b/new-docs/puppeteer.mouse.up.md index d8a4071f..b85abd62 100644 --- a/new-docs/puppeteer.mouse.up.md +++ b/new-docs/puppeteer.mouse.up.md @@ -16,7 +16,7 @@ up(options?: MouseOptions): Promise; | Parameter | Type | Description | | --- | --- | --- | -| options | MouseOptions | Optional MouseOptions. | +| options | [MouseOptions](./puppeteer.mouseoptions.md) | Optional MouseOptions. | Returns: diff --git a/new-docs/puppeteer.mousebuttoninput.md b/new-docs/puppeteer.mousebutton.md similarity index 55% rename from new-docs/puppeteer.mousebuttoninput.md rename to new-docs/puppeteer.mousebutton.md index af8eb180..e9f29aca 100644 --- a/new-docs/puppeteer.mousebuttoninput.md +++ b/new-docs/puppeteer.mousebutton.md @@ -1,11 +1,12 @@ -[Home](./index.md) > [puppeteer](./puppeteer.md) > [MouseButtonInput](./puppeteer.mousebuttoninput.md) +[Home](./index.md) > [puppeteer](./puppeteer.md) > [MouseButton](./puppeteer.mousebutton.md) + +## MouseButton type -## MouseButtonInput type Signature: ```typescript -export declare type MouseButtonInput = Exclude; +export declare type MouseButton = 'left' | 'right' | 'middle'; ``` diff --git a/new-docs/puppeteer.mouseoptions.button.md b/new-docs/puppeteer.mouseoptions.button.md new file mode 100644 index 00000000..ba9dfec8 --- /dev/null +++ b/new-docs/puppeteer.mouseoptions.button.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [MouseOptions](./puppeteer.mouseoptions.md) > [button](./puppeteer.mouseoptions.button.md) + +## MouseOptions.button property + +Signature: + +```typescript +button?: MouseButton; +``` diff --git a/new-docs/puppeteer.mouseoptions.clickcount.md b/new-docs/puppeteer.mouseoptions.clickcount.md new file mode 100644 index 00000000..799e1b29 --- /dev/null +++ b/new-docs/puppeteer.mouseoptions.clickcount.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [MouseOptions](./puppeteer.mouseoptions.md) > [clickCount](./puppeteer.mouseoptions.clickcount.md) + +## MouseOptions.clickCount property + +Signature: + +```typescript +clickCount?: number; +``` diff --git a/new-docs/puppeteer.mouseoptions.md b/new-docs/puppeteer.mouseoptions.md new file mode 100644 index 00000000..897c185a --- /dev/null +++ b/new-docs/puppeteer.mouseoptions.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [MouseOptions](./puppeteer.mouseoptions.md) + +## MouseOptions interface + + +Signature: + +```typescript +export interface MouseOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [button](./puppeteer.mouseoptions.button.md) | [MouseButton](./puppeteer.mousebutton.md) | | +| [clickCount](./puppeteer.mouseoptions.clickcount.md) | number | | + diff --git a/new-docs/puppeteer.page.click.md b/new-docs/puppeteer.page.click.md index 62317e8f..3366641d 100644 --- a/new-docs/puppeteer.page.click.md +++ b/new-docs/puppeteer.page.click.md @@ -9,7 +9,7 @@ ```typescript click(selector: string, options?: { delay?: number; - button?: MouseButtonInput; + button?: MouseButton; clickCount?: number; }): Promise; ``` @@ -19,7 +19,7 @@ click(selector: string, options?: { | Parameter | Type | Description | | --- | --- | --- | | selector | string | | -| options | { delay?: number; button?: [MouseButtonInput](./puppeteer.mousebuttoninput.md); clickCount?: number; } | | +| options | { delay?: number; button?: [MouseButton](./puppeteer.mousebutton.md); clickCount?: number; } | | Returns: diff --git a/new-docs/puppeteer.platform.md b/new-docs/puppeteer.platform.md new file mode 100644 index 00000000..03e8b72d --- /dev/null +++ b/new-docs/puppeteer.platform.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Platform](./puppeteer.platform.md) + +## Platform type + +Supported platforms. + +Signature: + +```typescript +export declare type Platform = 'linux' | 'mac' | 'win32' | 'win64'; +``` diff --git a/new-docs/puppeteer.product.md b/new-docs/puppeteer.product.md new file mode 100644 index 00000000..1d7e0c02 --- /dev/null +++ b/new-docs/puppeteer.product.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Product](./puppeteer.product.md) + +## Product type + +Supported products. + +Signature: + +```typescript +export declare type Product = 'chrome' | 'firefox'; +``` diff --git a/new-docs/puppeteer.productlauncher.connect.md b/new-docs/puppeteer.productlauncher.connect.md new file mode 100644 index 00000000..6837409e --- /dev/null +++ b/new-docs/puppeteer.productlauncher.connect.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ProductLauncher](./puppeteer.productlauncher.md) > [connect](./puppeteer.productlauncher.connect.md) + +## ProductLauncher.connect() method + +Signature: + +```typescript +connect(object: any): any; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| object | any | | + +Returns: + +any + diff --git a/new-docs/puppeteer.productlauncher.defaultargs.md b/new-docs/puppeteer.productlauncher.defaultargs.md new file mode 100644 index 00000000..be1009e3 --- /dev/null +++ b/new-docs/puppeteer.productlauncher.defaultargs.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ProductLauncher](./puppeteer.productlauncher.md) > [defaultArgs](./puppeteer.productlauncher.defaultargs.md) + +## ProductLauncher.defaultArgs() method + +Signature: + +```typescript +defaultArgs(object: any): any; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| object | any | | + +Returns: + +any + diff --git a/new-docs/puppeteer.productlauncher.executablepath.md b/new-docs/puppeteer.productlauncher.executablepath.md new file mode 100644 index 00000000..ac30111c --- /dev/null +++ b/new-docs/puppeteer.productlauncher.executablepath.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ProductLauncher](./puppeteer.productlauncher.md) > [executablePath](./puppeteer.productlauncher.executablepath.md) + +## ProductLauncher.executablePath property + +Signature: + +```typescript +executablePath: () => string; +``` diff --git a/new-docs/puppeteer.productlauncher.launch.md b/new-docs/puppeteer.productlauncher.launch.md new file mode 100644 index 00000000..cfe35879 --- /dev/null +++ b/new-docs/puppeteer.productlauncher.launch.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ProductLauncher](./puppeteer.productlauncher.md) > [launch](./puppeteer.productlauncher.launch.md) + +## ProductLauncher.launch() method + +Signature: + +```typescript +launch(object: any): any; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| object | any | | + +Returns: + +any + diff --git a/new-docs/puppeteer.productlauncher.md b/new-docs/puppeteer.productlauncher.md new file mode 100644 index 00000000..4f3dc6fa --- /dev/null +++ b/new-docs/puppeteer.productlauncher.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ProductLauncher](./puppeteer.productlauncher.md) + +## ProductLauncher interface + +Describes a launcher - a class that is able to create and launch a browser instance. + +Signature: + +```typescript +export interface ProductLauncher +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [executablePath](./puppeteer.productlauncher.executablepath.md) | () => string | | +| [product](./puppeteer.productlauncher.product.md) | string | | + +## Methods + +| Method | Description | +| --- | --- | +| [connect(object)](./puppeteer.productlauncher.connect.md) | | +| [defaultArgs(object)](./puppeteer.productlauncher.defaultargs.md) | | +| [launch(object)](./puppeteer.productlauncher.launch.md) | | + diff --git a/new-docs/puppeteer.productlauncher.product.md b/new-docs/puppeteer.productlauncher.product.md new file mode 100644 index 00000000..6d906bad --- /dev/null +++ b/new-docs/puppeteer.productlauncher.product.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ProductLauncher](./puppeteer.productlauncher.md) > [product](./puppeteer.productlauncher.product.md) + +## ProductLauncher.product property + +Signature: + +```typescript +product: string; +``` diff --git a/new-docs/puppeteer.puppeteer.connect.md b/new-docs/puppeteer.puppeteer.connect.md index 6431e384..7e99b608 100644 --- a/new-docs/puppeteer.puppeteer.connect.md +++ b/new-docs/puppeteer.puppeteer.connect.md @@ -21,7 +21,7 @@ connect(options: BrowserOptions & { | Parameter | Type | Description | | --- | --- | --- | -| options | BrowserOptions & { browserWSEndpoint?: string; browserURL?: string; transport?: ConnectionTransport; product?: string; } | Set of configurable options to set on the browser. | +| options | [BrowserOptions](./puppeteer.browseroptions.md) & { browserWSEndpoint?: string; browserURL?: string; transport?: ConnectionTransport; product?: string; } | Set of configurable options to set on the browser. | Returns: diff --git a/new-docs/puppeteer.puppeteer.defaultargs.md b/new-docs/puppeteer.puppeteer.defaultargs.md index f7e8cc26..007d602a 100644 --- a/new-docs/puppeteer.puppeteer.defaultargs.md +++ b/new-docs/puppeteer.puppeteer.defaultargs.md @@ -14,7 +14,7 @@ defaultArgs(options?: ChromeArgOptions): string[]; | Parameter | Type | Description | | --- | --- | --- | -| options | ChromeArgOptions | Set of configurable options to set on the browser. | +| options | [ChromeArgOptions](./puppeteer.chromeargoptions.md) | Set of configurable options to set on the browser. | Returns: diff --git a/new-docs/puppeteer.puppeteer.launch.md b/new-docs/puppeteer.puppeteer.launch.md index 604cca0b..e68a4004 100644 --- a/new-docs/puppeteer.puppeteer.launch.md +++ b/new-docs/puppeteer.puppeteer.launch.md @@ -19,7 +19,7 @@ launch(options?: LaunchOptions & ChromeArgOptions & BrowserOptions & { | Parameter | Type | Description | | --- | --- | --- | -| options | LaunchOptions & ChromeArgOptions & BrowserOptions & { product?: string; extraPrefsFirefox?: {}; } | Set of configurable options to set on the browser. | +| options | [LaunchOptions](./puppeteer.launchoptions.md) & [ChromeArgOptions](./puppeteer.chromeargoptions.md) & [BrowserOptions](./puppeteer.browseroptions.md) & { product?: string; extraPrefsFirefox?: {}; } | Set of configurable options to set on the browser. | Returns: diff --git a/new-docs/puppeteer.puppeteer.md b/new-docs/puppeteer.puppeteer.md index e96e126c..eb0adb5c 100644 --- a/new-docs/puppeteer.puppeteer.md +++ b/new-docs/puppeteer.puppeteer.md @@ -40,9 +40,9 @@ const puppeteer = require('puppeteer'); | [\_\_productName](./puppeteer.puppeteer.__productname.md) | | string | | | [\_changedProduct](./puppeteer.puppeteer._changedproduct.md) | | boolean | | | [\_isPuppeteerCore](./puppeteer.puppeteer._ispuppeteercore.md) | | boolean | | -| [\_lazyLauncher](./puppeteer.puppeteer._lazylauncher.md) | | ProductLauncher | | +| [\_lazyLauncher](./puppeteer.puppeteer._lazylauncher.md) | | [ProductLauncher](./puppeteer.productlauncher.md) | | | [\_preferredRevision](./puppeteer.puppeteer._preferredrevision.md) | | string | | -| [devices](./puppeteer.puppeteer.devices.md) | | DevicesMap | | +| [devices](./puppeteer.puppeteer.devices.md) | | [DevicesMap](./puppeteer.devicesmap.md) | | | [errors](./puppeteer.puppeteer.errors.md) | | [PuppeteerErrors](./puppeteer.puppeteererrors.md) | | | [product](./puppeteer.puppeteer.product.md) | | string | | diff --git a/new-docs/puppeteer.touchscreen._client.md b/new-docs/puppeteer.touchscreen._client.md deleted file mode 100644 index c0e1f1ca..00000000 --- a/new-docs/puppeteer.touchscreen._client.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Touchscreen](./puppeteer.touchscreen.md) > [\_client](./puppeteer.touchscreen._client.md) - -## Touchscreen.\_client property - -Signature: - -```typescript -_client: CDPSession; -``` diff --git a/new-docs/puppeteer.touchscreen._keyboard.md b/new-docs/puppeteer.touchscreen._keyboard.md deleted file mode 100644 index b40e94d3..00000000 --- a/new-docs/puppeteer.touchscreen._keyboard.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Touchscreen](./puppeteer.touchscreen.md) > [\_keyboard](./puppeteer.touchscreen._keyboard.md) - -## Touchscreen.\_keyboard property - -Signature: - -```typescript -_keyboard: Keyboard; -``` diff --git a/new-docs/puppeteer.touchscreen.md b/new-docs/puppeteer.touchscreen.md index e1f7d852..5a079e2b 100644 --- a/new-docs/puppeteer.touchscreen.md +++ b/new-docs/puppeteer.touchscreen.md @@ -16,13 +16,6 @@ export declare class Touchscreen The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Touchscreen` class. -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [\_client](./puppeteer.touchscreen._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | | -| [\_keyboard](./puppeteer.touchscreen._keyboard.md) | | [Keyboard](./puppeteer.keyboard.md) | | - ## Methods | Method | Modifiers | Description | diff --git a/new-docs/puppeteer.tracing.start.md b/new-docs/puppeteer.tracing.start.md index 57651633..bc8a0b7e 100644 --- a/new-docs/puppeteer.tracing.start.md +++ b/new-docs/puppeteer.tracing.start.md @@ -16,7 +16,7 @@ start(options?: TracingOptions): Promise; | Parameter | Type | Description | | --- | --- | --- | -| options | TracingOptions | Optional TracingOptions. | +| options | [TracingOptions](./puppeteer.tracingoptions.md) | Optional TracingOptions. | Returns: diff --git a/new-docs/puppeteer.tracingoptions.categories.md b/new-docs/puppeteer.tracingoptions.categories.md new file mode 100644 index 00000000..1e86ea47 --- /dev/null +++ b/new-docs/puppeteer.tracingoptions.categories.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [TracingOptions](./puppeteer.tracingoptions.md) > [categories](./puppeteer.tracingoptions.categories.md) + +## TracingOptions.categories property + +Signature: + +```typescript +categories?: string[]; +``` diff --git a/new-docs/puppeteer.tracingoptions.md b/new-docs/puppeteer.tracingoptions.md new file mode 100644 index 00000000..07bd1e04 --- /dev/null +++ b/new-docs/puppeteer.tracingoptions.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [TracingOptions](./puppeteer.tracingoptions.md) + +## TracingOptions interface + + +Signature: + +```typescript +export interface TracingOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [categories](./puppeteer.tracingoptions.categories.md) | string\[\] | | +| [path](./puppeteer.tracingoptions.path.md) | string | | +| [screenshots](./puppeteer.tracingoptions.screenshots.md) | boolean | | + diff --git a/new-docs/puppeteer.tracingoptions.path.md b/new-docs/puppeteer.tracingoptions.path.md new file mode 100644 index 00000000..be6b9090 --- /dev/null +++ b/new-docs/puppeteer.tracingoptions.path.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [TracingOptions](./puppeteer.tracingoptions.md) > [path](./puppeteer.tracingoptions.path.md) + +## TracingOptions.path property + +Signature: + +```typescript +path?: string; +``` diff --git a/new-docs/puppeteer.tracingoptions.screenshots.md b/new-docs/puppeteer.tracingoptions.screenshots.md new file mode 100644 index 00000000..39a0f913 --- /dev/null +++ b/new-docs/puppeteer.tracingoptions.screenshots.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [TracingOptions](./puppeteer.tracingoptions.md) > [screenshots](./puppeteer.tracingoptions.screenshots.md) + +## TracingOptions.screenshots property + +Signature: + +```typescript +screenshots?: boolean; +``` diff --git a/src/api-docs-entry.ts b/src/api-docs-entry.ts index 4a04e31c..f4908764 100644 --- a/src/api-docs-entry.ts +++ b/src/api-docs-entry.ts @@ -31,6 +31,7 @@ export * from './node/BrowserFetcher'; export * from './common/Connection'; export * from './common/ConsoleMessage'; export * from './common/Coverage'; +export * from './common/DeviceDescriptors'; export * from './common/Dialog'; export * from './common/JSHandle'; export * from './common/ExecutionContext'; @@ -40,6 +41,8 @@ export * from './common/FrameManager'; export * from './common/Input'; export * from './common/Page'; export * from './common/Puppeteer'; +export * from './node/LaunchOptions'; +export * from './node/Launcher'; export * from './common/HTTPRequest'; export * from './common/HTTPResponse'; export * from './common/SecurityDetails'; diff --git a/src/common/DOMWorld.ts b/src/common/DOMWorld.ts index d265dced..326cdf0b 100644 --- a/src/common/DOMWorld.ts +++ b/src/common/DOMWorld.ts @@ -21,7 +21,7 @@ import { TimeoutError } from './Errors'; import { JSHandle, ElementHandle } from './JSHandle'; import { ExecutionContext } from './ExecutionContext'; import { TimeoutSettings } from './TimeoutSettings'; -import { MouseButtonInput } from './Input'; +import { MouseButton } from './Input'; import { FrameManager, Frame } from './FrameManager'; import { getQueryHandlerAndSelector, QueryHandler } from './QueryHandler'; import { @@ -408,7 +408,7 @@ export class DOMWorld { async click( selector: string, - options: { delay?: number; button?: MouseButtonInput; clickCount?: number } + options: { delay?: number; button?: MouseButton; clickCount?: number } ): Promise { const handle = await this.$(selector); assert(handle, 'No node found for selector: ' + selector); diff --git a/src/common/FrameManager.ts b/src/common/FrameManager.ts index fdd02140..61bbe8be 100644 --- a/src/common/FrameManager.ts +++ b/src/common/FrameManager.ts @@ -25,7 +25,7 @@ import { NetworkManager } from './NetworkManager'; import { TimeoutSettings } from './TimeoutSettings'; import { CDPSession } from './Connection'; import { JSHandle, ElementHandle } from './JSHandle'; -import { MouseButtonInput } from './Input'; +import { MouseButton } from './Input'; import { Page } from './Page'; import { HTTPResponse } from './HTTPResponse'; import Protocol from '../protocol'; @@ -536,7 +536,7 @@ export class Frame { selector: string, options: { delay?: number; - button?: MouseButtonInput; + button?: MouseButton; clickCount?: number; } = {} ): Promise { diff --git a/src/common/Input.ts b/src/common/Input.ts index 4dae85a3..b395170a 100644 --- a/src/common/Input.ts +++ b/src/common/Input.ts @@ -33,7 +33,7 @@ type KeyDescription = Required< * {@link Keyboard.up}, and {@link Keyboard.sendCharacter} * to manually fire events as if they were generated from a real keyboard. * - * On MacOS, keyboard shortcuts like `⌘ A` -> Select All do not work. + * On MacOS, keyboard shortcuts like `⌘ A` -\> Select All do not work. * See {@link https://github.com/puppeteer/puppeteer/issues/1313 | #1313}. * * @example @@ -275,11 +275,16 @@ export class Keyboard { } } -type MouseButton = 'none' | 'left' | 'right' | 'middle'; -export type MouseButtonInput = Exclude; +/** + * @public + */ +export type MouseButton = 'left' | 'right' | 'middle'; -interface MouseOptions { - button?: MouseButtonInput; +/** + * @public + */ +export interface MouseOptions { + button?: MouseButton; clickCount?: number; } @@ -341,11 +346,12 @@ interface MouseOptions { * @public */ export class Mouse { - _client: CDPSession; - _keyboard: Keyboard; - _x = 0; - _y = 0; - _button: MouseButton = 'none'; + private _client: CDPSession; + private _keyboard: Keyboard; + private _x = 0; + private _y = 0; + private _button: MouseButton | 'none' = 'none'; + /** * @internal */ @@ -444,10 +450,11 @@ export class Mouse { /** * The Touchscreen class exposes touchscreen events. + * @public */ export class Touchscreen { - _client: CDPSession; - _keyboard: Keyboard; + private _client: CDPSession; + private _keyboard: Keyboard; /** * @internal diff --git a/src/common/Page.ts b/src/common/Page.ts index 9b550d52..971bbc9f 100644 --- a/src/common/Page.ts +++ b/src/common/Page.ts @@ -23,7 +23,7 @@ import { Connection, CDPSession } from './Connection'; import { Dialog } from './Dialog'; import { EmulationManager } from './EmulationManager'; import { Frame, FrameManager } from './FrameManager'; -import { Keyboard, Mouse, Touchscreen, MouseButtonInput } from './Input'; +import { Keyboard, Mouse, Touchscreen, MouseButton } from './Input'; import { Tracing } from './Tracing'; import { assert } from './assert'; import { helper, debugError } from './helper'; @@ -1557,7 +1557,7 @@ export class Page extends EventEmitter { selector: string, options: { delay?: number; - button?: MouseButtonInput; + button?: MouseButton; clickCount?: number; } = {} ): Promise { diff --git a/src/common/Puppeteer.ts b/src/common/Puppeteer.ts index b43beb97..e4dc0e53 100644 --- a/src/common/Puppeteer.ts +++ b/src/common/Puppeteer.ts @@ -23,8 +23,7 @@ import { ProductLauncher } from '../node/Launcher'; import { BrowserFetcher, BrowserFetcherOptions } from '../node/BrowserFetcher'; import { puppeteerErrors, PuppeteerErrors } from './Errors'; import { ConnectionTransport } from './ConnectionTransport'; -import { devicesMap } from './DeviceDescriptors'; -import { DevicesMap } from './DeviceDescriptors'; +import { devicesMap, DevicesMap } from './DeviceDescriptors'; import { Browser } from './Browser'; import { registerCustomQueryHandler, @@ -137,18 +136,16 @@ export class Puppeteer { /** * @internal */ + get _productName(): string { + return this.__productName; + } + + // don't need any TSDoc here - because the getter is internal the setter is too. set _productName(name: string) { if (this.__productName !== name) this._changedProduct = true; this.__productName = name; } - /** - * @internal - */ - get _productName(): string { - return this.__productName; - } - /** * @remarks * @@ -254,7 +251,7 @@ export class Puppeteer { /** * - * @param options Set of configurable options to set on the browser. + * @param options - Set of configurable options to set on the browser. * @returns The default flags that Chromium will be launched with. */ defaultArgs(options: ChromeArgOptions = {}): string[] { @@ -263,7 +260,7 @@ export class Puppeteer { /** * - * @param options Set of configurable options to specify the settings + * @param options - Set of configurable options to specify the settings * of the BrowserFetcher. * @returns A new BrowserFetcher instance. */ diff --git a/src/common/Target.ts b/src/common/Target.ts index 5a80e801..1a280a2b 100644 --- a/src/common/Target.ts +++ b/src/common/Target.ts @@ -22,6 +22,9 @@ import { Browser, BrowserContext } from './Browser'; import { Viewport } from './PuppeteerViewport'; import Protocol from '../protocol'; +/** + * @public + */ export class Target { private _targetInfo: Protocol.Target.TargetInfo; private _browserContext: BrowserContext; diff --git a/src/common/Tracing.ts b/src/common/Tracing.ts index 673310dd..15b0b14d 100644 --- a/src/common/Tracing.ts +++ b/src/common/Tracing.ts @@ -17,7 +17,10 @@ import { assert } from './assert'; import { helper } from './helper'; import { CDPSession } from './Connection'; -interface TracingOptions { +/** + * @public + */ +export interface TracingOptions { path?: string; screenshots?: boolean; categories?: string[]; @@ -35,6 +38,8 @@ interface TracingOptions { * await page.goto('https://www.google.com'); * await page.tracing.stop(); * ``` + * + * @public */ export class Tracing { _client: CDPSession; diff --git a/src/common/USKeyboardLayout.ts b/src/common/USKeyboardLayout.ts index 69da0355..feb3a1f7 100644 --- a/src/common/USKeyboardLayout.ts +++ b/src/common/USKeyboardLayout.ts @@ -14,6 +14,9 @@ * limitations under the License. */ +/** + * @internal + */ export interface KeyDefinition { keyCode?: number; shiftKeyCode?: number; @@ -25,6 +28,12 @@ export interface KeyDefinition { location?: number; } +/** + * All the valid keys that can be passed to functions that take user input, such + * as {@link Keyboard.press | keyboard.press } + * + * @public + */ export type KeyInput = | '0' | '1' @@ -282,6 +291,9 @@ export type KeyInput = | 'VolumeDown' | 'VolumeUp'; +/** + * @internal + */ export const keyDefinitions: Readonly> = { '0': { keyCode: 48, key: '0', code: 'Digit0' }, '1': { keyCode: 49, key: '1', code: 'Digit1' }, diff --git a/src/common/WebWorker.ts b/src/common/WebWorker.ts index dacdd4ab..c74e1489 100644 --- a/src/common/WebWorker.ts +++ b/src/common/WebWorker.ts @@ -21,11 +21,18 @@ import { CDPSession } from './Connection'; import Protocol from '../protocol'; import { EvaluateHandleFn, SerializableOrJSHandle } from './EvalTypes'; +/** + * @internal + */ type ConsoleAPICalledCallback = ( eventType: string, handles: JSHandle[], trace: Protocol.Runtime.StackTrace ) => void; + +/** + * @internal + */ type ExceptionThrownCallback = ( details: Protocol.Runtime.ExceptionDetails ) => void; @@ -124,8 +131,8 @@ export class WebWorker extends EventEmitter { * non-serializable value, then `worker.evaluate` resolves to `undefined`. * DevTools Protocol also supports transferring some additional values that * are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`, and - * bigint literals. Shortcut for `await - * worker.executionContext()).evaluate(pageFunction, ...args)`. + * bigint literals. + * Shortcut for `await worker.executionContext()).evaluate(pageFunction, ...args)`. * * @param pageFunction - Function to be evaluated in the worker context. * @param args - Arguments to pass to `pageFunction`. diff --git a/src/node/BrowserFetcher.ts b/src/node/BrowserFetcher.ts index 1d729222..f76cc4c2 100644 --- a/src/node/BrowserFetcher.ts +++ b/src/node/BrowserFetcher.ts @@ -62,12 +62,14 @@ const browserConfig = { /** * Supported platforms. + * @public */ -type Platform = 'linux' | 'mac' | 'win32' | 'win64'; +export type Platform = 'linux' | 'mac' | 'win32' | 'win64'; /** * Supported products. + * @public */ -type Product = 'chrome' | 'firefox'; +export type Product = 'chrome' | 'firefox'; function archiveName( product: Product, @@ -128,6 +130,9 @@ function existsAsync(filePath: string): Promise { }); } +/** + * @public + */ export interface BrowserFetcherOptions { platform?: Platform; product?: string; @@ -135,7 +140,10 @@ export interface BrowserFetcherOptions { host?: string; } -interface BrowserFetcherRevisionInfo { +/** + * @public + */ +export interface BrowserFetcherRevisionInfo { folderPath: string; executablePath: string; url: string; diff --git a/src/node/LaunchOptions.ts b/src/node/LaunchOptions.ts index 81548c9c..487020ec 100644 --- a/src/node/LaunchOptions.ts +++ b/src/node/LaunchOptions.ts @@ -16,6 +16,11 @@ import { Viewport } from '../common/PuppeteerViewport'; +/** + * Launcher options that only apply to Chrome. + * + * @public + */ export interface ChromeArgOptions { headless?: boolean; args?: string[]; @@ -23,6 +28,10 @@ export interface ChromeArgOptions { devtools?: boolean; } +/** + * Generic launch options that can be passed when launching any browser. + * @public + */ export interface LaunchOptions { executablePath?: string; ignoreDefaultArgs?: boolean | string[]; @@ -35,6 +44,10 @@ export interface LaunchOptions { pipe?: boolean; } +/** + * Generic browser options that can be passed when launching any browser. + * @public + */ export interface BrowserOptions { ignoreHTTPSErrors?: boolean; defaultViewport?: Viewport; diff --git a/src/node/Launcher.ts b/src/node/Launcher.ts index 804117e7..eb165f19 100644 --- a/src/node/Launcher.ts +++ b/src/node/Launcher.ts @@ -39,6 +39,10 @@ import { BrowserOptions, } from './LaunchOptions'; +/** + * Describes a launcher - a class that is able to create and launch a browser instance. + * @public + */ export interface ProductLauncher { launch(object); connect(object); @@ -47,6 +51,9 @@ export interface ProductLauncher { product: string; } +/** + * @internal + */ class ChromeLauncher implements ProductLauncher { _projectRoot: string; _preferredRevision: string; @@ -267,6 +274,9 @@ class ChromeLauncher implements ProductLauncher { } } +/** + * @internal + */ class FirefoxLauncher implements ProductLauncher { _projectRoot: string; _preferredRevision: string; @@ -766,7 +776,10 @@ function resolveExecutablePath( return { executablePath: revisionInfo.executablePath, missingText }; } -function Launcher( +/** + * @internal + */ +export default function Launcher( projectRoot: string, preferredRevision: string, isPuppeteerCore: boolean, @@ -803,5 +816,3 @@ function Launcher( ); } } - -export default Launcher; diff --git a/utils/doclint/check_public_api/index.js b/utils/doclint/check_public_api/index.js index 1443f52a..d6d04a91 100644 --- a/utils/doclint/check_public_api/index.js +++ b/utils/doclint/check_public_api/index.js @@ -728,6 +728,27 @@ function compareDocumentations(actual, expected) { expectedName: 'JSCoverageOptions', }, ], + [ + 'Method Mouse.click() options.button', + { + actualName: '"left"|"right"|"middle"', + expectedName: 'MouseButton', + }, + ], + [ + 'Method Frame.click() options.button', + { + actualName: '"left"|"right"|"middle"', + expectedName: 'MouseButton', + }, + ], + [ + 'Method Page.click() options.button', + { + actualName: '"left"|"right"|"middle"', + expectedName: 'MouseButton', + }, + ], ]); const expectedForSource = expectedNamingMismatches.get(source);