diff --git a/new-docs/index.md b/new-docs/index.md new file mode 100644 index 00000000000..bf79876235e --- /dev/null +++ b/new-docs/index.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) + +## API Reference + +## Packages + +| Package | Description | +| --- | --- | +| [puppeteer](./puppeteer.md) | | + diff --git a/new-docs/puppeteer.accessibility._constructor_.md b/new-docs/puppeteer.accessibility._constructor_.md new file mode 100644 index 00000000000..2ad712d61bf --- /dev/null +++ b/new-docs/puppeteer.accessibility._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Accessibility](./puppeteer.accessibility.md) > [(constructor)](./puppeteer.accessibility._constructor_.md) + +## Accessibility.(constructor) + +Constructs a new instance of the `Accessibility` class + +Signature: + +```typescript +constructor(client: CDPSession); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | + diff --git a/new-docs/puppeteer.accessibility.md b/new-docs/puppeteer.accessibility.md new file mode 100644 index 00000000000..2d405b15819 --- /dev/null +++ b/new-docs/puppeteer.accessibility.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Accessibility](./puppeteer.accessibility.md) + +## Accessibility class + +Signature: + +```typescript +export declare class Accessibility +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(client)](./puppeteer.accessibility._constructor_.md) | | Constructs a new instance of the Accessibility class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [snapshot(options)](./puppeteer.accessibility.snapshot.md) | | | + diff --git a/new-docs/puppeteer.accessibility.snapshot.md b/new-docs/puppeteer.accessibility.snapshot.md new file mode 100644 index 00000000000..a00d01db87b --- /dev/null +++ b/new-docs/puppeteer.accessibility.snapshot.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Accessibility](./puppeteer.accessibility.md) > [snapshot](./puppeteer.accessibility.snapshot.md) + +## Accessibility.snapshot() method + +Signature: + +```typescript +snapshot(options?: { + interestingOnly?: boolean; + root?: ElementHandle; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | { interestingOnly?: boolean; root?: [ElementHandle](./puppeteer.elementhandle.md); } | | + +Returns: + +Promise<SerializedAXNode> + diff --git a/new-docs/puppeteer.browser._closecallback.md b/new-docs/puppeteer.browser._closecallback.md new file mode 100644 index 00000000000..bd2ea2d4a0e --- /dev/null +++ b/new-docs/puppeteer.browser._closecallback.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_closeCallback](./puppeteer.browser._closecallback.md) + +## Browser.\_closeCallback property + +Signature: + +```typescript +_closeCallback: BrowserCloseCallback; +``` diff --git a/new-docs/puppeteer.browser._connection.md b/new-docs/puppeteer.browser._connection.md new file mode 100644 index 00000000000..d5276e720e2 --- /dev/null +++ b/new-docs/puppeteer.browser._connection.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_connection](./puppeteer.browser._connection.md) + +## Browser.\_connection property + +Signature: + +```typescript +_connection: Connection; +``` diff --git a/new-docs/puppeteer.browser._constructor_.md b/new-docs/puppeteer.browser._constructor_.md new file mode 100644 index 00000000000..c6c556928fb --- /dev/null +++ b/new-docs/puppeteer.browser._constructor_.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [(constructor)](./puppeteer.browser._constructor_.md) + +## Browser.(constructor) + +Constructs a new instance of the `Browser` class + +Signature: + +```typescript +constructor(connection: Connection, contextIds: string[], ignoreHTTPSErrors: boolean, defaultViewport?: Viewport, process?: ChildProcess, closeCallback?: BrowserCloseCallback); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| connection | [Connection](./puppeteer.connection.md) | | +| contextIds | string\[\] | | +| ignoreHTTPSErrors | boolean | | +| defaultViewport | Viewport | | +| process | ChildProcess | | +| closeCallback | BrowserCloseCallback | | + diff --git a/new-docs/puppeteer.browser._contexts.md b/new-docs/puppeteer.browser._contexts.md new file mode 100644 index 00000000000..6a1cde679a9 --- /dev/null +++ b/new-docs/puppeteer.browser._contexts.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_contexts](./puppeteer.browser._contexts.md) + +## Browser.\_contexts property + +Signature: + +```typescript +_contexts: Map; +``` diff --git a/new-docs/puppeteer.browser._createpageincontext.md b/new-docs/puppeteer.browser._createpageincontext.md new file mode 100644 index 00000000000..ad5848d12dd --- /dev/null +++ b/new-docs/puppeteer.browser._createpageincontext.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_createPageInContext](./puppeteer.browser._createpageincontext.md) + +## Browser.\_createPageInContext() method + +Signature: + +```typescript +_createPageInContext(contextId?: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| contextId | string | | + +Returns: + +Promise<[Page](./puppeteer.page.md)> + diff --git a/new-docs/puppeteer.browser._defaultcontext.md b/new-docs/puppeteer.browser._defaultcontext.md new file mode 100644 index 00000000000..46ae76abdf4 --- /dev/null +++ b/new-docs/puppeteer.browser._defaultcontext.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_defaultContext](./puppeteer.browser._defaultcontext.md) + +## Browser.\_defaultContext property + +Signature: + +```typescript +_defaultContext: BrowserContext; +``` diff --git a/new-docs/puppeteer.browser._defaultviewport.md b/new-docs/puppeteer.browser._defaultviewport.md new file mode 100644 index 00000000000..6495f7261b8 --- /dev/null +++ b/new-docs/puppeteer.browser._defaultviewport.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_defaultViewport](./puppeteer.browser._defaultviewport.md) + +## Browser.\_defaultViewport property + +Signature: + +```typescript +_defaultViewport?: Viewport; +``` diff --git a/new-docs/puppeteer.browser._disposecontext.md b/new-docs/puppeteer.browser._disposecontext.md new file mode 100644 index 00000000000..5268a1fdab0 --- /dev/null +++ b/new-docs/puppeteer.browser._disposecontext.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_disposeContext](./puppeteer.browser._disposecontext.md) + +## Browser.\_disposeContext() method + +Signature: + +```typescript +_disposeContext(contextId?: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| contextId | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.browser._getversion.md b/new-docs/puppeteer.browser._getversion.md new file mode 100644 index 00000000000..e9d29e39cb2 --- /dev/null +++ b/new-docs/puppeteer.browser._getversion.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_getVersion](./puppeteer.browser._getversion.md) + +## Browser.\_getVersion() method + +Signature: + +```typescript +_getVersion(): Promise; +``` +Returns: + +Promise<Protocol.Browser.getVersionReturnValue> + diff --git a/new-docs/puppeteer.browser._ignorehttpserrors.md b/new-docs/puppeteer.browser._ignorehttpserrors.md new file mode 100644 index 00000000000..f32cfb41d66 --- /dev/null +++ b/new-docs/puppeteer.browser._ignorehttpserrors.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_ignoreHTTPSErrors](./puppeteer.browser._ignorehttpserrors.md) + +## Browser.\_ignoreHTTPSErrors property + +Signature: + +```typescript +_ignoreHTTPSErrors: boolean; +``` diff --git a/new-docs/puppeteer.browser._process.md b/new-docs/puppeteer.browser._process.md new file mode 100644 index 00000000000..bda68890ea1 --- /dev/null +++ b/new-docs/puppeteer.browser._process.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_process](./puppeteer.browser._process.md) + +## Browser.\_process property + +Signature: + +```typescript +_process?: ChildProcess; +``` diff --git a/new-docs/puppeteer.browser._targetcreated.md b/new-docs/puppeteer.browser._targetcreated.md new file mode 100644 index 00000000000..c69a464f637 --- /dev/null +++ b/new-docs/puppeteer.browser._targetcreated.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_targetCreated](./puppeteer.browser._targetcreated.md) + +## Browser.\_targetCreated() method + +Signature: + +```typescript +_targetCreated(event: Protocol.Target.targetCreatedPayload): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | Protocol.Target.targetCreatedPayload | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.browser._targetdestroyed.md b/new-docs/puppeteer.browser._targetdestroyed.md new file mode 100644 index 00000000000..59b72e52326 --- /dev/null +++ b/new-docs/puppeteer.browser._targetdestroyed.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_targetDestroyed](./puppeteer.browser._targetdestroyed.md) + +## Browser.\_targetDestroyed() method + +Signature: + +```typescript +_targetDestroyed(event: { + targetId: string; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | { targetId: string; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.browser._targetinfochanged.md b/new-docs/puppeteer.browser._targetinfochanged.md new file mode 100644 index 00000000000..b2469edaa5b --- /dev/null +++ b/new-docs/puppeteer.browser._targetinfochanged.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_targetInfoChanged](./puppeteer.browser._targetinfochanged.md) + +## Browser.\_targetInfoChanged() method + +Signature: + +```typescript +_targetInfoChanged(event: Protocol.Target.targetInfoChangedPayload): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | Protocol.Target.targetInfoChangedPayload | | + +Returns: + +void + diff --git a/new-docs/puppeteer.browser._targets.md b/new-docs/puppeteer.browser._targets.md new file mode 100644 index 00000000000..97d7b2bd182 --- /dev/null +++ b/new-docs/puppeteer.browser._targets.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [\_targets](./puppeteer.browser._targets.md) + +## Browser.\_targets property + +Signature: + +```typescript +_targets: Map; +``` diff --git a/new-docs/puppeteer.browser.browsercontexts.md b/new-docs/puppeteer.browser.browsercontexts.md new file mode 100644 index 00000000000..0928f7585ac --- /dev/null +++ b/new-docs/puppeteer.browser.browsercontexts.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [browserContexts](./puppeteer.browser.browsercontexts.md) + +## Browser.browserContexts() method + +Signature: + +```typescript +browserContexts(): BrowserContext[]; +``` +Returns: + +[BrowserContext](./puppeteer.browsercontext.md)\[\] + diff --git a/new-docs/puppeteer.browser.close.md b/new-docs/puppeteer.browser.close.md new file mode 100644 index 00000000000..67c9289f9fa --- /dev/null +++ b/new-docs/puppeteer.browser.close.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [close](./puppeteer.browser.close.md) + +## Browser.close() method + +Signature: + +```typescript +close(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.browser.create.md b/new-docs/puppeteer.browser.create.md new file mode 100644 index 00000000000..0774e2ffccc --- /dev/null +++ b/new-docs/puppeteer.browser.create.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [create](./puppeteer.browser.create.md) + +## Browser.create() method + +Signature: + +```typescript +static create(connection: Connection, contextIds: string[], ignoreHTTPSErrors: boolean, defaultViewport?: Viewport, process?: ChildProcess, closeCallback?: BrowserCloseCallback): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| connection | [Connection](./puppeteer.connection.md) | | +| contextIds | string\[\] | | +| ignoreHTTPSErrors | boolean | | +| defaultViewport | Viewport | | +| process | ChildProcess | | +| closeCallback | BrowserCloseCallback | | + +Returns: + +Promise<[Browser](./puppeteer.browser.md)> + diff --git a/new-docs/puppeteer.browser.createincognitobrowsercontext.md b/new-docs/puppeteer.browser.createincognitobrowsercontext.md new file mode 100644 index 00000000000..bc7349cede0 --- /dev/null +++ b/new-docs/puppeteer.browser.createincognitobrowsercontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [createIncognitoBrowserContext](./puppeteer.browser.createincognitobrowsercontext.md) + +## Browser.createIncognitoBrowserContext() method + +Signature: + +```typescript +createIncognitoBrowserContext(): Promise; +``` +Returns: + +Promise<[BrowserContext](./puppeteer.browsercontext.md)> + diff --git a/new-docs/puppeteer.browser.defaultbrowsercontext.md b/new-docs/puppeteer.browser.defaultbrowsercontext.md new file mode 100644 index 00000000000..2c89a3f13c2 --- /dev/null +++ b/new-docs/puppeteer.browser.defaultbrowsercontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [defaultBrowserContext](./puppeteer.browser.defaultbrowsercontext.md) + +## Browser.defaultBrowserContext() method + +Signature: + +```typescript +defaultBrowserContext(): BrowserContext; +``` +Returns: + +[BrowserContext](./puppeteer.browsercontext.md) + diff --git a/new-docs/puppeteer.browser.disconnect.md b/new-docs/puppeteer.browser.disconnect.md new file mode 100644 index 00000000000..56e9d73ec5e --- /dev/null +++ b/new-docs/puppeteer.browser.disconnect.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [disconnect](./puppeteer.browser.disconnect.md) + +## Browser.disconnect() method + +Signature: + +```typescript +disconnect(): void; +``` +Returns: + +void + diff --git a/new-docs/puppeteer.browser.isconnected.md b/new-docs/puppeteer.browser.isconnected.md new file mode 100644 index 00000000000..6e5dfd212bc --- /dev/null +++ b/new-docs/puppeteer.browser.isconnected.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [isConnected](./puppeteer.browser.isconnected.md) + +## Browser.isConnected() method + +Signature: + +```typescript +isConnected(): boolean; +``` +Returns: + +boolean + diff --git a/new-docs/puppeteer.browser.md b/new-docs/puppeteer.browser.md new file mode 100644 index 00000000000..d04f7335c0a --- /dev/null +++ b/new-docs/puppeteer.browser.md @@ -0,0 +1,58 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) + +## Browser class + +Signature: + +```typescript +export declare class Browser extends EventEmitter +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(connection, contextIds, ignoreHTTPSErrors, defaultViewport, process, closeCallback)](./puppeteer.browser._constructor_.md) | | Constructs a new instance of the Browser class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_closeCallback](./puppeteer.browser._closecallback.md) | | BrowserCloseCallback | | +| [\_connection](./puppeteer.browser._connection.md) | | [Connection](./puppeteer.connection.md) | | +| [\_contexts](./puppeteer.browser._contexts.md) | | Map<string, [BrowserContext](./puppeteer.browsercontext.md)> | | +| [\_defaultContext](./puppeteer.browser._defaultcontext.md) | | [BrowserContext](./puppeteer.browsercontext.md) | | +| [\_defaultViewport](./puppeteer.browser._defaultviewport.md) | | Viewport | | +| [\_ignoreHTTPSErrors](./puppeteer.browser._ignorehttpserrors.md) | | boolean | | +| [\_process](./puppeteer.browser._process.md) | | ChildProcess | | +| [\_targets](./puppeteer.browser._targets.md) | | Map<string, [Target](./puppeteer.target.md)> | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_createPageInContext(contextId)](./puppeteer.browser._createpageincontext.md) | | | +| [\_disposeContext(contextId)](./puppeteer.browser._disposecontext.md) | | | +| [\_getVersion()](./puppeteer.browser._getversion.md) | | | +| [\_targetCreated(event)](./puppeteer.browser._targetcreated.md) | | | +| [\_targetDestroyed(event)](./puppeteer.browser._targetdestroyed.md) | | | +| [\_targetInfoChanged(event)](./puppeteer.browser._targetinfochanged.md) | | | +| [browserContexts()](./puppeteer.browser.browsercontexts.md) | | | +| [close()](./puppeteer.browser.close.md) | | | +| [create(connection, contextIds, ignoreHTTPSErrors, defaultViewport, process, closeCallback)](./puppeteer.browser.create.md) | static | | +| [createIncognitoBrowserContext()](./puppeteer.browser.createincognitobrowsercontext.md) | | | +| [defaultBrowserContext()](./puppeteer.browser.defaultbrowsercontext.md) | | | +| [disconnect()](./puppeteer.browser.disconnect.md) | | | +| [isConnected()](./puppeteer.browser.isconnected.md) | | | +| [newPage()](./puppeteer.browser.newpage.md) | | | +| [pages()](./puppeteer.browser.pages.md) | | | +| [process()](./puppeteer.browser.process.md) | | | +| [target()](./puppeteer.browser.target.md) | | | +| [targets()](./puppeteer.browser.targets.md) | | | +| [userAgent()](./puppeteer.browser.useragent.md) | | | +| [version()](./puppeteer.browser.version.md) | | | +| [waitForTarget(predicate, options)](./puppeteer.browser.waitfortarget.md) | | | +| [wsEndpoint()](./puppeteer.browser.wsendpoint.md) | | | + diff --git a/new-docs/puppeteer.browser.newpage.md b/new-docs/puppeteer.browser.newpage.md new file mode 100644 index 00000000000..3a17599b57a --- /dev/null +++ b/new-docs/puppeteer.browser.newpage.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [newPage](./puppeteer.browser.newpage.md) + +## Browser.newPage() method + +Signature: + +```typescript +newPage(): Promise; +``` +Returns: + +Promise<[Page](./puppeteer.page.md)> + diff --git a/new-docs/puppeteer.browser.pages.md b/new-docs/puppeteer.browser.pages.md new file mode 100644 index 00000000000..a1632c90446 --- /dev/null +++ b/new-docs/puppeteer.browser.pages.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [pages](./puppeteer.browser.pages.md) + +## Browser.pages() method + +Signature: + +```typescript +pages(): Promise; +``` +Returns: + +Promise<[Page](./puppeteer.page.md)\[\]> + diff --git a/new-docs/puppeteer.browser.process.md b/new-docs/puppeteer.browser.process.md new file mode 100644 index 00000000000..39efa143fd0 --- /dev/null +++ b/new-docs/puppeteer.browser.process.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [process](./puppeteer.browser.process.md) + +## Browser.process() method + +Signature: + +```typescript +process(): ChildProcess | null; +``` +Returns: + +ChildProcess \| null + diff --git a/new-docs/puppeteer.browser.target.md b/new-docs/puppeteer.browser.target.md new file mode 100644 index 00000000000..399cdcfe280 --- /dev/null +++ b/new-docs/puppeteer.browser.target.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [target](./puppeteer.browser.target.md) + +## Browser.target() method + +Signature: + +```typescript +target(): Target; +``` +Returns: + +[Target](./puppeteer.target.md) + diff --git a/new-docs/puppeteer.browser.targets.md b/new-docs/puppeteer.browser.targets.md new file mode 100644 index 00000000000..ac514b2d248 --- /dev/null +++ b/new-docs/puppeteer.browser.targets.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [targets](./puppeteer.browser.targets.md) + +## Browser.targets() method + +Signature: + +```typescript +targets(): Target[]; +``` +Returns: + +[Target](./puppeteer.target.md)\[\] + diff --git a/new-docs/puppeteer.browser.useragent.md b/new-docs/puppeteer.browser.useragent.md new file mode 100644 index 00000000000..9f1f852606b --- /dev/null +++ b/new-docs/puppeteer.browser.useragent.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [userAgent](./puppeteer.browser.useragent.md) + +## Browser.userAgent() method + +Signature: + +```typescript +userAgent(): Promise; +``` +Returns: + +Promise<string> + diff --git a/new-docs/puppeteer.browser.version.md b/new-docs/puppeteer.browser.version.md new file mode 100644 index 00000000000..069c2af31f9 --- /dev/null +++ b/new-docs/puppeteer.browser.version.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [version](./puppeteer.browser.version.md) + +## Browser.version() method + +Signature: + +```typescript +version(): Promise; +``` +Returns: + +Promise<string> + diff --git a/new-docs/puppeteer.browser.waitfortarget.md b/new-docs/puppeteer.browser.waitfortarget.md new file mode 100644 index 00000000000..8469689b743 --- /dev/null +++ b/new-docs/puppeteer.browser.waitfortarget.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [waitForTarget](./puppeteer.browser.waitfortarget.md) + +## Browser.waitForTarget() method + +Signature: + +```typescript +waitForTarget(predicate: (x: Target) => boolean, options?: { + timeout?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| predicate | (x: [Target](./puppeteer.target.md)) => boolean | | +| options | { timeout?: number; } | {!Promise<!Target>} | + +Returns: + +Promise<[Target](./puppeteer.target.md)> + diff --git a/new-docs/puppeteer.browser.wsendpoint.md b/new-docs/puppeteer.browser.wsendpoint.md new file mode 100644 index 00000000000..349e6e5ac76 --- /dev/null +++ b/new-docs/puppeteer.browser.wsendpoint.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [wsEndpoint](./puppeteer.browser.wsendpoint.md) + +## Browser.wsEndpoint() method + +Signature: + +```typescript +wsEndpoint(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.browsercontext._browser.md b/new-docs/puppeteer.browsercontext._browser.md new file mode 100644 index 00000000000..159f43c3131 --- /dev/null +++ b/new-docs/puppeteer.browsercontext._browser.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [\_browser](./puppeteer.browsercontext._browser.md) + +## BrowserContext.\_browser property + +Signature: + +```typescript +_browser: Browser; +``` diff --git a/new-docs/puppeteer.browsercontext._connection.md b/new-docs/puppeteer.browsercontext._connection.md new file mode 100644 index 00000000000..63309bbd6ac --- /dev/null +++ b/new-docs/puppeteer.browsercontext._connection.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [\_connection](./puppeteer.browsercontext._connection.md) + +## BrowserContext.\_connection property + +Signature: + +```typescript +_connection: Connection; +``` diff --git a/new-docs/puppeteer.browsercontext._constructor_.md b/new-docs/puppeteer.browsercontext._constructor_.md new file mode 100644 index 00000000000..e9372622d11 --- /dev/null +++ b/new-docs/puppeteer.browsercontext._constructor_.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [(constructor)](./puppeteer.browsercontext._constructor_.md) + +## BrowserContext.(constructor) + +Constructs a new instance of the `BrowserContext` class + +Signature: + +```typescript +constructor(connection: Connection, browser: Browser, contextId?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| connection | [Connection](./puppeteer.connection.md) | | +| browser | [Browser](./puppeteer.browser.md) | | +| contextId | string | | + diff --git a/new-docs/puppeteer.browsercontext._id.md b/new-docs/puppeteer.browsercontext._id.md new file mode 100644 index 00000000000..f238969a795 --- /dev/null +++ b/new-docs/puppeteer.browsercontext._id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [\_id](./puppeteer.browsercontext._id.md) + +## BrowserContext.\_id property + +Signature: + +```typescript +_id?: string; +``` diff --git a/new-docs/puppeteer.browsercontext.browser.md b/new-docs/puppeteer.browsercontext.browser.md new file mode 100644 index 00000000000..fcf10e94eb7 --- /dev/null +++ b/new-docs/puppeteer.browsercontext.browser.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [browser](./puppeteer.browsercontext.browser.md) + +## BrowserContext.browser() method + +Signature: + +```typescript +browser(): Browser; +``` +Returns: + +[Browser](./puppeteer.browser.md) + diff --git a/new-docs/puppeteer.browsercontext.clearpermissionoverrides.md b/new-docs/puppeteer.browsercontext.clearpermissionoverrides.md new file mode 100644 index 00000000000..1dfbd4ceb98 --- /dev/null +++ b/new-docs/puppeteer.browsercontext.clearpermissionoverrides.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [clearPermissionOverrides](./puppeteer.browsercontext.clearpermissionoverrides.md) + +## BrowserContext.clearPermissionOverrides() method + +Signature: + +```typescript +clearPermissionOverrides(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.browsercontext.close.md b/new-docs/puppeteer.browsercontext.close.md new file mode 100644 index 00000000000..21916a420fb --- /dev/null +++ b/new-docs/puppeteer.browsercontext.close.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [close](./puppeteer.browsercontext.close.md) + +## BrowserContext.close() method + +Signature: + +```typescript +close(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.browsercontext.isincognito.md b/new-docs/puppeteer.browsercontext.isincognito.md new file mode 100644 index 00000000000..bd509073295 --- /dev/null +++ b/new-docs/puppeteer.browsercontext.isincognito.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [isIncognito](./puppeteer.browsercontext.isincognito.md) + +## BrowserContext.isIncognito() method + +Signature: + +```typescript +isIncognito(): boolean; +``` +Returns: + +boolean + diff --git a/new-docs/puppeteer.browsercontext.md b/new-docs/puppeteer.browsercontext.md new file mode 100644 index 00000000000..68a9b828447 --- /dev/null +++ b/new-docs/puppeteer.browsercontext.md @@ -0,0 +1,40 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) + +## BrowserContext class + +Signature: + +```typescript +export declare class BrowserContext extends EventEmitter +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(connection, browser, contextId)](./puppeteer.browsercontext._constructor_.md) | | Constructs a new instance of the BrowserContext class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_browser](./puppeteer.browsercontext._browser.md) | | [Browser](./puppeteer.browser.md) | | +| [\_connection](./puppeteer.browsercontext._connection.md) | | [Connection](./puppeteer.connection.md) | | +| [\_id](./puppeteer.browsercontext._id.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [browser()](./puppeteer.browsercontext.browser.md) | | | +| [clearPermissionOverrides()](./puppeteer.browsercontext.clearpermissionoverrides.md) | | | +| [close()](./puppeteer.browsercontext.close.md) | | | +| [isIncognito()](./puppeteer.browsercontext.isincognito.md) | | | +| [newPage()](./puppeteer.browsercontext.newpage.md) | | | +| [overridePermissions(origin, permissions)](./puppeteer.browsercontext.overridepermissions.md) | | | +| [pages()](./puppeteer.browsercontext.pages.md) | | | +| [targets()](./puppeteer.browsercontext.targets.md) | | | +| [waitForTarget(predicate, options)](./puppeteer.browsercontext.waitfortarget.md) | | | + diff --git a/new-docs/puppeteer.browsercontext.newpage.md b/new-docs/puppeteer.browsercontext.newpage.md new file mode 100644 index 00000000000..dd176f89150 --- /dev/null +++ b/new-docs/puppeteer.browsercontext.newpage.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [newPage](./puppeteer.browsercontext.newpage.md) + +## BrowserContext.newPage() method + +Signature: + +```typescript +newPage(): Promise; +``` +Returns: + +Promise<[Page](./puppeteer.page.md)> + diff --git a/new-docs/puppeteer.browsercontext.overridepermissions.md b/new-docs/puppeteer.browsercontext.overridepermissions.md new file mode 100644 index 00000000000..a917a22fc35 --- /dev/null +++ b/new-docs/puppeteer.browsercontext.overridepermissions.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [overridePermissions](./puppeteer.browsercontext.overridepermissions.md) + +## BrowserContext.overridePermissions() method + +Signature: + +```typescript +overridePermissions(origin: string, permissions: Protocol.Browser.PermissionType[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| origin | string | | +| permissions | Protocol.Browser.PermissionType\[\] | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.browsercontext.pages.md b/new-docs/puppeteer.browsercontext.pages.md new file mode 100644 index 00000000000..0fc2ac1807a --- /dev/null +++ b/new-docs/puppeteer.browsercontext.pages.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [pages](./puppeteer.browsercontext.pages.md) + +## BrowserContext.pages() method + +Signature: + +```typescript +pages(): Promise; +``` +Returns: + +Promise<[Page](./puppeteer.page.md)\[\]> + diff --git a/new-docs/puppeteer.browsercontext.targets.md b/new-docs/puppeteer.browsercontext.targets.md new file mode 100644 index 00000000000..05f76d59142 --- /dev/null +++ b/new-docs/puppeteer.browsercontext.targets.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [targets](./puppeteer.browsercontext.targets.md) + +## BrowserContext.targets() method + +Signature: + +```typescript +targets(): Target[]; +``` +Returns: + +[Target](./puppeteer.target.md)\[\] + diff --git a/new-docs/puppeteer.browsercontext.waitfortarget.md b/new-docs/puppeteer.browsercontext.waitfortarget.md new file mode 100644 index 00000000000..f1d3b24520d --- /dev/null +++ b/new-docs/puppeteer.browsercontext.waitfortarget.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [waitForTarget](./puppeteer.browsercontext.waitfortarget.md) + +## BrowserContext.waitForTarget() method + +Signature: + +```typescript +waitForTarget(predicate: (x: Target) => boolean, options: { + timeout?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| predicate | (x: [Target](./puppeteer.target.md)) => boolean | | +| options | { timeout?: number; } | | + +Returns: + +Promise<[Target](./puppeteer.target.md)> + diff --git a/new-docs/puppeteer.browserfetcher._constructor_.md b/new-docs/puppeteer.browserfetcher._constructor_.md new file mode 100644 index 00000000000..13d9d5549c0 --- /dev/null +++ b/new-docs/puppeteer.browserfetcher._constructor_.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [(constructor)](./puppeteer.browserfetcher._constructor_.md) + +## BrowserFetcher.(constructor) + +Constructs a new instance of the `BrowserFetcher` class + +Signature: + +```typescript +constructor(projectRoot: string, options?: BrowserFetcherOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| projectRoot | string | | +| options | [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) | | + diff --git a/new-docs/puppeteer.browserfetcher._getfolderpath.md b/new-docs/puppeteer.browserfetcher._getfolderpath.md new file mode 100644 index 00000000000..202f189fc8d --- /dev/null +++ b/new-docs/puppeteer.browserfetcher._getfolderpath.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [\_getFolderPath](./puppeteer.browserfetcher._getfolderpath.md) + +## BrowserFetcher.\_getFolderPath() method + +Signature: + +```typescript +_getFolderPath(revision: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| revision | string | {string} | + +Returns: + +string + diff --git a/new-docs/puppeteer.browserfetcher.candownload.md b/new-docs/puppeteer.browserfetcher.candownload.md new file mode 100644 index 00000000000..323ba86e7ca --- /dev/null +++ b/new-docs/puppeteer.browserfetcher.candownload.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [canDownload](./puppeteer.browserfetcher.candownload.md) + +## BrowserFetcher.canDownload() method + +Signature: + +```typescript +canDownload(revision: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| revision | string | | + +Returns: + +Promise<boolean> + diff --git a/new-docs/puppeteer.browserfetcher.download.md b/new-docs/puppeteer.browserfetcher.download.md new file mode 100644 index 00000000000..71106ac303f --- /dev/null +++ b/new-docs/puppeteer.browserfetcher.download.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [download](./puppeteer.browserfetcher.download.md) + +## BrowserFetcher.download() method + +Signature: + +```typescript +download(revision: string, progressCallback: (x: number, y: number) => void): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| revision | string | | +| progressCallback | (x: number, y: number) => void | {!Promise<!BrowserFetcher.RevisionInfo>} | + +Returns: + +Promise<BrowserFetcherRevisionInfo> + diff --git a/new-docs/puppeteer.browserfetcher.host.md b/new-docs/puppeteer.browserfetcher.host.md new file mode 100644 index 00000000000..1a342db6319 --- /dev/null +++ b/new-docs/puppeteer.browserfetcher.host.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [host](./puppeteer.browserfetcher.host.md) + +## BrowserFetcher.host() method + +Signature: + +```typescript +host(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.browserfetcher.localrevisions.md b/new-docs/puppeteer.browserfetcher.localrevisions.md new file mode 100644 index 00000000000..78db4f48f9e --- /dev/null +++ b/new-docs/puppeteer.browserfetcher.localrevisions.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [localRevisions](./puppeteer.browserfetcher.localrevisions.md) + +## BrowserFetcher.localRevisions() method + +Signature: + +```typescript +localRevisions(): Promise; +``` +Returns: + +Promise<string\[\]> + diff --git a/new-docs/puppeteer.browserfetcher.md b/new-docs/puppeteer.browserfetcher.md new file mode 100644 index 00000000000..82777b00445 --- /dev/null +++ b/new-docs/puppeteer.browserfetcher.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) + +## BrowserFetcher class + +Signature: + +```typescript +export declare class BrowserFetcher +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(projectRoot, options)](./puppeteer.browserfetcher._constructor_.md) | | Constructs a new instance of the BrowserFetcher class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_getFolderPath(revision)](./puppeteer.browserfetcher._getfolderpath.md) | | | +| [canDownload(revision)](./puppeteer.browserfetcher.candownload.md) | | | +| [download(revision, progressCallback)](./puppeteer.browserfetcher.download.md) | | | +| [host()](./puppeteer.browserfetcher.host.md) | | | +| [localRevisions()](./puppeteer.browserfetcher.localrevisions.md) | | | +| [platform()](./puppeteer.browserfetcher.platform.md) | | | +| [product()](./puppeteer.browserfetcher.product.md) | | | +| [remove(revision)](./puppeteer.browserfetcher.remove.md) | | | +| [revisionInfo(revision)](./puppeteer.browserfetcher.revisioninfo.md) | | | + diff --git a/new-docs/puppeteer.browserfetcher.platform.md b/new-docs/puppeteer.browserfetcher.platform.md new file mode 100644 index 00000000000..b48185e5ba4 --- /dev/null +++ b/new-docs/puppeteer.browserfetcher.platform.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [platform](./puppeteer.browserfetcher.platform.md) + +## BrowserFetcher.platform() method + +Signature: + +```typescript +platform(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.browserfetcher.product.md b/new-docs/puppeteer.browserfetcher.product.md new file mode 100644 index 00000000000..a8bf2223e15 --- /dev/null +++ b/new-docs/puppeteer.browserfetcher.product.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [product](./puppeteer.browserfetcher.product.md) + +## BrowserFetcher.product() method + +Signature: + +```typescript +product(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.browserfetcher.remove.md b/new-docs/puppeteer.browserfetcher.remove.md new file mode 100644 index 00000000000..1343c6f0c87 --- /dev/null +++ b/new-docs/puppeteer.browserfetcher.remove.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [remove](./puppeteer.browserfetcher.remove.md) + +## BrowserFetcher.remove() method + +Signature: + +```typescript +remove(revision: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| revision | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.browserfetcher.revisioninfo.md b/new-docs/puppeteer.browserfetcher.revisioninfo.md new file mode 100644 index 00000000000..2586b24a6ad --- /dev/null +++ b/new-docs/puppeteer.browserfetcher.revisioninfo.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [revisionInfo](./puppeteer.browserfetcher.revisioninfo.md) + +## BrowserFetcher.revisionInfo() method + +Signature: + +```typescript +revisionInfo(revision: string): BrowserFetcherRevisionInfo; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| revision | string | | + +Returns: + +BrowserFetcherRevisionInfo + diff --git a/new-docs/puppeteer.browserfetcheroptions.host.md b/new-docs/puppeteer.browserfetcheroptions.host.md new file mode 100644 index 00000000000..bdf86cb82e7 --- /dev/null +++ b/new-docs/puppeteer.browserfetcheroptions.host.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) > [host](./puppeteer.browserfetcheroptions.host.md) + +## BrowserFetcherOptions.host property + +Signature: + +```typescript +host?: string; +``` diff --git a/new-docs/puppeteer.browserfetcheroptions.md b/new-docs/puppeteer.browserfetcheroptions.md new file mode 100644 index 00000000000..71205e55d95 --- /dev/null +++ b/new-docs/puppeteer.browserfetcheroptions.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) + +## BrowserFetcherOptions interface + +Signature: + +```typescript +export interface BrowserFetcherOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [host](./puppeteer.browserfetcheroptions.host.md) | string | | +| [path](./puppeteer.browserfetcheroptions.path.md) | string | | +| [platform](./puppeteer.browserfetcheroptions.platform.md) | Platform | | +| [product](./puppeteer.browserfetcheroptions.product.md) | string | | + diff --git a/new-docs/puppeteer.browserfetcheroptions.path.md b/new-docs/puppeteer.browserfetcheroptions.path.md new file mode 100644 index 00000000000..ea0fd9d1d40 --- /dev/null +++ b/new-docs/puppeteer.browserfetcheroptions.path.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) > [path](./puppeteer.browserfetcheroptions.path.md) + +## BrowserFetcherOptions.path property + +Signature: + +```typescript +path?: string; +``` diff --git a/new-docs/puppeteer.browserfetcheroptions.platform.md b/new-docs/puppeteer.browserfetcheroptions.platform.md new file mode 100644 index 00000000000..cec53aab2d3 --- /dev/null +++ b/new-docs/puppeteer.browserfetcheroptions.platform.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) > [platform](./puppeteer.browserfetcheroptions.platform.md) + +## BrowserFetcherOptions.platform property + +Signature: + +```typescript +platform?: Platform; +``` diff --git a/new-docs/puppeteer.browserfetcheroptions.product.md b/new-docs/puppeteer.browserfetcheroptions.product.md new file mode 100644 index 00000000000..e7125e46007 --- /dev/null +++ b/new-docs/puppeteer.browserfetcheroptions.product.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) > [product](./puppeteer.browserfetcheroptions.product.md) + +## BrowserFetcherOptions.product property + +Signature: + +```typescript +product?: string; +``` diff --git a/new-docs/puppeteer.cdpsession._callbacks.md b/new-docs/puppeteer.cdpsession._callbacks.md new file mode 100644 index 00000000000..2bf6a5ac7f0 --- /dev/null +++ b/new-docs/puppeteer.cdpsession._callbacks.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) > [\_callbacks](./puppeteer.cdpsession._callbacks.md) + +## CDPSession.\_callbacks property + +Signature: + +```typescript +_callbacks: Map; +``` diff --git a/new-docs/puppeteer.cdpsession._connection.md b/new-docs/puppeteer.cdpsession._connection.md new file mode 100644 index 00000000000..63538e1f319 --- /dev/null +++ b/new-docs/puppeteer.cdpsession._connection.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) > [\_connection](./puppeteer.cdpsession._connection.md) + +## CDPSession.\_connection property + +Signature: + +```typescript +_connection: Connection; +``` diff --git a/new-docs/puppeteer.cdpsession._constructor_.md b/new-docs/puppeteer.cdpsession._constructor_.md new file mode 100644 index 00000000000..352e10b0aff --- /dev/null +++ b/new-docs/puppeteer.cdpsession._constructor_.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) > [(constructor)](./puppeteer.cdpsession._constructor_.md) + +## CDPSession.(constructor) + +Constructs a new instance of the `CDPSession` class + +Signature: + +```typescript +constructor(connection: Connection, targetType: string, sessionId: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| connection | [Connection](./puppeteer.connection.md) | | +| targetType | string | | +| sessionId | string | | + diff --git a/new-docs/puppeteer.cdpsession._onclosed.md b/new-docs/puppeteer.cdpsession._onclosed.md new file mode 100644 index 00000000000..fb352da4518 --- /dev/null +++ b/new-docs/puppeteer.cdpsession._onclosed.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) > [\_onClosed](./puppeteer.cdpsession._onclosed.md) + +## CDPSession.\_onClosed() method + +Signature: + +```typescript +_onClosed(): void; +``` +Returns: + +void + diff --git a/new-docs/puppeteer.cdpsession._onmessage.md b/new-docs/puppeteer.cdpsession._onmessage.md new file mode 100644 index 00000000000..6aae52baafa --- /dev/null +++ b/new-docs/puppeteer.cdpsession._onmessage.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) > [\_onMessage](./puppeteer.cdpsession._onmessage.md) + +## CDPSession.\_onMessage() method + +Signature: + +```typescript +_onMessage(object: CDPSessionOnMessageObject): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| object | CDPSessionOnMessageObject | | + +Returns: + +void + diff --git a/new-docs/puppeteer.cdpsession._sessionid.md b/new-docs/puppeteer.cdpsession._sessionid.md new file mode 100644 index 00000000000..1600de19c7a --- /dev/null +++ b/new-docs/puppeteer.cdpsession._sessionid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) > [\_sessionId](./puppeteer.cdpsession._sessionid.md) + +## CDPSession.\_sessionId property + +Signature: + +```typescript +_sessionId: string; +``` diff --git a/new-docs/puppeteer.cdpsession._targettype.md b/new-docs/puppeteer.cdpsession._targettype.md new file mode 100644 index 00000000000..5ab6ed09a16 --- /dev/null +++ b/new-docs/puppeteer.cdpsession._targettype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) > [\_targetType](./puppeteer.cdpsession._targettype.md) + +## CDPSession.\_targetType property + +Signature: + +```typescript +_targetType: string; +``` diff --git a/new-docs/puppeteer.cdpsession.detach.md b/new-docs/puppeteer.cdpsession.detach.md new file mode 100644 index 00000000000..bd7772bd23f --- /dev/null +++ b/new-docs/puppeteer.cdpsession.detach.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) > [detach](./puppeteer.cdpsession.detach.md) + +## CDPSession.detach() method + +Signature: + +```typescript +detach(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.cdpsession.md b/new-docs/puppeteer.cdpsession.md new file mode 100644 index 00000000000..cca7a990426 --- /dev/null +++ b/new-docs/puppeteer.cdpsession.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) + +## CDPSession class + +Signature: + +```typescript +export declare class CDPSession extends EventEmitter +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(connection, targetType, sessionId)](./puppeteer.cdpsession._constructor_.md) | | Constructs a new instance of the CDPSession class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_callbacks](./puppeteer.cdpsession._callbacks.md) | | Map<number, ConnectionCallback> | | +| [\_connection](./puppeteer.cdpsession._connection.md) | | [Connection](./puppeteer.connection.md) | | +| [\_sessionId](./puppeteer.cdpsession._sessionid.md) | | string | | +| [\_targetType](./puppeteer.cdpsession._targettype.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_onClosed()](./puppeteer.cdpsession._onclosed.md) | | | +| [\_onMessage(object)](./puppeteer.cdpsession._onmessage.md) | | | +| [detach()](./puppeteer.cdpsession.detach.md) | | | +| [send(method, params)](./puppeteer.cdpsession.send.md) | | | + diff --git a/new-docs/puppeteer.cdpsession.send.md b/new-docs/puppeteer.cdpsession.send.md new file mode 100644 index 00000000000..8fba8aa8ca6 --- /dev/null +++ b/new-docs/puppeteer.cdpsession.send.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [CDPSession](./puppeteer.cdpsession.md) > [send](./puppeteer.cdpsession.send.md) + +## CDPSession.send() method + +Signature: + +```typescript +send(method: T, params?: Protocol.CommandParameters[T]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| method | T | | +| params | Protocol.CommandParameters\[T\] | | + +Returns: + +Promise<Protocol.CommandReturnValues\[T\]> + diff --git a/new-docs/puppeteer.connection._callbacks.md b/new-docs/puppeteer.connection._callbacks.md new file mode 100644 index 00000000000..1ec6b3adbb7 --- /dev/null +++ b/new-docs/puppeteer.connection._callbacks.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_callbacks](./puppeteer.connection._callbacks.md) + +## Connection.\_callbacks property + +Signature: + +```typescript +_callbacks: Map; +``` diff --git a/new-docs/puppeteer.connection._closed.md b/new-docs/puppeteer.connection._closed.md new file mode 100644 index 00000000000..7ec20641964 --- /dev/null +++ b/new-docs/puppeteer.connection._closed.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_closed](./puppeteer.connection._closed.md) + +## Connection.\_closed property + +Signature: + +```typescript +_closed: boolean; +``` diff --git a/new-docs/puppeteer.connection._constructor_.md b/new-docs/puppeteer.connection._constructor_.md new file mode 100644 index 00000000000..328638a3743 --- /dev/null +++ b/new-docs/puppeteer.connection._constructor_.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [(constructor)](./puppeteer.connection._constructor_.md) + +## Connection.(constructor) + +Constructs a new instance of the `Connection` class + +Signature: + +```typescript +constructor(url: string, transport: ConnectionTransport, delay?: number); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| url | string | | +| transport | ConnectionTransport | | +| delay | number | | + diff --git a/new-docs/puppeteer.connection._delay.md b/new-docs/puppeteer.connection._delay.md new file mode 100644 index 00000000000..6a6357f7510 --- /dev/null +++ b/new-docs/puppeteer.connection._delay.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_delay](./puppeteer.connection._delay.md) + +## Connection.\_delay property + +Signature: + +```typescript +_delay: number; +``` diff --git a/new-docs/puppeteer.connection._lastid.md b/new-docs/puppeteer.connection._lastid.md new file mode 100644 index 00000000000..28f483056f9 --- /dev/null +++ b/new-docs/puppeteer.connection._lastid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_lastId](./puppeteer.connection._lastid.md) + +## Connection.\_lastId property + +Signature: + +```typescript +_lastId: number; +``` diff --git a/new-docs/puppeteer.connection._onclose.md b/new-docs/puppeteer.connection._onclose.md new file mode 100644 index 00000000000..bb3fc7a4ab3 --- /dev/null +++ b/new-docs/puppeteer.connection._onclose.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_onClose](./puppeteer.connection._onclose.md) + +## Connection.\_onClose() method + +Signature: + +```typescript +_onClose(): void; +``` +Returns: + +void + diff --git a/new-docs/puppeteer.connection._onmessage.md b/new-docs/puppeteer.connection._onmessage.md new file mode 100644 index 00000000000..93381396085 --- /dev/null +++ b/new-docs/puppeteer.connection._onmessage.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_onMessage](./puppeteer.connection._onmessage.md) + +## Connection.\_onMessage() method + +Signature: + +```typescript +_onMessage(message: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| message | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.connection._rawsend.md b/new-docs/puppeteer.connection._rawsend.md new file mode 100644 index 00000000000..b54a63895b3 --- /dev/null +++ b/new-docs/puppeteer.connection._rawsend.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_rawSend](./puppeteer.connection._rawsend.md) + +## Connection.\_rawSend() method + +Signature: + +```typescript +_rawSend(message: {}): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| message | {} | | + +Returns: + +number + diff --git a/new-docs/puppeteer.connection._sessions.md b/new-docs/puppeteer.connection._sessions.md new file mode 100644 index 00000000000..4037b0bade8 --- /dev/null +++ b/new-docs/puppeteer.connection._sessions.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_sessions](./puppeteer.connection._sessions.md) + +## Connection.\_sessions property + +Signature: + +```typescript +_sessions: Map; +``` diff --git a/new-docs/puppeteer.connection._transport.md b/new-docs/puppeteer.connection._transport.md new file mode 100644 index 00000000000..20b3ea2297c --- /dev/null +++ b/new-docs/puppeteer.connection._transport.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_transport](./puppeteer.connection._transport.md) + +## Connection.\_transport property + +Signature: + +```typescript +_transport: ConnectionTransport; +``` diff --git a/new-docs/puppeteer.connection._url.md b/new-docs/puppeteer.connection._url.md new file mode 100644 index 00000000000..c19a8769e98 --- /dev/null +++ b/new-docs/puppeteer.connection._url.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [\_url](./puppeteer.connection._url.md) + +## Connection.\_url property + +Signature: + +```typescript +_url: string; +``` diff --git a/new-docs/puppeteer.connection.createsession.md b/new-docs/puppeteer.connection.createsession.md new file mode 100644 index 00000000000..08af6bb174e --- /dev/null +++ b/new-docs/puppeteer.connection.createsession.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [createSession](./puppeteer.connection.createsession.md) + +## Connection.createSession() method + +Signature: + +```typescript +createSession(targetInfo: Protocol.Target.TargetInfo): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| targetInfo | Protocol.Target.TargetInfo | {!Promise<!CDPSession>} | + +Returns: + +Promise<[CDPSession](./puppeteer.cdpsession.md)> + diff --git a/new-docs/puppeteer.connection.dispose.md b/new-docs/puppeteer.connection.dispose.md new file mode 100644 index 00000000000..39fc899e17a --- /dev/null +++ b/new-docs/puppeteer.connection.dispose.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [dispose](./puppeteer.connection.dispose.md) + +## Connection.dispose() method + +Signature: + +```typescript +dispose(): void; +``` +Returns: + +void + diff --git a/new-docs/puppeteer.connection.fromsession.md b/new-docs/puppeteer.connection.fromsession.md new file mode 100644 index 00000000000..f6eac4ef3a8 --- /dev/null +++ b/new-docs/puppeteer.connection.fromsession.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [fromSession](./puppeteer.connection.fromsession.md) + +## Connection.fromSession() method + +Signature: + +```typescript +static fromSession(session: CDPSession): Connection; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| session | [CDPSession](./puppeteer.cdpsession.md) | | + +Returns: + +[Connection](./puppeteer.connection.md) + diff --git a/new-docs/puppeteer.connection.md b/new-docs/puppeteer.connection.md new file mode 100644 index 00000000000..3fb04345462 --- /dev/null +++ b/new-docs/puppeteer.connection.md @@ -0,0 +1,44 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) + +## Connection class + +Signature: + +```typescript +export declare class Connection extends EventEmitter +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(url, transport, delay)](./puppeteer.connection._constructor_.md) | | Constructs a new instance of the Connection class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_callbacks](./puppeteer.connection._callbacks.md) | | Map<number, ConnectionCallback> | | +| [\_closed](./puppeteer.connection._closed.md) | | boolean | | +| [\_delay](./puppeteer.connection._delay.md) | | number | | +| [\_lastId](./puppeteer.connection._lastid.md) | | number | | +| [\_sessions](./puppeteer.connection._sessions.md) | | Map<string, [CDPSession](./puppeteer.cdpsession.md)> | | +| [\_transport](./puppeteer.connection._transport.md) | | ConnectionTransport | | +| [\_url](./puppeteer.connection._url.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_onClose()](./puppeteer.connection._onclose.md) | | | +| [\_onMessage(message)](./puppeteer.connection._onmessage.md) | | | +| [\_rawSend(message)](./puppeteer.connection._rawsend.md) | | | +| [createSession(targetInfo)](./puppeteer.connection.createsession.md) | | | +| [dispose()](./puppeteer.connection.dispose.md) | | | +| [fromSession(session)](./puppeteer.connection.fromsession.md) | static | | +| [send(method, params)](./puppeteer.connection.send.md) | | | +| [session(sessionId)](./puppeteer.connection.session.md) | | | +| [url()](./puppeteer.connection.url.md) | | | + diff --git a/new-docs/puppeteer.connection.send.md b/new-docs/puppeteer.connection.send.md new file mode 100644 index 00000000000..f5efdddadfa --- /dev/null +++ b/new-docs/puppeteer.connection.send.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [send](./puppeteer.connection.send.md) + +## Connection.send() method + +Signature: + +```typescript +send(method: T, params?: Protocol.CommandParameters[T]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| method | T | | +| params | Protocol.CommandParameters\[T\] | | + +Returns: + +Promise<Protocol.CommandReturnValues\[T\]> + diff --git a/new-docs/puppeteer.connection.session.md b/new-docs/puppeteer.connection.session.md new file mode 100644 index 00000000000..8e18b7e3134 --- /dev/null +++ b/new-docs/puppeteer.connection.session.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [session](./puppeteer.connection.session.md) + +## Connection.session() method + +Signature: + +```typescript +session(sessionId: string): CDPSession | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sessionId | string | {?CDPSession} | + +Returns: + +[CDPSession](./puppeteer.cdpsession.md) \| null + diff --git a/new-docs/puppeteer.connection.url.md b/new-docs/puppeteer.connection.url.md new file mode 100644 index 00000000000..7bf111df204 --- /dev/null +++ b/new-docs/puppeteer.connection.url.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Connection](./puppeteer.connection.md) > [url](./puppeteer.connection.url.md) + +## Connection.url() method + +Signature: + +```typescript +url(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.consolemessage._constructor_.md b/new-docs/puppeteer.consolemessage._constructor_.md new file mode 100644 index 00000000000..16ab061463d --- /dev/null +++ b/new-docs/puppeteer.consolemessage._constructor_.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessage](./puppeteer.consolemessage.md) > [(constructor)](./puppeteer.consolemessage._constructor_.md) + +## ConsoleMessage.(constructor) + +Constructs a new instance of the `ConsoleMessage` class + +Signature: + +```typescript +constructor(type: string, text: string, args: JSHandle[], location?: ConsoleMessageLocation); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | | +| text | string | | +| args | [JSHandle](./puppeteer.jshandle.md)\[\] | | +| location | ConsoleMessageLocation | | + diff --git a/new-docs/puppeteer.consolemessage.args.md b/new-docs/puppeteer.consolemessage.args.md new file mode 100644 index 00000000000..d0a4810276c --- /dev/null +++ b/new-docs/puppeteer.consolemessage.args.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessage](./puppeteer.consolemessage.md) > [args](./puppeteer.consolemessage.args.md) + +## ConsoleMessage.args() method + +Signature: + +```typescript +args(): JSHandle[]; +``` +Returns: + +[JSHandle](./puppeteer.jshandle.md)\[\] + diff --git a/new-docs/puppeteer.consolemessage.location.md b/new-docs/puppeteer.consolemessage.location.md new file mode 100644 index 00000000000..e8df630ba4e --- /dev/null +++ b/new-docs/puppeteer.consolemessage.location.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessage](./puppeteer.consolemessage.md) > [location](./puppeteer.consolemessage.location.md) + +## ConsoleMessage.location() method + +Signature: + +```typescript +location(): ConsoleMessageLocation; +``` +Returns: + +ConsoleMessageLocation + diff --git a/new-docs/puppeteer.consolemessage.md b/new-docs/puppeteer.consolemessage.md new file mode 100644 index 00000000000..d26285c22fe --- /dev/null +++ b/new-docs/puppeteer.consolemessage.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessage](./puppeteer.consolemessage.md) + +## ConsoleMessage class + +Signature: + +```typescript +export declare class ConsoleMessage +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(type, text, args, location)](./puppeteer.consolemessage._constructor_.md) | | Constructs a new instance of the ConsoleMessage class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [args()](./puppeteer.consolemessage.args.md) | | | +| [location()](./puppeteer.consolemessage.location.md) | | | +| [text()](./puppeteer.consolemessage.text.md) | | | +| [type()](./puppeteer.consolemessage.type.md) | | | + diff --git a/new-docs/puppeteer.consolemessage.text.md b/new-docs/puppeteer.consolemessage.text.md new file mode 100644 index 00000000000..5a687bb4b62 --- /dev/null +++ b/new-docs/puppeteer.consolemessage.text.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessage](./puppeteer.consolemessage.md) > [text](./puppeteer.consolemessage.text.md) + +## ConsoleMessage.text() method + +Signature: + +```typescript +text(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.consolemessage.type.md b/new-docs/puppeteer.consolemessage.type.md new file mode 100644 index 00000000000..69f6259ad57 --- /dev/null +++ b/new-docs/puppeteer.consolemessage.type.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ConsoleMessage](./puppeteer.consolemessage.md) > [type](./puppeteer.consolemessage.type.md) + +## ConsoleMessage.type() method + +Signature: + +```typescript +type(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.coverage._constructor_.md b/new-docs/puppeteer.coverage._constructor_.md new file mode 100644 index 00000000000..4310e77abf3 --- /dev/null +++ b/new-docs/puppeteer.coverage._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) > [(constructor)](./puppeteer.coverage._constructor_.md) + +## Coverage.(constructor) + +Constructs a new instance of the `Coverage` class + +Signature: + +```typescript +constructor(client: CDPSession); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | + diff --git a/new-docs/puppeteer.coverage._csscoverage.md b/new-docs/puppeteer.coverage._csscoverage.md new file mode 100644 index 00000000000..df7c773d61e --- /dev/null +++ b/new-docs/puppeteer.coverage._csscoverage.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) > [\_cssCoverage](./puppeteer.coverage._csscoverage.md) + +## Coverage.\_cssCoverage property + +Signature: + +```typescript +_cssCoverage: CSSCoverage; +``` diff --git a/new-docs/puppeteer.coverage._jscoverage.md b/new-docs/puppeteer.coverage._jscoverage.md new file mode 100644 index 00000000000..d3b3dd4095e --- /dev/null +++ b/new-docs/puppeteer.coverage._jscoverage.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) > [\_jsCoverage](./puppeteer.coverage._jscoverage.md) + +## Coverage.\_jsCoverage property + +Signature: + +```typescript +_jsCoverage: JSCoverage; +``` diff --git a/new-docs/puppeteer.coverage.md b/new-docs/puppeteer.coverage.md new file mode 100644 index 00000000000..947f94e9ed2 --- /dev/null +++ b/new-docs/puppeteer.coverage.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) + +## Coverage class + +Signature: + +```typescript +export declare class Coverage +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(client)](./puppeteer.coverage._constructor_.md) | | Constructs a new instance of the Coverage class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_cssCoverage](./puppeteer.coverage._csscoverage.md) | | CSSCoverage | | +| [\_jsCoverage](./puppeteer.coverage._jscoverage.md) | | JSCoverage | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [startCSSCoverage(options)](./puppeteer.coverage.startcsscoverage.md) | | | +| [startJSCoverage(options)](./puppeteer.coverage.startjscoverage.md) | | | +| [stopCSSCoverage()](./puppeteer.coverage.stopcsscoverage.md) | | | +| [stopJSCoverage()](./puppeteer.coverage.stopjscoverage.md) | | | + diff --git a/new-docs/puppeteer.coverage.startcsscoverage.md b/new-docs/puppeteer.coverage.startcsscoverage.md new file mode 100644 index 00000000000..f8616647dd9 --- /dev/null +++ b/new-docs/puppeteer.coverage.startcsscoverage.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) > [startCSSCoverage](./puppeteer.coverage.startcsscoverage.md) + +## Coverage.startCSSCoverage() method + +Signature: + +```typescript +startCSSCoverage(options: { + resetOnNavigation?: boolean; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | { resetOnNavigation?: boolean; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.coverage.startjscoverage.md b/new-docs/puppeteer.coverage.startjscoverage.md new file mode 100644 index 00000000000..95e01129078 --- /dev/null +++ b/new-docs/puppeteer.coverage.startjscoverage.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) > [startJSCoverage](./puppeteer.coverage.startjscoverage.md) + +## Coverage.startJSCoverage() method + +Signature: + +```typescript +startJSCoverage(options: { + resetOnNavigation?: boolean; + reportAnonymousScripts?: boolean; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | { resetOnNavigation?: boolean; reportAnonymousScripts?: boolean; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.coverage.stopcsscoverage.md b/new-docs/puppeteer.coverage.stopcsscoverage.md new file mode 100644 index 00000000000..1134d25f091 --- /dev/null +++ b/new-docs/puppeteer.coverage.stopcsscoverage.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) > [stopCSSCoverage](./puppeteer.coverage.stopcsscoverage.md) + +## Coverage.stopCSSCoverage() method + +Signature: + +```typescript +stopCSSCoverage(): Promise; +``` +Returns: + +Promise<CoverageEntry\[\]> + diff --git a/new-docs/puppeteer.coverage.stopjscoverage.md b/new-docs/puppeteer.coverage.stopjscoverage.md new file mode 100644 index 00000000000..aec5c0dd8ae --- /dev/null +++ b/new-docs/puppeteer.coverage.stopjscoverage.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Coverage](./puppeteer.coverage.md) > [stopJSCoverage](./puppeteer.coverage.stopjscoverage.md) + +## Coverage.stopJSCoverage() method + +Signature: + +```typescript +stopJSCoverage(): Promise; +``` +Returns: + +Promise<CoverageEntry\[\]> + diff --git a/new-docs/puppeteer.createjshandle.md b/new-docs/puppeteer.createjshandle.md new file mode 100644 index 00000000000..4f92a4b5248 --- /dev/null +++ b/new-docs/puppeteer.createjshandle.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [createJSHandle](./puppeteer.createjshandle.md) + +## createJSHandle() function + +Signature: + +```typescript +export declare function createJSHandle(context: ExecutionContext, remoteObject: Protocol.Runtime.RemoteObject): JSHandle; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| context | [ExecutionContext](./puppeteer.executioncontext.md) | | +| remoteObject | Protocol.Runtime.RemoteObject | | + +Returns: + +[JSHandle](./puppeteer.jshandle.md) + diff --git a/new-docs/puppeteer.dialog._constructor_.md b/new-docs/puppeteer.dialog._constructor_.md new file mode 100644 index 00000000000..b94300dc6c1 --- /dev/null +++ b/new-docs/puppeteer.dialog._constructor_.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Dialog](./puppeteer.dialog.md) > [(constructor)](./puppeteer.dialog._constructor_.md) + +## Dialog.(constructor) + +Constructs a new instance of the `Dialog` class + +Signature: + +```typescript +constructor(client: CDPSession, type: DialogType, message: string, defaultValue?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | +| type | [DialogType](./puppeteer.dialogtype.md) | | +| message | string | | +| defaultValue | string | | + diff --git a/new-docs/puppeteer.dialog.accept.md b/new-docs/puppeteer.dialog.accept.md new file mode 100644 index 00000000000..72b8eb87ece --- /dev/null +++ b/new-docs/puppeteer.dialog.accept.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Dialog](./puppeteer.dialog.md) > [accept](./puppeteer.dialog.accept.md) + +## Dialog.accept() method + +Signature: + +```typescript +accept(promptText?: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| promptText | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.dialog.defaultvalue.md b/new-docs/puppeteer.dialog.defaultvalue.md new file mode 100644 index 00000000000..d2960eb83d2 --- /dev/null +++ b/new-docs/puppeteer.dialog.defaultvalue.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Dialog](./puppeteer.dialog.md) > [defaultValue](./puppeteer.dialog.defaultvalue.md) + +## Dialog.defaultValue() method + +Signature: + +```typescript +defaultValue(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.dialog.dismiss.md b/new-docs/puppeteer.dialog.dismiss.md new file mode 100644 index 00000000000..73a2eeeeacd --- /dev/null +++ b/new-docs/puppeteer.dialog.dismiss.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Dialog](./puppeteer.dialog.md) > [dismiss](./puppeteer.dialog.dismiss.md) + +## Dialog.dismiss() method + +Signature: + +```typescript +dismiss(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.dialog.md b/new-docs/puppeteer.dialog.md new file mode 100644 index 00000000000..b9976b3c7ac --- /dev/null +++ b/new-docs/puppeteer.dialog.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Dialog](./puppeteer.dialog.md) + +## Dialog class + +Signature: + +```typescript +export declare class Dialog +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(client, type, message, defaultValue)](./puppeteer.dialog._constructor_.md) | | Constructs a new instance of the Dialog class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [Type](./puppeteer.dialog.type.md) | static | typeof [DialogType](./puppeteer.dialogtype.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [accept(promptText)](./puppeteer.dialog.accept.md) | | | +| [defaultValue()](./puppeteer.dialog.defaultvalue.md) | | | +| [dismiss()](./puppeteer.dialog.dismiss.md) | | | +| [message()](./puppeteer.dialog.message.md) | | | +| [type()](./puppeteer.dialog.type.md) | | | + diff --git a/new-docs/puppeteer.dialog.message.md b/new-docs/puppeteer.dialog.message.md new file mode 100644 index 00000000000..77d0fa29936 --- /dev/null +++ b/new-docs/puppeteer.dialog.message.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Dialog](./puppeteer.dialog.md) > [message](./puppeteer.dialog.message.md) + +## Dialog.message() method + +Signature: + +```typescript +message(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.dialog.type.md b/new-docs/puppeteer.dialog.type.md new file mode 100644 index 00000000000..230a74cf30d --- /dev/null +++ b/new-docs/puppeteer.dialog.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Dialog](./puppeteer.dialog.md) > [Type](./puppeteer.dialog.type.md) + +## Dialog.Type property + +Signature: + +```typescript +static Type: typeof DialogType; +``` diff --git a/new-docs/puppeteer.dialogtype.md b/new-docs/puppeteer.dialogtype.md new file mode 100644 index 00000000000..d44e7ac0054 --- /dev/null +++ b/new-docs/puppeteer.dialogtype.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [DialogType](./puppeteer.dialogtype.md) + +## DialogType enum + +Signature: + +```typescript +export declare enum DialogType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Alert | "alert" | | +| BeforeUnload | "beforeunload" | | +| Confirm | "confirm" | | +| Prompt | "prompt" | | + diff --git a/new-docs/puppeteer.elementhandle._.md b/new-docs/puppeteer.elementhandle._.md new file mode 100644 index 00000000000..f9354fc2515 --- /dev/null +++ b/new-docs/puppeteer.elementhandle._.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [$](./puppeteer.elementhandle._.md) + +## ElementHandle.$() method + +Signature: + +```typescript +$(selector: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md) \| null> + diff --git a/new-docs/puppeteer.elementhandle.__.md b/new-docs/puppeteer.elementhandle.__.md new file mode 100644 index 00000000000..16cd79aae4b --- /dev/null +++ b/new-docs/puppeteer.elementhandle.__.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [$$](./puppeteer.elementhandle.__.md) + +## ElementHandle.$$() method + +Signature: + +```typescript +$$(selector: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md)\[\]> + diff --git a/new-docs/puppeteer.elementhandle.__eval.md b/new-docs/puppeteer.elementhandle.__eval.md new file mode 100644 index 00000000000..dc966188c3f --- /dev/null +++ b/new-docs/puppeteer.elementhandle.__eval.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [$$eval](./puppeteer.elementhandle.__eval.md) + +## ElementHandle.$$eval() method + +Signature: + +```typescript +$$eval(selector: string, pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<ReturnType> + diff --git a/new-docs/puppeteer.elementhandle._clickablepoint.md b/new-docs/puppeteer.elementhandle._clickablepoint.md new file mode 100644 index 00000000000..fc61c152b5c --- /dev/null +++ b/new-docs/puppeteer.elementhandle._clickablepoint.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [\_clickablePoint](./puppeteer.elementhandle._clickablepoint.md) + +## ElementHandle.\_clickablePoint() method + +Signature: + +```typescript +_clickablePoint(): Promise<{ + x: number; + y: number; + }>; +``` +Returns: + +Promise<{ x: number; y: number; }> + diff --git a/new-docs/puppeteer.elementhandle._constructor_.md b/new-docs/puppeteer.elementhandle._constructor_.md new file mode 100644 index 00000000000..ceb7ee2b58b --- /dev/null +++ b/new-docs/puppeteer.elementhandle._constructor_.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [(constructor)](./puppeteer.elementhandle._constructor_.md) + +## ElementHandle.(constructor) + +Constructs a new instance of the `ElementHandle` class + +Signature: + +```typescript +constructor(context: ExecutionContext, client: CDPSession, remoteObject: Protocol.Runtime.RemoteObject, page: Page, frameManager: FrameManager); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| context | [ExecutionContext](./puppeteer.executioncontext.md) | | +| client | [CDPSession](./puppeteer.cdpsession.md) | | +| remoteObject | Protocol.Runtime.RemoteObject | | +| page | [Page](./puppeteer.page.md) | | +| frameManager | [FrameManager](./puppeteer.framemanager.md) | | + diff --git a/new-docs/puppeteer.elementhandle._eval.md b/new-docs/puppeteer.elementhandle._eval.md new file mode 100644 index 00000000000..94111be0a60 --- /dev/null +++ b/new-docs/puppeteer.elementhandle._eval.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [$eval](./puppeteer.elementhandle._eval.md) + +## ElementHandle.$eval() method + +Signature: + +```typescript +$eval(selector: string, pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<ReturnType> + diff --git a/new-docs/puppeteer.elementhandle._framemanager.md b/new-docs/puppeteer.elementhandle._framemanager.md new file mode 100644 index 00000000000..2409cb8b4bd --- /dev/null +++ b/new-docs/puppeteer.elementhandle._framemanager.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [\_frameManager](./puppeteer.elementhandle._framemanager.md) + +## ElementHandle.\_frameManager property + +Signature: + +```typescript +_frameManager: FrameManager; +``` diff --git a/new-docs/puppeteer.elementhandle._fromprotocolquad.md b/new-docs/puppeteer.elementhandle._fromprotocolquad.md new file mode 100644 index 00000000000..896698434e3 --- /dev/null +++ b/new-docs/puppeteer.elementhandle._fromprotocolquad.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [\_fromProtocolQuad](./puppeteer.elementhandle._fromprotocolquad.md) + +## ElementHandle.\_fromProtocolQuad() method + +Signature: + +```typescript +_fromProtocolQuad(quad: number[]): Array<{ + x: number; + y: number; + }>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| quad | number\[\] | | + +Returns: + +Array<{ x: number; y: number; }> + diff --git a/new-docs/puppeteer.elementhandle._getboxmodel.md b/new-docs/puppeteer.elementhandle._getboxmodel.md new file mode 100644 index 00000000000..9bfeca9e947 --- /dev/null +++ b/new-docs/puppeteer.elementhandle._getboxmodel.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [\_getBoxModel](./puppeteer.elementhandle._getboxmodel.md) + +## ElementHandle.\_getBoxModel() method + +Signature: + +```typescript +_getBoxModel(): Promise; +``` +Returns: + +Promise<void \| Protocol.DOM.getBoxModelReturnValue> + diff --git a/new-docs/puppeteer.elementhandle._intersectquadwithviewport.md b/new-docs/puppeteer.elementhandle._intersectquadwithviewport.md new file mode 100644 index 00000000000..d4d27d04d50 --- /dev/null +++ b/new-docs/puppeteer.elementhandle._intersectquadwithviewport.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [\_intersectQuadWithViewport](./puppeteer.elementhandle._intersectquadwithviewport.md) + +## ElementHandle.\_intersectQuadWithViewport() method + +Signature: + +```typescript +_intersectQuadWithViewport(quad: Array<{ + x: number; + y: number; + }>, width: number, height: number): Array<{ + x: number; + y: number; + }>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| quad | Array<{ x: number; y: number; }> | | +| width | number | | +| height | number | | + +Returns: + +Array<{ x: number; y: number; }> + diff --git a/new-docs/puppeteer.elementhandle._page.md b/new-docs/puppeteer.elementhandle._page.md new file mode 100644 index 00000000000..cd91ed553bc --- /dev/null +++ b/new-docs/puppeteer.elementhandle._page.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [\_page](./puppeteer.elementhandle._page.md) + +## ElementHandle.\_page property + +Signature: + +```typescript +_page: Page; +``` diff --git a/new-docs/puppeteer.elementhandle._scrollintoviewifneeded.md b/new-docs/puppeteer.elementhandle._scrollintoviewifneeded.md new file mode 100644 index 00000000000..3d431283914 --- /dev/null +++ b/new-docs/puppeteer.elementhandle._scrollintoviewifneeded.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [\_scrollIntoViewIfNeeded](./puppeteer.elementhandle._scrollintoviewifneeded.md) + +## ElementHandle.\_scrollIntoViewIfNeeded() method + +Signature: + +```typescript +_scrollIntoViewIfNeeded(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.elementhandle._x.md b/new-docs/puppeteer.elementhandle._x.md new file mode 100644 index 00000000000..33fdf279862 --- /dev/null +++ b/new-docs/puppeteer.elementhandle._x.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [$x](./puppeteer.elementhandle._x.md) + +## ElementHandle.$x() method + +Signature: + +```typescript +$x(expression: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| expression | string | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md)\[\]> + diff --git a/new-docs/puppeteer.elementhandle.aselement.md b/new-docs/puppeteer.elementhandle.aselement.md new file mode 100644 index 00000000000..0abe674ad14 --- /dev/null +++ b/new-docs/puppeteer.elementhandle.aselement.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [asElement](./puppeteer.elementhandle.aselement.md) + +## ElementHandle.asElement() method + +Signature: + +```typescript +asElement(): ElementHandle | null; +``` +Returns: + +[ElementHandle](./puppeteer.elementhandle.md) \| null + diff --git a/new-docs/puppeteer.elementhandle.boundingbox.md b/new-docs/puppeteer.elementhandle.boundingbox.md new file mode 100644 index 00000000000..6b2d0946f56 --- /dev/null +++ b/new-docs/puppeteer.elementhandle.boundingbox.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [boundingBox](./puppeteer.elementhandle.boundingbox.md) + +## ElementHandle.boundingBox() method + +Signature: + +```typescript +boundingBox(): Promise<{ + x: number; + y: number; + width: number; + height: number; + }>; +``` +Returns: + +Promise<{ x: number; y: number; width: number; height: number; }> + diff --git a/new-docs/puppeteer.elementhandle.boxmodel.md b/new-docs/puppeteer.elementhandle.boxmodel.md new file mode 100644 index 00000000000..7fdd487a823 --- /dev/null +++ b/new-docs/puppeteer.elementhandle.boxmodel.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [boxModel](./puppeteer.elementhandle.boxmodel.md) + +## ElementHandle.boxModel() method + + {!Promise<?BoxModel>} + +Signature: + +```typescript +boxModel(): Promise; +``` +Returns: + +Promise<BoxModel \| null> + diff --git a/new-docs/puppeteer.elementhandle.click.md b/new-docs/puppeteer.elementhandle.click.md new file mode 100644 index 00000000000..6cd92b907d1 --- /dev/null +++ b/new-docs/puppeteer.elementhandle.click.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [click](./puppeteer.elementhandle.click.md) + +## ElementHandle.click() method + +Signature: + +```typescript +click(options: { + delay?: number; + button?: 'left' | 'right' | 'middle'; + clickCount?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | { delay?: number; button?: 'left' \| 'right' \| 'middle'; clickCount?: number; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.elementhandle.contentframe.md b/new-docs/puppeteer.elementhandle.contentframe.md new file mode 100644 index 00000000000..c5709cca532 --- /dev/null +++ b/new-docs/puppeteer.elementhandle.contentframe.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [contentFrame](./puppeteer.elementhandle.contentframe.md) + +## ElementHandle.contentFrame() method + +Signature: + +```typescript +contentFrame(): Promise; +``` +Returns: + +Promise<[Frame](./puppeteer.frame.md) \| null> + diff --git a/new-docs/puppeteer.elementhandle.focus.md b/new-docs/puppeteer.elementhandle.focus.md new file mode 100644 index 00000000000..6a622b9c8ad --- /dev/null +++ b/new-docs/puppeteer.elementhandle.focus.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [focus](./puppeteer.elementhandle.focus.md) + +## ElementHandle.focus() method + +Signature: + +```typescript +focus(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.elementhandle.hover.md b/new-docs/puppeteer.elementhandle.hover.md new file mode 100644 index 00000000000..0f9f9a7b259 --- /dev/null +++ b/new-docs/puppeteer.elementhandle.hover.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [hover](./puppeteer.elementhandle.hover.md) + +## ElementHandle.hover() method + +Signature: + +```typescript +hover(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.elementhandle.isintersectingviewport.md b/new-docs/puppeteer.elementhandle.isintersectingviewport.md new file mode 100644 index 00000000000..3d497824df4 --- /dev/null +++ b/new-docs/puppeteer.elementhandle.isintersectingviewport.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [isIntersectingViewport](./puppeteer.elementhandle.isintersectingviewport.md) + +## ElementHandle.isIntersectingViewport() method + +Signature: + +```typescript +isIntersectingViewport(): Promise; +``` +Returns: + +Promise<boolean> + diff --git a/new-docs/puppeteer.elementhandle.md b/new-docs/puppeteer.elementhandle.md new file mode 100644 index 00000000000..3dd27169799 --- /dev/null +++ b/new-docs/puppeteer.elementhandle.md @@ -0,0 +1,54 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) + +## ElementHandle class + +Signature: + +```typescript +export declare class ElementHandle extends JSHandle +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(context, client, remoteObject, page, frameManager)](./puppeteer.elementhandle._constructor_.md) | | Constructs a new instance of the ElementHandle class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_frameManager](./puppeteer.elementhandle._framemanager.md) | | [FrameManager](./puppeteer.framemanager.md) | | +| [\_page](./puppeteer.elementhandle._page.md) | | [Page](./puppeteer.page.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_clickablePoint()](./puppeteer.elementhandle._clickablepoint.md) | | | +| [\_fromProtocolQuad(quad)](./puppeteer.elementhandle._fromprotocolquad.md) | | | +| [\_getBoxModel()](./puppeteer.elementhandle._getboxmodel.md) | | | +| [\_intersectQuadWithViewport(quad, width, height)](./puppeteer.elementhandle._intersectquadwithviewport.md) | | | +| [\_scrollIntoViewIfNeeded()](./puppeteer.elementhandle._scrollintoviewifneeded.md) | | | +| [$(selector)](./puppeteer.elementhandle._.md) | | | +| [$$(selector)](./puppeteer.elementhandle.__.md) | | | +| [$$eval(selector, pageFunction, args)](./puppeteer.elementhandle.__eval.md) | | | +| [$eval(selector, pageFunction, args)](./puppeteer.elementhandle._eval.md) | | | +| [$x(expression)](./puppeteer.elementhandle._x.md) | | | +| [asElement()](./puppeteer.elementhandle.aselement.md) | | | +| [boundingBox()](./puppeteer.elementhandle.boundingbox.md) | | | +| [boxModel()](./puppeteer.elementhandle.boxmodel.md) | | {!Promise<?BoxModel>} | +| [click(options)](./puppeteer.elementhandle.click.md) | | | +| [contentFrame()](./puppeteer.elementhandle.contentframe.md) | | | +| [focus()](./puppeteer.elementhandle.focus.md) | | | +| [hover()](./puppeteer.elementhandle.hover.md) | | | +| [isIntersectingViewport()](./puppeteer.elementhandle.isintersectingviewport.md) | | | +| [press(key, options)](./puppeteer.elementhandle.press.md) | | | +| [screenshot(options)](./puppeteer.elementhandle.screenshot.md) | | | +| [select(values)](./puppeteer.elementhandle.select.md) | | | +| [tap()](./puppeteer.elementhandle.tap.md) | | | +| [type(text, options)](./puppeteer.elementhandle.type.md) | | | +| [uploadFile(filePaths)](./puppeteer.elementhandle.uploadfile.md) | | | + diff --git a/new-docs/puppeteer.elementhandle.press.md b/new-docs/puppeteer.elementhandle.press.md new file mode 100644 index 00000000000..75228f1fbe8 --- /dev/null +++ b/new-docs/puppeteer.elementhandle.press.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [press](./puppeteer.elementhandle.press.md) + +## ElementHandle.press() method + +Signature: + +```typescript +press(key: KeyInput, options?: { + delay?: number; + text?: string; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| key | KeyInput | | +| options | { delay?: number; text?: string; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.elementhandle.screenshot.md b/new-docs/puppeteer.elementhandle.screenshot.md new file mode 100644 index 00000000000..0c8466bd917 --- /dev/null +++ b/new-docs/puppeteer.elementhandle.screenshot.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [screenshot](./puppeteer.elementhandle.screenshot.md) + +## ElementHandle.screenshot() method + +Signature: + +```typescript +screenshot(options?: {}): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | {} | | + +Returns: + +Promise<string \| Buffer \| void> + diff --git a/new-docs/puppeteer.elementhandle.select.md b/new-docs/puppeteer.elementhandle.select.md new file mode 100644 index 00000000000..6e8caee7167 --- /dev/null +++ b/new-docs/puppeteer.elementhandle.select.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [select](./puppeteer.elementhandle.select.md) + +## ElementHandle.select() method + +Signature: + +```typescript +select(...values: string[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| values | string\[\] | | + +Returns: + +Promise<string\[\]> + diff --git a/new-docs/puppeteer.elementhandle.tap.md b/new-docs/puppeteer.elementhandle.tap.md new file mode 100644 index 00000000000..9134f7d637f --- /dev/null +++ b/new-docs/puppeteer.elementhandle.tap.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [tap](./puppeteer.elementhandle.tap.md) + +## ElementHandle.tap() method + +Signature: + +```typescript +tap(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.elementhandle.type.md b/new-docs/puppeteer.elementhandle.type.md new file mode 100644 index 00000000000..450ee16f117 --- /dev/null +++ b/new-docs/puppeteer.elementhandle.type.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [type](./puppeteer.elementhandle.type.md) + +## ElementHandle.type() method + +Signature: + +```typescript +type(text: string, options?: { + delay: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | | +| options | { delay: number; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.elementhandle.uploadfile.md b/new-docs/puppeteer.elementhandle.uploadfile.md new file mode 100644 index 00000000000..ee61ebc40a8 --- /dev/null +++ b/new-docs/puppeteer.elementhandle.uploadfile.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ElementHandle](./puppeteer.elementhandle.md) > [uploadFile](./puppeteer.elementhandle.uploadfile.md) + +## ElementHandle.uploadFile() method + +Signature: + +```typescript +uploadFile(...filePaths: string[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filePaths | string\[\] | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.evaluation_script_url.md b/new-docs/puppeteer.evaluation_script_url.md new file mode 100644 index 00000000000..7e464964cc7 --- /dev/null +++ b/new-docs/puppeteer.evaluation_script_url.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [EVALUATION\_SCRIPT\_URL](./puppeteer.evaluation_script_url.md) + +## EVALUATION\_SCRIPT\_URL variable + +Signature: + +```typescript +EVALUATION_SCRIPT_URL = "__puppeteer_evaluation_script__" +``` diff --git a/new-docs/puppeteer.executioncontext._adoptbackendnodeid.md b/new-docs/puppeteer.executioncontext._adoptbackendnodeid.md new file mode 100644 index 00000000000..1bdf1e05bf9 --- /dev/null +++ b/new-docs/puppeteer.executioncontext._adoptbackendnodeid.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [\_adoptBackendNodeId](./puppeteer.executioncontext._adoptbackendnodeid.md) + +## ExecutionContext.\_adoptBackendNodeId() method + +Signature: + +```typescript +_adoptBackendNodeId(backendNodeId: Protocol.DOM.BackendNodeId): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| backendNodeId | Protocol.DOM.BackendNodeId | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md)> + diff --git a/new-docs/puppeteer.executioncontext._adoptelementhandle.md b/new-docs/puppeteer.executioncontext._adoptelementhandle.md new file mode 100644 index 00000000000..a211a82592e --- /dev/null +++ b/new-docs/puppeteer.executioncontext._adoptelementhandle.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [\_adoptElementHandle](./puppeteer.executioncontext._adoptelementhandle.md) + +## ExecutionContext.\_adoptElementHandle() method + +Signature: + +```typescript +_adoptElementHandle(elementHandle: ElementHandle): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| elementHandle | [ElementHandle](./puppeteer.elementhandle.md) | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md)> + diff --git a/new-docs/puppeteer.executioncontext._client.md b/new-docs/puppeteer.executioncontext._client.md new file mode 100644 index 00000000000..b3ad759f698 --- /dev/null +++ b/new-docs/puppeteer.executioncontext._client.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [\_client](./puppeteer.executioncontext._client.md) + +## ExecutionContext.\_client property + +Signature: + +```typescript +_client: CDPSession; +``` diff --git a/new-docs/puppeteer.executioncontext._constructor_.md b/new-docs/puppeteer.executioncontext._constructor_.md new file mode 100644 index 00000000000..8271648e156 --- /dev/null +++ b/new-docs/puppeteer.executioncontext._constructor_.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [(constructor)](./puppeteer.executioncontext._constructor_.md) + +## ExecutionContext.(constructor) + +Constructs a new instance of the `ExecutionContext` class + +Signature: + +```typescript +constructor(client: CDPSession, contextPayload: Protocol.Runtime.ExecutionContextDescription, world: DOMWorld); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | +| contextPayload | Protocol.Runtime.ExecutionContextDescription | | +| world | DOMWorld | | + diff --git a/new-docs/puppeteer.executioncontext._contextid.md b/new-docs/puppeteer.executioncontext._contextid.md new file mode 100644 index 00000000000..3a8457c5348 --- /dev/null +++ b/new-docs/puppeteer.executioncontext._contextid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [\_contextId](./puppeteer.executioncontext._contextid.md) + +## ExecutionContext.\_contextId property + +Signature: + +```typescript +_contextId: number; +``` diff --git a/new-docs/puppeteer.executioncontext._world.md b/new-docs/puppeteer.executioncontext._world.md new file mode 100644 index 00000000000..e01b99a26ef --- /dev/null +++ b/new-docs/puppeteer.executioncontext._world.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [\_world](./puppeteer.executioncontext._world.md) + +## ExecutionContext.\_world property + +Signature: + +```typescript +_world: DOMWorld; +``` diff --git a/new-docs/puppeteer.executioncontext.evaluate.md b/new-docs/puppeteer.executioncontext.evaluate.md new file mode 100644 index 00000000000..c59be4be333 --- /dev/null +++ b/new-docs/puppeteer.executioncontext.evaluate.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [evaluate](./puppeteer.executioncontext.evaluate.md) + +## ExecutionContext.evaluate() method + +Signature: + +```typescript +evaluate(pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<ReturnType> + diff --git a/new-docs/puppeteer.executioncontext.evaluatehandle.md b/new-docs/puppeteer.executioncontext.evaluatehandle.md new file mode 100644 index 00000000000..4ddf2d737a6 --- /dev/null +++ b/new-docs/puppeteer.executioncontext.evaluatehandle.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [evaluateHandle](./puppeteer.executioncontext.evaluatehandle.md) + +## ExecutionContext.evaluateHandle() method + +Signature: + +```typescript +evaluateHandle(pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<[JSHandle](./puppeteer.jshandle.md)> + diff --git a/new-docs/puppeteer.executioncontext.frame.md b/new-docs/puppeteer.executioncontext.frame.md new file mode 100644 index 00000000000..112e4b7f602 --- /dev/null +++ b/new-docs/puppeteer.executioncontext.frame.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [frame](./puppeteer.executioncontext.frame.md) + +## ExecutionContext.frame() method + +Signature: + +```typescript +frame(): Frame | null; +``` +Returns: + +[Frame](./puppeteer.frame.md) \| null + diff --git a/new-docs/puppeteer.executioncontext.md b/new-docs/puppeteer.executioncontext.md new file mode 100644 index 00000000000..c07e2906652 --- /dev/null +++ b/new-docs/puppeteer.executioncontext.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) + +## ExecutionContext class + +Signature: + +```typescript +export declare class ExecutionContext +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(client, contextPayload, world)](./puppeteer.executioncontext._constructor_.md) | | Constructs a new instance of the ExecutionContext class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_client](./puppeteer.executioncontext._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | | +| [\_contextId](./puppeteer.executioncontext._contextid.md) | | number | | +| [\_world](./puppeteer.executioncontext._world.md) | | DOMWorld | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_adoptBackendNodeId(backendNodeId)](./puppeteer.executioncontext._adoptbackendnodeid.md) | | | +| [\_adoptElementHandle(elementHandle)](./puppeteer.executioncontext._adoptelementhandle.md) | | | +| [evaluate(pageFunction, args)](./puppeteer.executioncontext.evaluate.md) | | | +| [evaluateHandle(pageFunction, args)](./puppeteer.executioncontext.evaluatehandle.md) | | | +| [frame()](./puppeteer.executioncontext.frame.md) | | | +| [queryObjects(prototypeHandle)](./puppeteer.executioncontext.queryobjects.md) | | | + diff --git a/new-docs/puppeteer.executioncontext.queryobjects.md b/new-docs/puppeteer.executioncontext.queryobjects.md new file mode 100644 index 00000000000..ae9f7c8e0fa --- /dev/null +++ b/new-docs/puppeteer.executioncontext.queryobjects.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [ExecutionContext](./puppeteer.executioncontext.md) > [queryObjects](./puppeteer.executioncontext.queryobjects.md) + +## ExecutionContext.queryObjects() method + +Signature: + +```typescript +queryObjects(prototypeHandle: JSHandle): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prototypeHandle | [JSHandle](./puppeteer.jshandle.md) | | + +Returns: + +Promise<[JSHandle](./puppeteer.jshandle.md)> + diff --git a/new-docs/puppeteer.filechooser._constructor_.md b/new-docs/puppeteer.filechooser._constructor_.md new file mode 100644 index 00000000000..7c657039991 --- /dev/null +++ b/new-docs/puppeteer.filechooser._constructor_.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FileChooser](./puppeteer.filechooser.md) > [(constructor)](./puppeteer.filechooser._constructor_.md) + +## FileChooser.(constructor) + +Constructs a new instance of the `FileChooser` class + +Signature: + +```typescript +constructor(element: ElementHandle, event: Protocol.Page.fileChooserOpenedPayload); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| element | [ElementHandle](./puppeteer.elementhandle.md) | | +| event | Protocol.Page.fileChooserOpenedPayload | | + diff --git a/new-docs/puppeteer.filechooser.accept.md b/new-docs/puppeteer.filechooser.accept.md new file mode 100644 index 00000000000..61bc0c5fd0c --- /dev/null +++ b/new-docs/puppeteer.filechooser.accept.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FileChooser](./puppeteer.filechooser.md) > [accept](./puppeteer.filechooser.accept.md) + +## FileChooser.accept() method + +Signature: + +```typescript +accept(filePaths: string[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filePaths | string\[\] | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.filechooser.cancel.md b/new-docs/puppeteer.filechooser.cancel.md new file mode 100644 index 00000000000..6d58d64517a --- /dev/null +++ b/new-docs/puppeteer.filechooser.cancel.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FileChooser](./puppeteer.filechooser.md) > [cancel](./puppeteer.filechooser.cancel.md) + +## FileChooser.cancel() method + +Signature: + +```typescript +cancel(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.filechooser.ismultiple.md b/new-docs/puppeteer.filechooser.ismultiple.md new file mode 100644 index 00000000000..2875a32534c --- /dev/null +++ b/new-docs/puppeteer.filechooser.ismultiple.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FileChooser](./puppeteer.filechooser.md) > [isMultiple](./puppeteer.filechooser.ismultiple.md) + +## FileChooser.isMultiple() method + +Signature: + +```typescript +isMultiple(): boolean; +``` +Returns: + +boolean + diff --git a/new-docs/puppeteer.filechooser.md b/new-docs/puppeteer.filechooser.md new file mode 100644 index 00000000000..71522b0d61c --- /dev/null +++ b/new-docs/puppeteer.filechooser.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FileChooser](./puppeteer.filechooser.md) + +## FileChooser class + +Signature: + +```typescript +export declare class FileChooser +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(element, event)](./puppeteer.filechooser._constructor_.md) | | Constructs a new instance of the FileChooser class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [accept(filePaths)](./puppeteer.filechooser.accept.md) | | | +| [cancel()](./puppeteer.filechooser.cancel.md) | | | +| [isMultiple()](./puppeteer.filechooser.ismultiple.md) | | | + diff --git a/new-docs/puppeteer.frame._.md b/new-docs/puppeteer.frame._.md new file mode 100644 index 00000000000..7cc28118145 --- /dev/null +++ b/new-docs/puppeteer.frame._.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [$](./puppeteer.frame._.md) + +## Frame.$() method + +Signature: + +```typescript +$(selector: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md) \| null> + diff --git a/new-docs/puppeteer.frame.__.md b/new-docs/puppeteer.frame.__.md new file mode 100644 index 00000000000..85377779fe8 --- /dev/null +++ b/new-docs/puppeteer.frame.__.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [$$](./puppeteer.frame.__.md) + +## Frame.$$() method + +Signature: + +```typescript +$$(selector: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md)\[\]> + diff --git a/new-docs/puppeteer.frame.__eval.md b/new-docs/puppeteer.frame.__eval.md new file mode 100644 index 00000000000..0a7d7a9e18d --- /dev/null +++ b/new-docs/puppeteer.frame.__eval.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [$$eval](./puppeteer.frame.__eval.md) + +## Frame.$$eval() method + +Signature: + +```typescript +$$eval(selector: string, pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<ReturnType> + diff --git a/new-docs/puppeteer.frame._childframes.md b/new-docs/puppeteer.frame._childframes.md new file mode 100644 index 00000000000..cc06fb39293 --- /dev/null +++ b/new-docs/puppeteer.frame._childframes.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_childFrames](./puppeteer.frame._childframes.md) + +## Frame.\_childFrames property + +Signature: + +```typescript +_childFrames: Set; +``` diff --git a/new-docs/puppeteer.frame._client.md b/new-docs/puppeteer.frame._client.md new file mode 100644 index 00000000000..dcd51cc97a9 --- /dev/null +++ b/new-docs/puppeteer.frame._client.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_client](./puppeteer.frame._client.md) + +## Frame.\_client property + +Signature: + +```typescript +_client: CDPSession; +``` diff --git a/new-docs/puppeteer.frame._constructor_.md b/new-docs/puppeteer.frame._constructor_.md new file mode 100644 index 00000000000..55183054d3e --- /dev/null +++ b/new-docs/puppeteer.frame._constructor_.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [(constructor)](./puppeteer.frame._constructor_.md) + +## Frame.(constructor) + +Constructs a new instance of the `Frame` class + +Signature: + +```typescript +constructor(frameManager: FrameManager, client: CDPSession, parentFrame: Frame | null, frameId: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| frameManager | [FrameManager](./puppeteer.framemanager.md) | | +| client | [CDPSession](./puppeteer.cdpsession.md) | | +| parentFrame | [Frame](./puppeteer.frame.md) \| null | | +| frameId | string | | + diff --git a/new-docs/puppeteer.frame._detach.md b/new-docs/puppeteer.frame._detach.md new file mode 100644 index 00000000000..847829c5c0c --- /dev/null +++ b/new-docs/puppeteer.frame._detach.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_detach](./puppeteer.frame._detach.md) + +## Frame.\_detach() method + +Signature: + +```typescript +_detach(): void; +``` +Returns: + +void + diff --git a/new-docs/puppeteer.frame._detached.md b/new-docs/puppeteer.frame._detached.md new file mode 100644 index 00000000000..9e8eb632c4a --- /dev/null +++ b/new-docs/puppeteer.frame._detached.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_detached](./puppeteer.frame._detached.md) + +## Frame.\_detached property + +Signature: + +```typescript +_detached: boolean; +``` diff --git a/new-docs/puppeteer.frame._eval.md b/new-docs/puppeteer.frame._eval.md new file mode 100644 index 00000000000..0d5d3066c14 --- /dev/null +++ b/new-docs/puppeteer.frame._eval.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [$eval](./puppeteer.frame._eval.md) + +## Frame.$eval() method + +Signature: + +```typescript +$eval(selector: string, pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<ReturnType> + diff --git a/new-docs/puppeteer.frame._framemanager.md b/new-docs/puppeteer.frame._framemanager.md new file mode 100644 index 00000000000..124fcbb90a5 --- /dev/null +++ b/new-docs/puppeteer.frame._framemanager.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_frameManager](./puppeteer.frame._framemanager.md) + +## Frame.\_frameManager property + +Signature: + +```typescript +_frameManager: FrameManager; +``` diff --git a/new-docs/puppeteer.frame._id.md b/new-docs/puppeteer.frame._id.md new file mode 100644 index 00000000000..6c72a3e6524 --- /dev/null +++ b/new-docs/puppeteer.frame._id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_id](./puppeteer.frame._id.md) + +## Frame.\_id property + +Signature: + +```typescript +_id: string; +``` diff --git a/new-docs/puppeteer.frame._lifecycleevents.md b/new-docs/puppeteer.frame._lifecycleevents.md new file mode 100644 index 00000000000..b92fc366d6c --- /dev/null +++ b/new-docs/puppeteer.frame._lifecycleevents.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_lifecycleEvents](./puppeteer.frame._lifecycleevents.md) + +## Frame.\_lifecycleEvents property + +Signature: + +```typescript +_lifecycleEvents: Set; +``` diff --git a/new-docs/puppeteer.frame._loaderid.md b/new-docs/puppeteer.frame._loaderid.md new file mode 100644 index 00000000000..1d100bdf9c3 --- /dev/null +++ b/new-docs/puppeteer.frame._loaderid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_loaderId](./puppeteer.frame._loaderid.md) + +## Frame.\_loaderId property + +Signature: + +```typescript +_loaderId: string; +``` diff --git a/new-docs/puppeteer.frame._mainworld.md b/new-docs/puppeteer.frame._mainworld.md new file mode 100644 index 00000000000..6ed38cb4a23 --- /dev/null +++ b/new-docs/puppeteer.frame._mainworld.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_mainWorld](./puppeteer.frame._mainworld.md) + +## Frame.\_mainWorld property + +Signature: + +```typescript +_mainWorld: DOMWorld; +``` diff --git a/new-docs/puppeteer.frame._name.md b/new-docs/puppeteer.frame._name.md new file mode 100644 index 00000000000..5634ef7c88d --- /dev/null +++ b/new-docs/puppeteer.frame._name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_name](./puppeteer.frame._name.md) + +## Frame.\_name property + +Signature: + +```typescript +_name?: string; +``` diff --git a/new-docs/puppeteer.frame._navigated.md b/new-docs/puppeteer.frame._navigated.md new file mode 100644 index 00000000000..52aca09a989 --- /dev/null +++ b/new-docs/puppeteer.frame._navigated.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_navigated](./puppeteer.frame._navigated.md) + +## Frame.\_navigated() method + +Signature: + +```typescript +_navigated(framePayload: Protocol.Page.Frame): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| framePayload | Protocol.Page.Frame | | + +Returns: + +void + diff --git a/new-docs/puppeteer.frame._navigatedwithindocument.md b/new-docs/puppeteer.frame._navigatedwithindocument.md new file mode 100644 index 00000000000..8274974a5cb --- /dev/null +++ b/new-docs/puppeteer.frame._navigatedwithindocument.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_navigatedWithinDocument](./puppeteer.frame._navigatedwithindocument.md) + +## Frame.\_navigatedWithinDocument() method + +Signature: + +```typescript +_navigatedWithinDocument(url: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| url | string | | + +Returns: + +void + diff --git a/new-docs/puppeteer.frame._onlifecycleevent.md b/new-docs/puppeteer.frame._onlifecycleevent.md new file mode 100644 index 00000000000..ead82321172 --- /dev/null +++ b/new-docs/puppeteer.frame._onlifecycleevent.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_onLifecycleEvent](./puppeteer.frame._onlifecycleevent.md) + +## Frame.\_onLifecycleEvent() method + +Signature: + +```typescript +_onLifecycleEvent(loaderId: string, name: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| loaderId | string | | +| name | string | | + +Returns: + +void + diff --git a/new-docs/puppeteer.frame._onloadingstopped.md b/new-docs/puppeteer.frame._onloadingstopped.md new file mode 100644 index 00000000000..f5db1400a76 --- /dev/null +++ b/new-docs/puppeteer.frame._onloadingstopped.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_onLoadingStopped](./puppeteer.frame._onloadingstopped.md) + +## Frame.\_onLoadingStopped() method + +Signature: + +```typescript +_onLoadingStopped(): void; +``` +Returns: + +void + diff --git a/new-docs/puppeteer.frame._parentframe.md b/new-docs/puppeteer.frame._parentframe.md new file mode 100644 index 00000000000..305bb3fae5e --- /dev/null +++ b/new-docs/puppeteer.frame._parentframe.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_parentFrame](./puppeteer.frame._parentframe.md) + +## Frame.\_parentFrame property + +Signature: + +```typescript +_parentFrame?: Frame; +``` diff --git a/new-docs/puppeteer.frame._secondaryworld.md b/new-docs/puppeteer.frame._secondaryworld.md new file mode 100644 index 00000000000..dccb93c72a7 --- /dev/null +++ b/new-docs/puppeteer.frame._secondaryworld.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_secondaryWorld](./puppeteer.frame._secondaryworld.md) + +## Frame.\_secondaryWorld property + +Signature: + +```typescript +_secondaryWorld: DOMWorld; +``` diff --git a/new-docs/puppeteer.frame._url.md b/new-docs/puppeteer.frame._url.md new file mode 100644 index 00000000000..78b45c973c5 --- /dev/null +++ b/new-docs/puppeteer.frame._url.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [\_url](./puppeteer.frame._url.md) + +## Frame.\_url property + +Signature: + +```typescript +_url: string; +``` diff --git a/new-docs/puppeteer.frame._x.md b/new-docs/puppeteer.frame._x.md new file mode 100644 index 00000000000..dded77cc4a7 --- /dev/null +++ b/new-docs/puppeteer.frame._x.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [$x](./puppeteer.frame._x.md) + +## Frame.$x() method + +Signature: + +```typescript +$x(expression: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| expression | string | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md)\[\]> + diff --git a/new-docs/puppeteer.frame.addscripttag.md b/new-docs/puppeteer.frame.addscripttag.md new file mode 100644 index 00000000000..f1fe45de1d0 --- /dev/null +++ b/new-docs/puppeteer.frame.addscripttag.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [addScriptTag](./puppeteer.frame.addscripttag.md) + +## Frame.addScriptTag() method + +Signature: + +```typescript +addScriptTag(options: { + url?: string; + path?: string; + content?: string; + type?: string; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | { url?: string; path?: string; content?: string; type?: string; } | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md)> + diff --git a/new-docs/puppeteer.frame.addstyletag.md b/new-docs/puppeteer.frame.addstyletag.md new file mode 100644 index 00000000000..b712110478c --- /dev/null +++ b/new-docs/puppeteer.frame.addstyletag.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [addStyleTag](./puppeteer.frame.addstyletag.md) + +## Frame.addStyleTag() method + +Signature: + +```typescript +addStyleTag(options: { + url?: string; + path?: string; + content?: string; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | { url?: string; path?: string; content?: string; } | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md)> + diff --git a/new-docs/puppeteer.frame.childframes.md b/new-docs/puppeteer.frame.childframes.md new file mode 100644 index 00000000000..9982ca4a845 --- /dev/null +++ b/new-docs/puppeteer.frame.childframes.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [childFrames](./puppeteer.frame.childframes.md) + +## Frame.childFrames() method + +Signature: + +```typescript +childFrames(): Frame[]; +``` +Returns: + +[Frame](./puppeteer.frame.md)\[\] + diff --git a/new-docs/puppeteer.frame.click.md b/new-docs/puppeteer.frame.click.md new file mode 100644 index 00000000000..bd3e7d4c7be --- /dev/null +++ b/new-docs/puppeteer.frame.click.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [click](./puppeteer.frame.click.md) + +## Frame.click() method + +Signature: + +```typescript +click(selector: string, options: { + delay?: number; + button?: MouseButtonInput; + clickCount?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| options | { delay?: number; button?: [MouseButtonInput](./puppeteer.mousebuttoninput.md); clickCount?: number; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.frame.content.md b/new-docs/puppeteer.frame.content.md new file mode 100644 index 00000000000..8d94c3de52c --- /dev/null +++ b/new-docs/puppeteer.frame.content.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [content](./puppeteer.frame.content.md) + +## Frame.content() method + +Signature: + +```typescript +content(): Promise; +``` +Returns: + +Promise<string> + diff --git a/new-docs/puppeteer.frame.evaluate.md b/new-docs/puppeteer.frame.evaluate.md new file mode 100644 index 00000000000..23074cbee88 --- /dev/null +++ b/new-docs/puppeteer.frame.evaluate.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [evaluate](./puppeteer.frame.evaluate.md) + +## Frame.evaluate() method + +Signature: + +```typescript +evaluate(pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<ReturnType> + diff --git a/new-docs/puppeteer.frame.evaluatehandle.md b/new-docs/puppeteer.frame.evaluatehandle.md new file mode 100644 index 00000000000..57b20326df5 --- /dev/null +++ b/new-docs/puppeteer.frame.evaluatehandle.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [evaluateHandle](./puppeteer.frame.evaluatehandle.md) + +## Frame.evaluateHandle() method + +Signature: + +```typescript +evaluateHandle(pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<[JSHandle](./puppeteer.jshandle.md)> + diff --git a/new-docs/puppeteer.frame.executioncontext.md b/new-docs/puppeteer.frame.executioncontext.md new file mode 100644 index 00000000000..60ef59fef4d --- /dev/null +++ b/new-docs/puppeteer.frame.executioncontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [executionContext](./puppeteer.frame.executioncontext.md) + +## Frame.executionContext() method + +Signature: + +```typescript +executionContext(): Promise; +``` +Returns: + +Promise<[ExecutionContext](./puppeteer.executioncontext.md)> + diff --git a/new-docs/puppeteer.frame.focus.md b/new-docs/puppeteer.frame.focus.md new file mode 100644 index 00000000000..60fe5ad73d8 --- /dev/null +++ b/new-docs/puppeteer.frame.focus.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [focus](./puppeteer.frame.focus.md) + +## Frame.focus() method + +Signature: + +```typescript +focus(selector: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.frame.goto.md b/new-docs/puppeteer.frame.goto.md new file mode 100644 index 00000000000..b98308a45c1 --- /dev/null +++ b/new-docs/puppeteer.frame.goto.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [goto](./puppeteer.frame.goto.md) + +## Frame.goto() method + +Signature: + +```typescript +goto(url: string, options: { + referer?: string; + timeout?: number; + waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[]; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| url | string | | +| options | { referer?: string; timeout?: number; waitUntil?: PuppeteerLifeCycleEvent \| PuppeteerLifeCycleEvent\[\]; } | | + +Returns: + +Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null> + diff --git a/new-docs/puppeteer.frame.hover.md b/new-docs/puppeteer.frame.hover.md new file mode 100644 index 00000000000..669a6b7d260 --- /dev/null +++ b/new-docs/puppeteer.frame.hover.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [hover](./puppeteer.frame.hover.md) + +## Frame.hover() method + +Signature: + +```typescript +hover(selector: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.frame.isdetached.md b/new-docs/puppeteer.frame.isdetached.md new file mode 100644 index 00000000000..5af2132f0e0 --- /dev/null +++ b/new-docs/puppeteer.frame.isdetached.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [isDetached](./puppeteer.frame.isdetached.md) + +## Frame.isDetached() method + +Signature: + +```typescript +isDetached(): boolean; +``` +Returns: + +boolean + diff --git a/new-docs/puppeteer.frame.md b/new-docs/puppeteer.frame.md new file mode 100644 index 00000000000..2325efe6703 --- /dev/null +++ b/new-docs/puppeteer.frame.md @@ -0,0 +1,75 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) + +## Frame class + +Signature: + +```typescript +export declare class Frame +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(frameManager, client, parentFrame, frameId)](./puppeteer.frame._constructor_.md) | | Constructs a new instance of the Frame class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_childFrames](./puppeteer.frame._childframes.md) | | Set<[Frame](./puppeteer.frame.md)> | | +| [\_client](./puppeteer.frame._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | | +| [\_detached](./puppeteer.frame._detached.md) | | boolean | | +| [\_frameManager](./puppeteer.frame._framemanager.md) | | [FrameManager](./puppeteer.framemanager.md) | | +| [\_id](./puppeteer.frame._id.md) | | string | | +| [\_lifecycleEvents](./puppeteer.frame._lifecycleevents.md) | | Set<string> | | +| [\_loaderId](./puppeteer.frame._loaderid.md) | | string | | +| [\_mainWorld](./puppeteer.frame._mainworld.md) | | DOMWorld | | +| [\_name](./puppeteer.frame._name.md) | | string | | +| [\_parentFrame](./puppeteer.frame._parentframe.md) | | [Frame](./puppeteer.frame.md) | | +| [\_secondaryWorld](./puppeteer.frame._secondaryworld.md) | | DOMWorld | | +| [\_url](./puppeteer.frame._url.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_detach()](./puppeteer.frame._detach.md) | | | +| [\_navigated(framePayload)](./puppeteer.frame._navigated.md) | | | +| [\_navigatedWithinDocument(url)](./puppeteer.frame._navigatedwithindocument.md) | | | +| [\_onLifecycleEvent(loaderId, name)](./puppeteer.frame._onlifecycleevent.md) | | | +| [\_onLoadingStopped()](./puppeteer.frame._onloadingstopped.md) | | | +| [$(selector)](./puppeteer.frame._.md) | | | +| [$$(selector)](./puppeteer.frame.__.md) | | | +| [$$eval(selector, pageFunction, args)](./puppeteer.frame.__eval.md) | | | +| [$eval(selector, pageFunction, args)](./puppeteer.frame._eval.md) | | | +| [$x(expression)](./puppeteer.frame._x.md) | | | +| [addScriptTag(options)](./puppeteer.frame.addscripttag.md) | | | +| [addStyleTag(options)](./puppeteer.frame.addstyletag.md) | | | +| [childFrames()](./puppeteer.frame.childframes.md) | | | +| [click(selector, options)](./puppeteer.frame.click.md) | | | +| [content()](./puppeteer.frame.content.md) | | | +| [evaluate(pageFunction, args)](./puppeteer.frame.evaluate.md) | | | +| [evaluateHandle(pageFunction, args)](./puppeteer.frame.evaluatehandle.md) | | | +| [executionContext()](./puppeteer.frame.executioncontext.md) | | | +| [focus(selector)](./puppeteer.frame.focus.md) | | | +| [goto(url, options)](./puppeteer.frame.goto.md) | | | +| [hover(selector)](./puppeteer.frame.hover.md) | | | +| [isDetached()](./puppeteer.frame.isdetached.md) | | | +| [name()](./puppeteer.frame.name.md) | | | +| [parentFrame()](./puppeteer.frame.parentframe.md) | | | +| [select(selector, values)](./puppeteer.frame.select.md) | | | +| [setContent(html, options)](./puppeteer.frame.setcontent.md) | | | +| [tap(selector)](./puppeteer.frame.tap.md) | | | +| [title()](./puppeteer.frame.title.md) | | | +| [type(selector, text, options)](./puppeteer.frame.type.md) | | | +| [url()](./puppeteer.frame.url.md) | | | +| [waitFor(selectorOrFunctionOrTimeout, options, args)](./puppeteer.frame.waitfor.md) | | | +| [waitForFunction(pageFunction, options, args)](./puppeteer.frame.waitforfunction.md) | | | +| [waitForNavigation(options)](./puppeteer.frame.waitfornavigation.md) | | | +| [waitForSelector(selector, options)](./puppeteer.frame.waitforselector.md) | | | +| [waitForXPath(xpath, options)](./puppeteer.frame.waitforxpath.md) | | | + diff --git a/new-docs/puppeteer.frame.name.md b/new-docs/puppeteer.frame.name.md new file mode 100644 index 00000000000..61cad68e0c2 --- /dev/null +++ b/new-docs/puppeteer.frame.name.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [name](./puppeteer.frame.name.md) + +## Frame.name() method + +Signature: + +```typescript +name(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.frame.parentframe.md b/new-docs/puppeteer.frame.parentframe.md new file mode 100644 index 00000000000..398e314b44c --- /dev/null +++ b/new-docs/puppeteer.frame.parentframe.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [parentFrame](./puppeteer.frame.parentframe.md) + +## Frame.parentFrame() method + +Signature: + +```typescript +parentFrame(): Frame | null; +``` +Returns: + +[Frame](./puppeteer.frame.md) \| null + diff --git a/new-docs/puppeteer.frame.select.md b/new-docs/puppeteer.frame.select.md new file mode 100644 index 00000000000..f0a637679b8 --- /dev/null +++ b/new-docs/puppeteer.frame.select.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [select](./puppeteer.frame.select.md) + +## Frame.select() method + +Signature: + +```typescript +select(selector: string, ...values: string[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| values | string\[\] | | + +Returns: + +Promise<string\[\]> + diff --git a/new-docs/puppeteer.frame.setcontent.md b/new-docs/puppeteer.frame.setcontent.md new file mode 100644 index 00000000000..c4ff93e6fc0 --- /dev/null +++ b/new-docs/puppeteer.frame.setcontent.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [setContent](./puppeteer.frame.setcontent.md) + +## Frame.setContent() method + +Signature: + +```typescript +setContent(html: string, options?: { + timeout?: number; + waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[]; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| html | string | | +| options | { timeout?: number; waitUntil?: PuppeteerLifeCycleEvent \| PuppeteerLifeCycleEvent\[\]; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.frame.tap.md b/new-docs/puppeteer.frame.tap.md new file mode 100644 index 00000000000..393ccf48c8a --- /dev/null +++ b/new-docs/puppeteer.frame.tap.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [tap](./puppeteer.frame.tap.md) + +## Frame.tap() method + +Signature: + +```typescript +tap(selector: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.frame.title.md b/new-docs/puppeteer.frame.title.md new file mode 100644 index 00000000000..0e0f7b1ec6a --- /dev/null +++ b/new-docs/puppeteer.frame.title.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [title](./puppeteer.frame.title.md) + +## Frame.title() method + +Signature: + +```typescript +title(): Promise; +``` +Returns: + +Promise<string> + diff --git a/new-docs/puppeteer.frame.type.md b/new-docs/puppeteer.frame.type.md new file mode 100644 index 00000000000..9a601c56266 --- /dev/null +++ b/new-docs/puppeteer.frame.type.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [type](./puppeteer.frame.type.md) + +## Frame.type() method + +Signature: + +```typescript +type(selector: string, text: string, options?: { + delay: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| text | string | | +| options | { delay: number; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.frame.url.md b/new-docs/puppeteer.frame.url.md new file mode 100644 index 00000000000..801509608eb --- /dev/null +++ b/new-docs/puppeteer.frame.url.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [url](./puppeteer.frame.url.md) + +## Frame.url() method + +Signature: + +```typescript +url(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.frame.waitfor.md b/new-docs/puppeteer.frame.waitfor.md new file mode 100644 index 00000000000..52a4dc4710a --- /dev/null +++ b/new-docs/puppeteer.frame.waitfor.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [waitFor](./puppeteer.frame.waitfor.md) + +## Frame.waitFor() method + +Signature: + +```typescript +waitFor(selectorOrFunctionOrTimeout: string | number | Function, options?: {}, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selectorOrFunctionOrTimeout | string \| number \| Function | | +| options | {} | | +| args | unknown\[\] | | + +Returns: + +Promise<[JSHandle](./puppeteer.jshandle.md) \| null> + diff --git a/new-docs/puppeteer.frame.waitforfunction.md b/new-docs/puppeteer.frame.waitforfunction.md new file mode 100644 index 00000000000..93692db5809 --- /dev/null +++ b/new-docs/puppeteer.frame.waitforfunction.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [waitForFunction](./puppeteer.frame.waitforfunction.md) + +## Frame.waitForFunction() method + +Signature: + +```typescript +waitForFunction(pageFunction: Function | string, options?: { + polling?: string | number; + timeout?: number; + }, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pageFunction | Function \| string | | +| options | { polling?: string \| number; timeout?: number; } | | +| args | unknown\[\] | | + +Returns: + +Promise<[JSHandle](./puppeteer.jshandle.md)> + diff --git a/new-docs/puppeteer.frame.waitfornavigation.md b/new-docs/puppeteer.frame.waitfornavigation.md new file mode 100644 index 00000000000..f736460fa0a --- /dev/null +++ b/new-docs/puppeteer.frame.waitfornavigation.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [waitForNavigation](./puppeteer.frame.waitfornavigation.md) + +## Frame.waitForNavigation() method + +Signature: + +```typescript +waitForNavigation(options: { + timeout?: number; + waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[]; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | { timeout?: number; waitUntil?: PuppeteerLifeCycleEvent \| PuppeteerLifeCycleEvent\[\]; } | | + +Returns: + +Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null> + diff --git a/new-docs/puppeteer.frame.waitforselector.md b/new-docs/puppeteer.frame.waitforselector.md new file mode 100644 index 00000000000..07c2fd1a744 --- /dev/null +++ b/new-docs/puppeteer.frame.waitforselector.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [waitForSelector](./puppeteer.frame.waitforselector.md) + +## Frame.waitForSelector() method + +Signature: + +```typescript +waitForSelector(selector: string, options: WaitForSelectorOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| options | WaitForSelectorOptions | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md) \| null> + diff --git a/new-docs/puppeteer.frame.waitforxpath.md b/new-docs/puppeteer.frame.waitforxpath.md new file mode 100644 index 00000000000..46c1de6039e --- /dev/null +++ b/new-docs/puppeteer.frame.waitforxpath.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [waitForXPath](./puppeteer.frame.waitforxpath.md) + +## Frame.waitForXPath() method + +Signature: + +```typescript +waitForXPath(xpath: string, options: WaitForSelectorOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| xpath | string | | +| options | WaitForSelectorOptions | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md) \| null> + diff --git a/new-docs/puppeteer.framemanager._client.md b/new-docs/puppeteer.framemanager._client.md new file mode 100644 index 00000000000..bde37e38006 --- /dev/null +++ b/new-docs/puppeteer.framemanager._client.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_client](./puppeteer.framemanager._client.md) + +## FrameManager.\_client property + +Signature: + +```typescript +_client: CDPSession; +``` diff --git a/new-docs/puppeteer.framemanager._constructor_.md b/new-docs/puppeteer.framemanager._constructor_.md new file mode 100644 index 00000000000..067e389ddff --- /dev/null +++ b/new-docs/puppeteer.framemanager._constructor_.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [(constructor)](./puppeteer.framemanager._constructor_.md) + +## FrameManager.(constructor) + +Constructs a new instance of the `FrameManager` class + +Signature: + +```typescript +constructor(client: CDPSession, page: Page, ignoreHTTPSErrors: boolean, timeoutSettings: TimeoutSettings); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | +| page | [Page](./puppeteer.page.md) | | +| ignoreHTTPSErrors | boolean | | +| timeoutSettings | TimeoutSettings | | + diff --git a/new-docs/puppeteer.framemanager._contextidtocontext.md b/new-docs/puppeteer.framemanager._contextidtocontext.md new file mode 100644 index 00000000000..c60b654f62f --- /dev/null +++ b/new-docs/puppeteer.framemanager._contextidtocontext.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_contextIdToContext](./puppeteer.framemanager._contextidtocontext.md) + +## FrameManager.\_contextIdToContext property + +Signature: + +```typescript +_contextIdToContext: Map; +``` diff --git a/new-docs/puppeteer.framemanager._ensureisolatedworld.md b/new-docs/puppeteer.framemanager._ensureisolatedworld.md new file mode 100644 index 00000000000..2f9d2249db3 --- /dev/null +++ b/new-docs/puppeteer.framemanager._ensureisolatedworld.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_ensureIsolatedWorld](./puppeteer.framemanager._ensureisolatedworld.md) + +## FrameManager.\_ensureIsolatedWorld() method + +Signature: + +```typescript +_ensureIsolatedWorld(name: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.framemanager._frames.md b/new-docs/puppeteer.framemanager._frames.md new file mode 100644 index 00000000000..a74fe1c92cf --- /dev/null +++ b/new-docs/puppeteer.framemanager._frames.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_frames](./puppeteer.framemanager._frames.md) + +## FrameManager.\_frames property + +Signature: + +```typescript +_frames: Map; +``` diff --git a/new-docs/puppeteer.framemanager._handleframetree.md b/new-docs/puppeteer.framemanager._handleframetree.md new file mode 100644 index 00000000000..545cda4e2de --- /dev/null +++ b/new-docs/puppeteer.framemanager._handleframetree.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_handleFrameTree](./puppeteer.framemanager._handleframetree.md) + +## FrameManager.\_handleFrameTree() method + +Signature: + +```typescript +_handleFrameTree(frameTree: Protocol.Page.FrameTree): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| frameTree | Protocol.Page.FrameTree | | + +Returns: + +void + diff --git a/new-docs/puppeteer.framemanager._isolatedworlds.md b/new-docs/puppeteer.framemanager._isolatedworlds.md new file mode 100644 index 00000000000..aedc83c344e --- /dev/null +++ b/new-docs/puppeteer.framemanager._isolatedworlds.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_isolatedWorlds](./puppeteer.framemanager._isolatedworlds.md) + +## FrameManager.\_isolatedWorlds property + +Signature: + +```typescript +_isolatedWorlds: Set; +``` diff --git a/new-docs/puppeteer.framemanager._mainframe.md b/new-docs/puppeteer.framemanager._mainframe.md new file mode 100644 index 00000000000..8fe456f2b31 --- /dev/null +++ b/new-docs/puppeteer.framemanager._mainframe.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_mainFrame](./puppeteer.framemanager._mainframe.md) + +## FrameManager.\_mainFrame property + +Signature: + +```typescript +_mainFrame: Frame; +``` diff --git a/new-docs/puppeteer.framemanager._networkmanager.md b/new-docs/puppeteer.framemanager._networkmanager.md new file mode 100644 index 00000000000..e9a423e6538 --- /dev/null +++ b/new-docs/puppeteer.framemanager._networkmanager.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_networkManager](./puppeteer.framemanager._networkmanager.md) + +## FrameManager.\_networkManager property + +Signature: + +```typescript +_networkManager: NetworkManager; +``` diff --git a/new-docs/puppeteer.framemanager._onexecutioncontextcreated.md b/new-docs/puppeteer.framemanager._onexecutioncontextcreated.md new file mode 100644 index 00000000000..d1c758f5dcf --- /dev/null +++ b/new-docs/puppeteer.framemanager._onexecutioncontextcreated.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onExecutionContextCreated](./puppeteer.framemanager._onexecutioncontextcreated.md) + +## FrameManager.\_onExecutionContextCreated() method + +Signature: + +```typescript +_onExecutionContextCreated(contextPayload: Protocol.Runtime.ExecutionContextDescription): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| contextPayload | Protocol.Runtime.ExecutionContextDescription | | + +Returns: + +void + diff --git a/new-docs/puppeteer.framemanager._onexecutioncontextdestroyed.md b/new-docs/puppeteer.framemanager._onexecutioncontextdestroyed.md new file mode 100644 index 00000000000..28e94748143 --- /dev/null +++ b/new-docs/puppeteer.framemanager._onexecutioncontextdestroyed.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onExecutionContextDestroyed](./puppeteer.framemanager._onexecutioncontextdestroyed.md) + +## FrameManager.\_onExecutionContextDestroyed() method + +Signature: + +```typescript +_onExecutionContextDestroyed(executionContextId: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| executionContextId | number | | + +Returns: + +void + diff --git a/new-docs/puppeteer.framemanager._onexecutioncontextscleared.md b/new-docs/puppeteer.framemanager._onexecutioncontextscleared.md new file mode 100644 index 00000000000..8913a030033 --- /dev/null +++ b/new-docs/puppeteer.framemanager._onexecutioncontextscleared.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onExecutionContextsCleared](./puppeteer.framemanager._onexecutioncontextscleared.md) + +## FrameManager.\_onExecutionContextsCleared() method + +Signature: + +```typescript +_onExecutionContextsCleared(): void; +``` +Returns: + +void + diff --git a/new-docs/puppeteer.framemanager._onframeattached.md b/new-docs/puppeteer.framemanager._onframeattached.md new file mode 100644 index 00000000000..252104259e3 --- /dev/null +++ b/new-docs/puppeteer.framemanager._onframeattached.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onFrameAttached](./puppeteer.framemanager._onframeattached.md) + +## FrameManager.\_onFrameAttached() method + +Signature: + +```typescript +_onFrameAttached(frameId: string, parentFrameId?: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| frameId | string | | +| parentFrameId | string | | + +Returns: + +void + diff --git a/new-docs/puppeteer.framemanager._onframedetached.md b/new-docs/puppeteer.framemanager._onframedetached.md new file mode 100644 index 00000000000..06f2e33cced --- /dev/null +++ b/new-docs/puppeteer.framemanager._onframedetached.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onFrameDetached](./puppeteer.framemanager._onframedetached.md) + +## FrameManager.\_onFrameDetached() method + +Signature: + +```typescript +_onFrameDetached(frameId: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| frameId | string | | + +Returns: + +void + diff --git a/new-docs/puppeteer.framemanager._onframenavigated.md b/new-docs/puppeteer.framemanager._onframenavigated.md new file mode 100644 index 00000000000..8936b209bab --- /dev/null +++ b/new-docs/puppeteer.framemanager._onframenavigated.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onFrameNavigated](./puppeteer.framemanager._onframenavigated.md) + +## FrameManager.\_onFrameNavigated() method + +Signature: + +```typescript +_onFrameNavigated(framePayload: Protocol.Page.Frame): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| framePayload | Protocol.Page.Frame | | + +Returns: + +void + diff --git a/new-docs/puppeteer.framemanager._onframenavigatedwithindocument.md b/new-docs/puppeteer.framemanager._onframenavigatedwithindocument.md new file mode 100644 index 00000000000..a88e63c194f --- /dev/null +++ b/new-docs/puppeteer.framemanager._onframenavigatedwithindocument.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onFrameNavigatedWithinDocument](./puppeteer.framemanager._onframenavigatedwithindocument.md) + +## FrameManager.\_onFrameNavigatedWithinDocument() method + +Signature: + +```typescript +_onFrameNavigatedWithinDocument(frameId: string, url: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| frameId | string | | +| url | string | | + +Returns: + +void + diff --git a/new-docs/puppeteer.framemanager._onframestoppedloading.md b/new-docs/puppeteer.framemanager._onframestoppedloading.md new file mode 100644 index 00000000000..a174247deac --- /dev/null +++ b/new-docs/puppeteer.framemanager._onframestoppedloading.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onFrameStoppedLoading](./puppeteer.framemanager._onframestoppedloading.md) + +## FrameManager.\_onFrameStoppedLoading() method + +Signature: + +```typescript +_onFrameStoppedLoading(frameId: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| frameId | string | | + +Returns: + +void + diff --git a/new-docs/puppeteer.framemanager._onlifecycleevent.md b/new-docs/puppeteer.framemanager._onlifecycleevent.md new file mode 100644 index 00000000000..038eda0e947 --- /dev/null +++ b/new-docs/puppeteer.framemanager._onlifecycleevent.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_onLifecycleEvent](./puppeteer.framemanager._onlifecycleevent.md) + +## FrameManager.\_onLifecycleEvent() method + +Signature: + +```typescript +_onLifecycleEvent(event: Protocol.Page.lifecycleEventPayload): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | Protocol.Page.lifecycleEventPayload | | + +Returns: + +void + diff --git a/new-docs/puppeteer.framemanager._page.md b/new-docs/puppeteer.framemanager._page.md new file mode 100644 index 00000000000..d7529db6283 --- /dev/null +++ b/new-docs/puppeteer.framemanager._page.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_page](./puppeteer.framemanager._page.md) + +## FrameManager.\_page property + +Signature: + +```typescript +_page: Page; +``` diff --git a/new-docs/puppeteer.framemanager._removeframesrecursively.md b/new-docs/puppeteer.framemanager._removeframesrecursively.md new file mode 100644 index 00000000000..508e8799bfb --- /dev/null +++ b/new-docs/puppeteer.framemanager._removeframesrecursively.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_removeFramesRecursively](./puppeteer.framemanager._removeframesrecursively.md) + +## FrameManager.\_removeFramesRecursively() method + +Signature: + +```typescript +_removeFramesRecursively(frame: Frame): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| frame | [Frame](./puppeteer.frame.md) | | + +Returns: + +void + diff --git a/new-docs/puppeteer.framemanager._timeoutsettings.md b/new-docs/puppeteer.framemanager._timeoutsettings.md new file mode 100644 index 00000000000..1fa9f5b8dea --- /dev/null +++ b/new-docs/puppeteer.framemanager._timeoutsettings.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [\_timeoutSettings](./puppeteer.framemanager._timeoutsettings.md) + +## FrameManager.\_timeoutSettings property + +Signature: + +```typescript +_timeoutSettings: TimeoutSettings; +``` diff --git a/new-docs/puppeteer.framemanager.executioncontextbyid.md b/new-docs/puppeteer.framemanager.executioncontextbyid.md new file mode 100644 index 00000000000..c55d5ba2c85 --- /dev/null +++ b/new-docs/puppeteer.framemanager.executioncontextbyid.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [executionContextById](./puppeteer.framemanager.executioncontextbyid.md) + +## FrameManager.executionContextById() method + +Signature: + +```typescript +executionContextById(contextId: number): ExecutionContext; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| contextId | number | | + +Returns: + +[ExecutionContext](./puppeteer.executioncontext.md) + diff --git a/new-docs/puppeteer.framemanager.frame.md b/new-docs/puppeteer.framemanager.frame.md new file mode 100644 index 00000000000..36d57266c9c --- /dev/null +++ b/new-docs/puppeteer.framemanager.frame.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [frame](./puppeteer.framemanager.frame.md) + +## FrameManager.frame() method + +Signature: + +```typescript +frame(frameId: string): Frame | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| frameId | string | | + +Returns: + +[Frame](./puppeteer.frame.md) \| null + diff --git a/new-docs/puppeteer.framemanager.frames.md b/new-docs/puppeteer.framemanager.frames.md new file mode 100644 index 00000000000..efff043ca52 --- /dev/null +++ b/new-docs/puppeteer.framemanager.frames.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [frames](./puppeteer.framemanager.frames.md) + +## FrameManager.frames() method + +Signature: + +```typescript +frames(): Frame[]; +``` +Returns: + +[Frame](./puppeteer.frame.md)\[\] + diff --git a/new-docs/puppeteer.framemanager.initialize.md b/new-docs/puppeteer.framemanager.initialize.md new file mode 100644 index 00000000000..4cc05ce1e25 --- /dev/null +++ b/new-docs/puppeteer.framemanager.initialize.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [initialize](./puppeteer.framemanager.initialize.md) + +## FrameManager.initialize() method + +Signature: + +```typescript +initialize(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.framemanager.mainframe.md b/new-docs/puppeteer.framemanager.mainframe.md new file mode 100644 index 00000000000..a6e34f0c1de --- /dev/null +++ b/new-docs/puppeteer.framemanager.mainframe.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [mainFrame](./puppeteer.framemanager.mainframe.md) + +## FrameManager.mainFrame() method + +Signature: + +```typescript +mainFrame(): Frame; +``` +Returns: + +[Frame](./puppeteer.frame.md) + diff --git a/new-docs/puppeteer.framemanager.md b/new-docs/puppeteer.framemanager.md new file mode 100644 index 00000000000..d5322f6fe56 --- /dev/null +++ b/new-docs/puppeteer.framemanager.md @@ -0,0 +1,57 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) + +## FrameManager class + +Signature: + +```typescript +export declare class FrameManager extends EventEmitter +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(client, page, ignoreHTTPSErrors, timeoutSettings)](./puppeteer.framemanager._constructor_.md) | | Constructs a new instance of the FrameManager class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_client](./puppeteer.framemanager._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | | +| [\_contextIdToContext](./puppeteer.framemanager._contextidtocontext.md) | | Map<number, [ExecutionContext](./puppeteer.executioncontext.md)> | | +| [\_frames](./puppeteer.framemanager._frames.md) | | Map<string, [Frame](./puppeteer.frame.md)> | | +| [\_isolatedWorlds](./puppeteer.framemanager._isolatedworlds.md) | | Set<string> | | +| [\_mainFrame](./puppeteer.framemanager._mainframe.md) | | [Frame](./puppeteer.frame.md) | | +| [\_networkManager](./puppeteer.framemanager._networkmanager.md) | | NetworkManager | | +| [\_page](./puppeteer.framemanager._page.md) | | [Page](./puppeteer.page.md) | | +| [\_timeoutSettings](./puppeteer.framemanager._timeoutsettings.md) | | TimeoutSettings | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_ensureIsolatedWorld(name)](./puppeteer.framemanager._ensureisolatedworld.md) | | | +| [\_handleFrameTree(frameTree)](./puppeteer.framemanager._handleframetree.md) | | | +| [\_onExecutionContextCreated(contextPayload)](./puppeteer.framemanager._onexecutioncontextcreated.md) | | | +| [\_onExecutionContextDestroyed(executionContextId)](./puppeteer.framemanager._onexecutioncontextdestroyed.md) | | | +| [\_onExecutionContextsCleared()](./puppeteer.framemanager._onexecutioncontextscleared.md) | | | +| [\_onFrameAttached(frameId, parentFrameId)](./puppeteer.framemanager._onframeattached.md) | | | +| [\_onFrameDetached(frameId)](./puppeteer.framemanager._onframedetached.md) | | | +| [\_onFrameNavigated(framePayload)](./puppeteer.framemanager._onframenavigated.md) | | | +| [\_onFrameNavigatedWithinDocument(frameId, url)](./puppeteer.framemanager._onframenavigatedwithindocument.md) | | | +| [\_onFrameStoppedLoading(frameId)](./puppeteer.framemanager._onframestoppedloading.md) | | | +| [\_onLifecycleEvent(event)](./puppeteer.framemanager._onlifecycleevent.md) | | | +| [\_removeFramesRecursively(frame)](./puppeteer.framemanager._removeframesrecursively.md) | | | +| [executionContextById(contextId)](./puppeteer.framemanager.executioncontextbyid.md) | | | +| [frame(frameId)](./puppeteer.framemanager.frame.md) | | | +| [frames()](./puppeteer.framemanager.frames.md) | | | +| [initialize()](./puppeteer.framemanager.initialize.md) | | | +| [mainFrame()](./puppeteer.framemanager.mainframe.md) | | | +| [navigateFrame(frame, url, options)](./puppeteer.framemanager.navigateframe.md) | | | +| [networkManager()](./puppeteer.framemanager.networkmanager.md) | | | +| [page()](./puppeteer.framemanager.page.md) | | | +| [waitForFrameNavigation(frame, options)](./puppeteer.framemanager.waitforframenavigation.md) | | | + diff --git a/new-docs/puppeteer.framemanager.navigateframe.md b/new-docs/puppeteer.framemanager.navigateframe.md new file mode 100644 index 00000000000..5f16dd527cd --- /dev/null +++ b/new-docs/puppeteer.framemanager.navigateframe.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [navigateFrame](./puppeteer.framemanager.navigateframe.md) + +## FrameManager.navigateFrame() method + +Signature: + +```typescript +navigateFrame(frame: Frame, url: string, options?: { + referer?: string; + timeout?: number; + waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[]; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| frame | [Frame](./puppeteer.frame.md) | | +| url | string | | +| options | { referer?: string; timeout?: number; waitUntil?: PuppeteerLifeCycleEvent \| PuppeteerLifeCycleEvent\[\]; } | | + +Returns: + +Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null> + diff --git a/new-docs/puppeteer.framemanager.networkmanager.md b/new-docs/puppeteer.framemanager.networkmanager.md new file mode 100644 index 00000000000..5a4bd914724 --- /dev/null +++ b/new-docs/puppeteer.framemanager.networkmanager.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [networkManager](./puppeteer.framemanager.networkmanager.md) + +## FrameManager.networkManager() method + +Signature: + +```typescript +networkManager(): NetworkManager; +``` +Returns: + +NetworkManager + diff --git a/new-docs/puppeteer.framemanager.page.md b/new-docs/puppeteer.framemanager.page.md new file mode 100644 index 00000000000..c2518bb3baf --- /dev/null +++ b/new-docs/puppeteer.framemanager.page.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [page](./puppeteer.framemanager.page.md) + +## FrameManager.page() method + +Signature: + +```typescript +page(): Page; +``` +Returns: + +[Page](./puppeteer.page.md) + diff --git a/new-docs/puppeteer.framemanager.waitforframenavigation.md b/new-docs/puppeteer.framemanager.waitforframenavigation.md new file mode 100644 index 00000000000..f470429dbb6 --- /dev/null +++ b/new-docs/puppeteer.framemanager.waitforframenavigation.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [FrameManager](./puppeteer.framemanager.md) > [waitForFrameNavigation](./puppeteer.framemanager.waitforframenavigation.md) + +## FrameManager.waitForFrameNavigation() method + +Signature: + +```typescript +waitForFrameNavigation(frame: Frame, options?: { + timeout?: number; + waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[]; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| frame | [Frame](./puppeteer.frame.md) | | +| options | { timeout?: number; waitUntil?: PuppeteerLifeCycleEvent \| PuppeteerLifeCycleEvent\[\]; } | | + +Returns: + +Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null> + diff --git a/new-docs/puppeteer.httprequest._constructor_.md b/new-docs/puppeteer.httprequest._constructor_.md new file mode 100644 index 00000000000..32a4b6df4db --- /dev/null +++ b/new-docs/puppeteer.httprequest._constructor_.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [(constructor)](./puppeteer.httprequest._constructor_.md) + +## HTTPRequest.(constructor) + +Constructs a new instance of the `HTTPRequest` class + +Signature: + +```typescript +constructor(client: CDPSession, frame: Frame, interceptionId: string, allowInterception: boolean, event: Protocol.Network.requestWillBeSentPayload, redirectChain: HTTPRequest[]); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | +| frame | [Frame](./puppeteer.frame.md) | | +| interceptionId | string | | +| allowInterception | boolean | | +| event | Protocol.Network.requestWillBeSentPayload | | +| redirectChain | [HTTPRequest](./puppeteer.httprequest.md)\[\] | | + diff --git a/new-docs/puppeteer.httprequest._failuretext.md b/new-docs/puppeteer.httprequest._failuretext.md new file mode 100644 index 00000000000..e8a5894a6bd --- /dev/null +++ b/new-docs/puppeteer.httprequest._failuretext.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [\_failureText](./puppeteer.httprequest._failuretext.md) + +## HTTPRequest.\_failureText property + +Signature: + +```typescript +_failureText: any; +``` diff --git a/new-docs/puppeteer.httprequest._frommemorycache.md b/new-docs/puppeteer.httprequest._frommemorycache.md new file mode 100644 index 00000000000..1a42bbe33a5 --- /dev/null +++ b/new-docs/puppeteer.httprequest._frommemorycache.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [\_fromMemoryCache](./puppeteer.httprequest._frommemorycache.md) + +## HTTPRequest.\_fromMemoryCache property + +Signature: + +```typescript +_fromMemoryCache: boolean; +``` diff --git a/new-docs/puppeteer.httprequest._interceptionid.md b/new-docs/puppeteer.httprequest._interceptionid.md new file mode 100644 index 00000000000..2e2353e6314 --- /dev/null +++ b/new-docs/puppeteer.httprequest._interceptionid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [\_interceptionId](./puppeteer.httprequest._interceptionid.md) + +## HTTPRequest.\_interceptionId property + +Signature: + +```typescript +_interceptionId: string; +``` diff --git a/new-docs/puppeteer.httprequest._redirectchain.md b/new-docs/puppeteer.httprequest._redirectchain.md new file mode 100644 index 00000000000..33e89365df3 --- /dev/null +++ b/new-docs/puppeteer.httprequest._redirectchain.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [\_redirectChain](./puppeteer.httprequest._redirectchain.md) + +## HTTPRequest.\_redirectChain property + +Signature: + +```typescript +_redirectChain: HTTPRequest[]; +``` diff --git a/new-docs/puppeteer.httprequest._requestid.md b/new-docs/puppeteer.httprequest._requestid.md new file mode 100644 index 00000000000..57ecf2dfbc0 --- /dev/null +++ b/new-docs/puppeteer.httprequest._requestid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [\_requestId](./puppeteer.httprequest._requestid.md) + +## HTTPRequest.\_requestId property + +Signature: + +```typescript +_requestId: string; +``` diff --git a/new-docs/puppeteer.httprequest._response.md b/new-docs/puppeteer.httprequest._response.md new file mode 100644 index 00000000000..9168ce0ddca --- /dev/null +++ b/new-docs/puppeteer.httprequest._response.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [\_response](./puppeteer.httprequest._response.md) + +## HTTPRequest.\_response property + +Signature: + +```typescript +_response: HTTPResponse | null; +``` diff --git a/new-docs/puppeteer.httprequest.abort.md b/new-docs/puppeteer.httprequest.abort.md new file mode 100644 index 00000000000..34b92e4a579 --- /dev/null +++ b/new-docs/puppeteer.httprequest.abort.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [abort](./puppeteer.httprequest.abort.md) + +## HTTPRequest.abort() method + +Signature: + +```typescript +abort(errorCode?: ErrorCode): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| errorCode | ErrorCode | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.httprequest.continue.md b/new-docs/puppeteer.httprequest.continue.md new file mode 100644 index 00000000000..ec97678627f --- /dev/null +++ b/new-docs/puppeteer.httprequest.continue.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [continue](./puppeteer.httprequest.continue.md) + +## HTTPRequest.continue() method + +Signature: + +```typescript +continue(overrides?: { + url?: string; + method?: string; + postData?: string; + headers?: Record; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| overrides | { url?: string; method?: string; postData?: string; headers?: Record<string, string>; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.httprequest.failure.md b/new-docs/puppeteer.httprequest.failure.md new file mode 100644 index 00000000000..a9e86269481 --- /dev/null +++ b/new-docs/puppeteer.httprequest.failure.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [failure](./puppeteer.httprequest.failure.md) + +## HTTPRequest.failure() method + + {?{errorText: string}} + +Signature: + +```typescript +failure(): { + errorText: string; + } | null; +``` +Returns: + +{ errorText: string; } \| null + diff --git a/new-docs/puppeteer.httprequest.frame.md b/new-docs/puppeteer.httprequest.frame.md new file mode 100644 index 00000000000..86571dbb4f0 --- /dev/null +++ b/new-docs/puppeteer.httprequest.frame.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [frame](./puppeteer.httprequest.frame.md) + +## HTTPRequest.frame() method + +Signature: + +```typescript +frame(): Frame | null; +``` +Returns: + +[Frame](./puppeteer.frame.md) \| null + diff --git a/new-docs/puppeteer.httprequest.headers.md b/new-docs/puppeteer.httprequest.headers.md new file mode 100644 index 00000000000..037ed9bb28a --- /dev/null +++ b/new-docs/puppeteer.httprequest.headers.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [headers](./puppeteer.httprequest.headers.md) + +## HTTPRequest.headers() method + +Signature: + +```typescript +headers(): Record; +``` +Returns: + +Record<string, string> + diff --git a/new-docs/puppeteer.httprequest.isnavigationrequest.md b/new-docs/puppeteer.httprequest.isnavigationrequest.md new file mode 100644 index 00000000000..7dd64b322a8 --- /dev/null +++ b/new-docs/puppeteer.httprequest.isnavigationrequest.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [isNavigationRequest](./puppeteer.httprequest.isnavigationrequest.md) + +## HTTPRequest.isNavigationRequest() method + +Signature: + +```typescript +isNavigationRequest(): boolean; +``` +Returns: + +boolean + diff --git a/new-docs/puppeteer.httprequest.md b/new-docs/puppeteer.httprequest.md new file mode 100644 index 00000000000..f086f6d45b8 --- /dev/null +++ b/new-docs/puppeteer.httprequest.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) + +## HTTPRequest class + +Signature: + +```typescript +export declare class HTTPRequest +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(client, frame, interceptionId, allowInterception, event, redirectChain)](./puppeteer.httprequest._constructor_.md) | | Constructs a new instance of the HTTPRequest class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_failureText](./puppeteer.httprequest._failuretext.md) | | any | | +| [\_fromMemoryCache](./puppeteer.httprequest._frommemorycache.md) | | boolean | | +| [\_interceptionId](./puppeteer.httprequest._interceptionid.md) | | string | | +| [\_redirectChain](./puppeteer.httprequest._redirectchain.md) | | [HTTPRequest](./puppeteer.httprequest.md)\[\] | | +| [\_requestId](./puppeteer.httprequest._requestid.md) | | string | | +| [\_response](./puppeteer.httprequest._response.md) | | [HTTPResponse](./puppeteer.httpresponse.md) \| null | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [abort(errorCode)](./puppeteer.httprequest.abort.md) | | | +| [continue(overrides)](./puppeteer.httprequest.continue.md) | | | +| [failure()](./puppeteer.httprequest.failure.md) | | {?{errorText: string}} | +| [frame()](./puppeteer.httprequest.frame.md) | | | +| [headers()](./puppeteer.httprequest.headers.md) | | | +| [isNavigationRequest()](./puppeteer.httprequest.isnavigationrequest.md) | | | +| [method()](./puppeteer.httprequest.method.md) | | | +| [postData()](./puppeteer.httprequest.postdata.md) | | | +| [redirectChain()](./puppeteer.httprequest.redirectchain.md) | | | +| [resourceType()](./puppeteer.httprequest.resourcetype.md) | | | +| [respond(response)](./puppeteer.httprequest.respond.md) | | | +| [response()](./puppeteer.httprequest.response.md) | | | +| [url()](./puppeteer.httprequest.url.md) | | | + diff --git a/new-docs/puppeteer.httprequest.method.md b/new-docs/puppeteer.httprequest.method.md new file mode 100644 index 00000000000..876f2e8f1d6 --- /dev/null +++ b/new-docs/puppeteer.httprequest.method.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [method](./puppeteer.httprequest.method.md) + +## HTTPRequest.method() method + +Signature: + +```typescript +method(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.httprequest.postdata.md b/new-docs/puppeteer.httprequest.postdata.md new file mode 100644 index 00000000000..565a8d65705 --- /dev/null +++ b/new-docs/puppeteer.httprequest.postdata.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [postData](./puppeteer.httprequest.postdata.md) + +## HTTPRequest.postData() method + +Signature: + +```typescript +postData(): string | undefined; +``` +Returns: + +string \| undefined + diff --git a/new-docs/puppeteer.httprequest.redirectchain.md b/new-docs/puppeteer.httprequest.redirectchain.md new file mode 100644 index 00000000000..9d2222879ff --- /dev/null +++ b/new-docs/puppeteer.httprequest.redirectchain.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [redirectChain](./puppeteer.httprequest.redirectchain.md) + +## HTTPRequest.redirectChain() method + +Signature: + +```typescript +redirectChain(): HTTPRequest[]; +``` +Returns: + +[HTTPRequest](./puppeteer.httprequest.md)\[\] + diff --git a/new-docs/puppeteer.httprequest.resourcetype.md b/new-docs/puppeteer.httprequest.resourcetype.md new file mode 100644 index 00000000000..a286c9bed5d --- /dev/null +++ b/new-docs/puppeteer.httprequest.resourcetype.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [resourceType](./puppeteer.httprequest.resourcetype.md) + +## HTTPRequest.resourceType() method + +Signature: + +```typescript +resourceType(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.httprequest.respond.md b/new-docs/puppeteer.httprequest.respond.md new file mode 100644 index 00000000000..1bd69c6df6c --- /dev/null +++ b/new-docs/puppeteer.httprequest.respond.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [respond](./puppeteer.httprequest.respond.md) + +## HTTPRequest.respond() method + +Signature: + +```typescript +respond(response: { + status: number; + headers: Record; + contentType: string; + body: string | Buffer; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| response | { status: number; headers: Record<string, string>; contentType: string; body: string \| Buffer; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.httprequest.response.md b/new-docs/puppeteer.httprequest.response.md new file mode 100644 index 00000000000..b6d69cd7fd3 --- /dev/null +++ b/new-docs/puppeteer.httprequest.response.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [response](./puppeteer.httprequest.response.md) + +## HTTPRequest.response() method + +Signature: + +```typescript +response(): HTTPResponse | null; +``` +Returns: + +[HTTPResponse](./puppeteer.httpresponse.md) \| null + diff --git a/new-docs/puppeteer.httprequest.url.md b/new-docs/puppeteer.httprequest.url.md new file mode 100644 index 00000000000..fe38e906059 --- /dev/null +++ b/new-docs/puppeteer.httprequest.url.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPRequest](./puppeteer.httprequest.md) > [url](./puppeteer.httprequest.url.md) + +## HTTPRequest.url() method + +Signature: + +```typescript +url(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.httpresponse._constructor_.md b/new-docs/puppeteer.httpresponse._constructor_.md new file mode 100644 index 00000000000..c8ab1043d6f --- /dev/null +++ b/new-docs/puppeteer.httpresponse._constructor_.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [(constructor)](./puppeteer.httpresponse._constructor_.md) + +## HTTPResponse.(constructor) + +Constructs a new instance of the `HTTPResponse` class + +Signature: + +```typescript +constructor(client: CDPSession, request: HTTPRequest, responsePayload: Protocol.Network.Response); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | +| request | [HTTPRequest](./puppeteer.httprequest.md) | | +| responsePayload | Protocol.Network.Response | | + diff --git a/new-docs/puppeteer.httpresponse._resolvebody.md b/new-docs/puppeteer.httpresponse._resolvebody.md new file mode 100644 index 00000000000..aa1294ac795 --- /dev/null +++ b/new-docs/puppeteer.httpresponse._resolvebody.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [\_resolveBody](./puppeteer.httpresponse._resolvebody.md) + +## HTTPResponse.\_resolveBody() method + +Signature: + +```typescript +_resolveBody(err: Error | null): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| err | Error \| null | | + +Returns: + +void + diff --git a/new-docs/puppeteer.httpresponse.buffer.md b/new-docs/puppeteer.httpresponse.buffer.md new file mode 100644 index 00000000000..d31a1b1c56d --- /dev/null +++ b/new-docs/puppeteer.httpresponse.buffer.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [buffer](./puppeteer.httpresponse.buffer.md) + +## HTTPResponse.buffer() method + +Signature: + +```typescript +buffer(): Promise; +``` +Returns: + +Promise<Buffer> + diff --git a/new-docs/puppeteer.httpresponse.frame.md b/new-docs/puppeteer.httpresponse.frame.md new file mode 100644 index 00000000000..dd1847a4202 --- /dev/null +++ b/new-docs/puppeteer.httpresponse.frame.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [frame](./puppeteer.httpresponse.frame.md) + +## HTTPResponse.frame() method + +Signature: + +```typescript +frame(): Frame | null; +``` +Returns: + +[Frame](./puppeteer.frame.md) \| null + diff --git a/new-docs/puppeteer.httpresponse.fromcache.md b/new-docs/puppeteer.httpresponse.fromcache.md new file mode 100644 index 00000000000..a89f753d7d8 --- /dev/null +++ b/new-docs/puppeteer.httpresponse.fromcache.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [fromCache](./puppeteer.httpresponse.fromcache.md) + +## HTTPResponse.fromCache() method + +Signature: + +```typescript +fromCache(): boolean; +``` +Returns: + +boolean + diff --git a/new-docs/puppeteer.httpresponse.fromserviceworker.md b/new-docs/puppeteer.httpresponse.fromserviceworker.md new file mode 100644 index 00000000000..8df04065346 --- /dev/null +++ b/new-docs/puppeteer.httpresponse.fromserviceworker.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [fromServiceWorker](./puppeteer.httpresponse.fromserviceworker.md) + +## HTTPResponse.fromServiceWorker() method + +Signature: + +```typescript +fromServiceWorker(): boolean; +``` +Returns: + +boolean + diff --git a/new-docs/puppeteer.httpresponse.headers.md b/new-docs/puppeteer.httpresponse.headers.md new file mode 100644 index 00000000000..e9193258ba8 --- /dev/null +++ b/new-docs/puppeteer.httpresponse.headers.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [headers](./puppeteer.httpresponse.headers.md) + +## HTTPResponse.headers() method + +Signature: + +```typescript +headers(): Record; +``` +Returns: + +Record<string, string> + diff --git a/new-docs/puppeteer.httpresponse.json.md b/new-docs/puppeteer.httpresponse.json.md new file mode 100644 index 00000000000..141aaa462e3 --- /dev/null +++ b/new-docs/puppeteer.httpresponse.json.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [json](./puppeteer.httpresponse.json.md) + +## HTTPResponse.json() method + +Signature: + +```typescript +json(): Promise; +``` +Returns: + +Promise<any> + diff --git a/new-docs/puppeteer.httpresponse.md b/new-docs/puppeteer.httpresponse.md new file mode 100644 index 00000000000..3cf9e6d4369 --- /dev/null +++ b/new-docs/puppeteer.httpresponse.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) + +## HTTPResponse class + +Signature: + +```typescript +export declare class HTTPResponse +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(client, request, responsePayload)](./puppeteer.httpresponse._constructor_.md) | | Constructs a new instance of the HTTPResponse class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_resolveBody(err)](./puppeteer.httpresponse._resolvebody.md) | | | +| [buffer()](./puppeteer.httpresponse.buffer.md) | | | +| [frame()](./puppeteer.httpresponse.frame.md) | | | +| [fromCache()](./puppeteer.httpresponse.fromcache.md) | | | +| [fromServiceWorker()](./puppeteer.httpresponse.fromserviceworker.md) | | | +| [headers()](./puppeteer.httpresponse.headers.md) | | | +| [json()](./puppeteer.httpresponse.json.md) | | | +| [ok()](./puppeteer.httpresponse.ok.md) | | | +| [remoteAddress()](./puppeteer.httpresponse.remoteaddress.md) | | | +| [request()](./puppeteer.httpresponse.request.md) | | | +| [securityDetails()](./puppeteer.httpresponse.securitydetails.md) | | | +| [status()](./puppeteer.httpresponse.status.md) | | | +| [statusText()](./puppeteer.httpresponse.statustext.md) | | | +| [text()](./puppeteer.httpresponse.text.md) | | | +| [url()](./puppeteer.httpresponse.url.md) | | | + diff --git a/new-docs/puppeteer.httpresponse.ok.md b/new-docs/puppeteer.httpresponse.ok.md new file mode 100644 index 00000000000..b432851bcd6 --- /dev/null +++ b/new-docs/puppeteer.httpresponse.ok.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [ok](./puppeteer.httpresponse.ok.md) + +## HTTPResponse.ok() method + +Signature: + +```typescript +ok(): boolean; +``` +Returns: + +boolean + diff --git a/new-docs/puppeteer.httpresponse.remoteaddress.md b/new-docs/puppeteer.httpresponse.remoteaddress.md new file mode 100644 index 00000000000..a447a82c9c8 --- /dev/null +++ b/new-docs/puppeteer.httpresponse.remoteaddress.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [remoteAddress](./puppeteer.httpresponse.remoteaddress.md) + +## HTTPResponse.remoteAddress() method + +Signature: + +```typescript +remoteAddress(): RemoteAddress; +``` +Returns: + +RemoteAddress + diff --git a/new-docs/puppeteer.httpresponse.request.md b/new-docs/puppeteer.httpresponse.request.md new file mode 100644 index 00000000000..dff022e4dab --- /dev/null +++ b/new-docs/puppeteer.httpresponse.request.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [request](./puppeteer.httpresponse.request.md) + +## HTTPResponse.request() method + +Signature: + +```typescript +request(): HTTPRequest; +``` +Returns: + +[HTTPRequest](./puppeteer.httprequest.md) + diff --git a/new-docs/puppeteer.httpresponse.securitydetails.md b/new-docs/puppeteer.httpresponse.securitydetails.md new file mode 100644 index 00000000000..2d7f743262f --- /dev/null +++ b/new-docs/puppeteer.httpresponse.securitydetails.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [securityDetails](./puppeteer.httpresponse.securitydetails.md) + +## HTTPResponse.securityDetails() method + +Signature: + +```typescript +securityDetails(): SecurityDetails | null; +``` +Returns: + +[SecurityDetails](./puppeteer.securitydetails.md) \| null + diff --git a/new-docs/puppeteer.httpresponse.status.md b/new-docs/puppeteer.httpresponse.status.md new file mode 100644 index 00000000000..5d922cae123 --- /dev/null +++ b/new-docs/puppeteer.httpresponse.status.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [status](./puppeteer.httpresponse.status.md) + +## HTTPResponse.status() method + +Signature: + +```typescript +status(): number; +``` +Returns: + +number + diff --git a/new-docs/puppeteer.httpresponse.statustext.md b/new-docs/puppeteer.httpresponse.statustext.md new file mode 100644 index 00000000000..9b3840ca8e6 --- /dev/null +++ b/new-docs/puppeteer.httpresponse.statustext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [statusText](./puppeteer.httpresponse.statustext.md) + +## HTTPResponse.statusText() method + +Signature: + +```typescript +statusText(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.httpresponse.text.md b/new-docs/puppeteer.httpresponse.text.md new file mode 100644 index 00000000000..d1d21ef32e8 --- /dev/null +++ b/new-docs/puppeteer.httpresponse.text.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [text](./puppeteer.httpresponse.text.md) + +## HTTPResponse.text() method + +Signature: + +```typescript +text(): Promise; +``` +Returns: + +Promise<string> + diff --git a/new-docs/puppeteer.httpresponse.url.md b/new-docs/puppeteer.httpresponse.url.md new file mode 100644 index 00000000000..9101f549ff1 --- /dev/null +++ b/new-docs/puppeteer.httpresponse.url.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [HTTPResponse](./puppeteer.httpresponse.md) > [url](./puppeteer.httpresponse.url.md) + +## HTTPResponse.url() method + +Signature: + +```typescript +url(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.jshandle._client.md b/new-docs/puppeteer.jshandle._client.md new file mode 100644 index 00000000000..c3f8e5e99cd --- /dev/null +++ b/new-docs/puppeteer.jshandle._client.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [\_client](./puppeteer.jshandle._client.md) + +## JSHandle.\_client property + +Signature: + +```typescript +_client: CDPSession; +``` diff --git a/new-docs/puppeteer.jshandle._constructor_.md b/new-docs/puppeteer.jshandle._constructor_.md new file mode 100644 index 00000000000..5d8e00d0f16 --- /dev/null +++ b/new-docs/puppeteer.jshandle._constructor_.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [(constructor)](./puppeteer.jshandle._constructor_.md) + +## JSHandle.(constructor) + +Constructs a new instance of the `JSHandle` class + +Signature: + +```typescript +constructor(context: ExecutionContext, client: CDPSession, remoteObject: Protocol.Runtime.RemoteObject); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| context | [ExecutionContext](./puppeteer.executioncontext.md) | | +| client | [CDPSession](./puppeteer.cdpsession.md) | | +| remoteObject | Protocol.Runtime.RemoteObject | | + diff --git a/new-docs/puppeteer.jshandle._context.md b/new-docs/puppeteer.jshandle._context.md new file mode 100644 index 00000000000..1fa562f89dc --- /dev/null +++ b/new-docs/puppeteer.jshandle._context.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [\_context](./puppeteer.jshandle._context.md) + +## JSHandle.\_context property + +Signature: + +```typescript +_context: ExecutionContext; +``` diff --git a/new-docs/puppeteer.jshandle._disposed.md b/new-docs/puppeteer.jshandle._disposed.md new file mode 100644 index 00000000000..45c1a5d1c9f --- /dev/null +++ b/new-docs/puppeteer.jshandle._disposed.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [\_disposed](./puppeteer.jshandle._disposed.md) + +## JSHandle.\_disposed property + +Signature: + +```typescript +_disposed: boolean; +``` diff --git a/new-docs/puppeteer.jshandle._remoteobject.md b/new-docs/puppeteer.jshandle._remoteobject.md new file mode 100644 index 00000000000..1c8613531ab --- /dev/null +++ b/new-docs/puppeteer.jshandle._remoteobject.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [\_remoteObject](./puppeteer.jshandle._remoteobject.md) + +## JSHandle.\_remoteObject property + +Signature: + +```typescript +_remoteObject: Protocol.Runtime.RemoteObject; +``` diff --git a/new-docs/puppeteer.jshandle.aselement.md b/new-docs/puppeteer.jshandle.aselement.md new file mode 100644 index 00000000000..87cc90cab85 --- /dev/null +++ b/new-docs/puppeteer.jshandle.aselement.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [asElement](./puppeteer.jshandle.aselement.md) + +## JSHandle.asElement() method + +Signature: + +```typescript +asElement(): ElementHandle | null; +``` +Returns: + +[ElementHandle](./puppeteer.elementhandle.md) \| null + diff --git a/new-docs/puppeteer.jshandle.dispose.md b/new-docs/puppeteer.jshandle.dispose.md new file mode 100644 index 00000000000..8747fce6fda --- /dev/null +++ b/new-docs/puppeteer.jshandle.dispose.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [dispose](./puppeteer.jshandle.dispose.md) + +## JSHandle.dispose() method + +Signature: + +```typescript +dispose(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.jshandle.evaluate.md b/new-docs/puppeteer.jshandle.evaluate.md new file mode 100644 index 00000000000..7bbfbfcbd9c --- /dev/null +++ b/new-docs/puppeteer.jshandle.evaluate.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [evaluate](./puppeteer.jshandle.evaluate.md) + +## JSHandle.evaluate() method + +Signature: + +```typescript +evaluate(pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<ReturnType> + diff --git a/new-docs/puppeteer.jshandle.evaluatehandle.md b/new-docs/puppeteer.jshandle.evaluatehandle.md new file mode 100644 index 00000000000..e4c4273dbe6 --- /dev/null +++ b/new-docs/puppeteer.jshandle.evaluatehandle.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [evaluateHandle](./puppeteer.jshandle.evaluatehandle.md) + +## JSHandle.evaluateHandle() method + +Signature: + +```typescript +evaluateHandle(pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<[JSHandle](./puppeteer.jshandle.md)> + diff --git a/new-docs/puppeteer.jshandle.executioncontext.md b/new-docs/puppeteer.jshandle.executioncontext.md new file mode 100644 index 00000000000..ed5afb148a2 --- /dev/null +++ b/new-docs/puppeteer.jshandle.executioncontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [executionContext](./puppeteer.jshandle.executioncontext.md) + +## JSHandle.executionContext() method + +Signature: + +```typescript +executionContext(): ExecutionContext; +``` +Returns: + +[ExecutionContext](./puppeteer.executioncontext.md) + diff --git a/new-docs/puppeteer.jshandle.getproperties.md b/new-docs/puppeteer.jshandle.getproperties.md new file mode 100644 index 00000000000..2cb5e50d930 --- /dev/null +++ b/new-docs/puppeteer.jshandle.getproperties.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [getProperties](./puppeteer.jshandle.getproperties.md) + +## JSHandle.getProperties() method + +Signature: + +```typescript +getProperties(): Promise>; +``` +Returns: + +Promise<Map<string, [JSHandle](./puppeteer.jshandle.md)>> + diff --git a/new-docs/puppeteer.jshandle.getproperty.md b/new-docs/puppeteer.jshandle.getproperty.md new file mode 100644 index 00000000000..589f4fef706 --- /dev/null +++ b/new-docs/puppeteer.jshandle.getproperty.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [getProperty](./puppeteer.jshandle.getproperty.md) + +## JSHandle.getProperty() method + +Signature: + +```typescript +getProperty(propertyName: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| propertyName | string | | + +Returns: + +Promise<[JSHandle](./puppeteer.jshandle.md) \| undefined> + diff --git a/new-docs/puppeteer.jshandle.jsonvalue.md b/new-docs/puppeteer.jshandle.jsonvalue.md new file mode 100644 index 00000000000..a9f53b13969 --- /dev/null +++ b/new-docs/puppeteer.jshandle.jsonvalue.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [jsonValue](./puppeteer.jshandle.jsonvalue.md) + +## JSHandle.jsonValue() method + +Signature: + +```typescript +jsonValue(): Promise<{}>; +``` +Returns: + +Promise<{}> + diff --git a/new-docs/puppeteer.jshandle.md b/new-docs/puppeteer.jshandle.md new file mode 100644 index 00000000000..90841127ba1 --- /dev/null +++ b/new-docs/puppeteer.jshandle.md @@ -0,0 +1,41 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) + +## JSHandle class + +Signature: + +```typescript +export declare class JSHandle +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(context, client, remoteObject)](./puppeteer.jshandle._constructor_.md) | | Constructs a new instance of the JSHandle class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_client](./puppeteer.jshandle._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | | +| [\_context](./puppeteer.jshandle._context.md) | | [ExecutionContext](./puppeteer.executioncontext.md) | | +| [\_disposed](./puppeteer.jshandle._disposed.md) | | boolean | | +| [\_remoteObject](./puppeteer.jshandle._remoteobject.md) | | Protocol.Runtime.RemoteObject | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [asElement()](./puppeteer.jshandle.aselement.md) | | | +| [dispose()](./puppeteer.jshandle.dispose.md) | | | +| [evaluate(pageFunction, args)](./puppeteer.jshandle.evaluate.md) | | | +| [evaluateHandle(pageFunction, args)](./puppeteer.jshandle.evaluatehandle.md) | | | +| [executionContext()](./puppeteer.jshandle.executioncontext.md) | | | +| [getProperties()](./puppeteer.jshandle.getproperties.md) | | | +| [getProperty(propertyName)](./puppeteer.jshandle.getproperty.md) | | | +| [jsonValue()](./puppeteer.jshandle.jsonvalue.md) | | | +| [toString()](./puppeteer.jshandle.tostring.md) | | | + diff --git a/new-docs/puppeteer.jshandle.tostring.md b/new-docs/puppeteer.jshandle.tostring.md new file mode 100644 index 00000000000..e81349cd0b7 --- /dev/null +++ b/new-docs/puppeteer.jshandle.tostring.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [JSHandle](./puppeteer.jshandle.md) > [toString](./puppeteer.jshandle.tostring.md) + +## JSHandle.toString() method + +Signature: + +```typescript +toString(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.keyboard._client.md b/new-docs/puppeteer.keyboard._client.md new file mode 100644 index 00000000000..d45c2b918d7 --- /dev/null +++ b/new-docs/puppeteer.keyboard._client.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Keyboard](./puppeteer.keyboard.md) > [\_client](./puppeteer.keyboard._client.md) + +## Keyboard.\_client property + +Signature: + +```typescript +_client: CDPSession; +``` diff --git a/new-docs/puppeteer.keyboard._constructor_.md b/new-docs/puppeteer.keyboard._constructor_.md new file mode 100644 index 00000000000..e8c4f668b84 --- /dev/null +++ b/new-docs/puppeteer.keyboard._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Keyboard](./puppeteer.keyboard.md) > [(constructor)](./puppeteer.keyboard._constructor_.md) + +## Keyboard.(constructor) + +Constructs a new instance of the `Keyboard` class + +Signature: + +```typescript +constructor(client: CDPSession); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | + diff --git a/new-docs/puppeteer.keyboard._modifiers.md b/new-docs/puppeteer.keyboard._modifiers.md new file mode 100644 index 00000000000..c65e5a09a63 --- /dev/null +++ b/new-docs/puppeteer.keyboard._modifiers.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Keyboard](./puppeteer.keyboard.md) > [\_modifiers](./puppeteer.keyboard._modifiers.md) + +## Keyboard.\_modifiers property + +Signature: + +```typescript +_modifiers: number; +``` diff --git a/new-docs/puppeteer.keyboard._pressedkeys.md b/new-docs/puppeteer.keyboard._pressedkeys.md new file mode 100644 index 00000000000..81f67a3ecb2 --- /dev/null +++ b/new-docs/puppeteer.keyboard._pressedkeys.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Keyboard](./puppeteer.keyboard.md) > [\_pressedKeys](./puppeteer.keyboard._pressedkeys.md) + +## Keyboard.\_pressedKeys property + +Signature: + +```typescript +_pressedKeys: Set; +``` diff --git a/new-docs/puppeteer.keyboard.down.md b/new-docs/puppeteer.keyboard.down.md new file mode 100644 index 00000000000..12bdaaf966e --- /dev/null +++ b/new-docs/puppeteer.keyboard.down.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Keyboard](./puppeteer.keyboard.md) > [down](./puppeteer.keyboard.down.md) + +## Keyboard.down() method + +Signature: + +```typescript +down(key: KeyInput, options?: { + text?: string; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| key | KeyInput | | +| options | { text?: string; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.keyboard.md b/new-docs/puppeteer.keyboard.md new file mode 100644 index 00000000000..56bda00fc7a --- /dev/null +++ b/new-docs/puppeteer.keyboard.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Keyboard](./puppeteer.keyboard.md) + +## Keyboard class + +Signature: + +```typescript +export declare class Keyboard +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(client)](./puppeteer.keyboard._constructor_.md) | | Constructs a new instance of the Keyboard class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_client](./puppeteer.keyboard._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | | +| [\_modifiers](./puppeteer.keyboard._modifiers.md) | | number | | +| [\_pressedKeys](./puppeteer.keyboard._pressedkeys.md) | | Set<string> | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [down(key, options)](./puppeteer.keyboard.down.md) | | | +| [press(key, options)](./puppeteer.keyboard.press.md) | | | +| [sendCharacter(char)](./puppeteer.keyboard.sendcharacter.md) | | | +| [type(text, options)](./puppeteer.keyboard.type.md) | | | +| [up(key)](./puppeteer.keyboard.up.md) | | | + diff --git a/new-docs/puppeteer.keyboard.press.md b/new-docs/puppeteer.keyboard.press.md new file mode 100644 index 00000000000..7de7cd8cabe --- /dev/null +++ b/new-docs/puppeteer.keyboard.press.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Keyboard](./puppeteer.keyboard.md) > [press](./puppeteer.keyboard.press.md) + +## Keyboard.press() method + +Signature: + +```typescript +press(key: KeyInput, options?: { + delay?: number; + text?: string; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| key | KeyInput | | +| options | { delay?: number; text?: string; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.keyboard.sendcharacter.md b/new-docs/puppeteer.keyboard.sendcharacter.md new file mode 100644 index 00000000000..bf3aa5e5ce2 --- /dev/null +++ b/new-docs/puppeteer.keyboard.sendcharacter.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Keyboard](./puppeteer.keyboard.md) > [sendCharacter](./puppeteer.keyboard.sendcharacter.md) + +## Keyboard.sendCharacter() method + +Signature: + +```typescript +sendCharacter(char: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| char | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.keyboard.type.md b/new-docs/puppeteer.keyboard.type.md new file mode 100644 index 00000000000..691fcfbd152 --- /dev/null +++ b/new-docs/puppeteer.keyboard.type.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Keyboard](./puppeteer.keyboard.md) > [type](./puppeteer.keyboard.type.md) + +## Keyboard.type() method + +Signature: + +```typescript +type(text: string, options: { + delay?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | | +| options | { delay?: number; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.keyboard.up.md b/new-docs/puppeteer.keyboard.up.md new file mode 100644 index 00000000000..13c7170c3da --- /dev/null +++ b/new-docs/puppeteer.keyboard.up.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Keyboard](./puppeteer.keyboard.md) > [up](./puppeteer.keyboard.up.md) + +## Keyboard.up() method + +Signature: + +```typescript +up(key: KeyInput): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| key | KeyInput | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.md b/new-docs/puppeteer.md new file mode 100644 index 00000000000..332fb0550f7 --- /dev/null +++ b/new-docs/puppeteer.md @@ -0,0 +1,70 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) + +## puppeteer package + +## Classes + +| Class | Description | +| --- | --- | +| [Accessibility](./puppeteer.accessibility.md) | | +| [Browser](./puppeteer.browser.md) | | +| [BrowserContext](./puppeteer.browsercontext.md) | | +| [BrowserFetcher](./puppeteer.browserfetcher.md) | | +| [CDPSession](./puppeteer.cdpsession.md) | | +| [Connection](./puppeteer.connection.md) | | +| [ConsoleMessage](./puppeteer.consolemessage.md) | | +| [Coverage](./puppeteer.coverage.md) | | +| [Dialog](./puppeteer.dialog.md) | | +| [ElementHandle](./puppeteer.elementhandle.md) | | +| [ExecutionContext](./puppeteer.executioncontext.md) | | +| [FileChooser](./puppeteer.filechooser.md) | | +| [Frame](./puppeteer.frame.md) | | +| [FrameManager](./puppeteer.framemanager.md) | | +| [HTTPRequest](./puppeteer.httprequest.md) | | +| [HTTPResponse](./puppeteer.httpresponse.md) | | +| [JSHandle](./puppeteer.jshandle.md) | | +| [Keyboard](./puppeteer.keyboard.md) | | +| [Mouse](./puppeteer.mouse.md) | | +| [Page](./puppeteer.page.md) | | +| [Puppeteer](./puppeteer.puppeteer.md) | The main Puppeteer class | +| [SecurityDetails](./puppeteer.securitydetails.md) | | +| [Target](./puppeteer.target.md) | | +| [TimeoutError](./puppeteer.timeouterror.md) | | +| [Touchscreen](./puppeteer.touchscreen.md) | | +| [Tracing](./puppeteer.tracing.md) | | +| [WebWorker](./puppeteer.webworker.md) | | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [DialogType](./puppeteer.dialogtype.md) | | + +## Functions + +| Function | Description | +| --- | --- | +| [createJSHandle(context, remoteObject)](./puppeteer.createjshandle.md) | | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) | | + +## Variables + +| Variable | Description | +| --- | --- | +| [EVALUATION\_SCRIPT\_URL](./puppeteer.evaluation_script_url.md) | | +| [puppeteerErrors](./puppeteer.puppeteererrors.md) | | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [MouseButtonInput](./puppeteer.mousebuttoninput.md) | | +| [PuppeteerErrors](./puppeteer.puppeteererrors.md) | | + diff --git a/new-docs/puppeteer.mouse._button.md b/new-docs/puppeteer.mouse._button.md new file mode 100644 index 00000000000..eec43f862cc --- /dev/null +++ b/new-docs/puppeteer.mouse._button.md @@ -0,0 +1,11 @@ + + +[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 new file mode 100644 index 00000000000..7c4de7315fe --- /dev/null +++ b/new-docs/puppeteer.mouse._client.md @@ -0,0 +1,11 @@ + + +[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._constructor_.md b/new-docs/puppeteer.mouse._constructor_.md new file mode 100644 index 00000000000..a1ffc3d1ea6 --- /dev/null +++ b/new-docs/puppeteer.mouse._constructor_.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Mouse](./puppeteer.mouse.md) > [(constructor)](./puppeteer.mouse._constructor_.md) + +## Mouse.(constructor) + +Constructs a new instance of the `Mouse` class + +Signature: + +```typescript +constructor(client: CDPSession, keyboard: Keyboard); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | +| keyboard | [Keyboard](./puppeteer.keyboard.md) | | + diff --git a/new-docs/puppeteer.mouse._keyboard.md b/new-docs/puppeteer.mouse._keyboard.md new file mode 100644 index 00000000000..db7b2e2b5e7 --- /dev/null +++ b/new-docs/puppeteer.mouse._keyboard.md @@ -0,0 +1,11 @@ + + +[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 new file mode 100644 index 00000000000..cfedc193f99 --- /dev/null +++ b/new-docs/puppeteer.mouse._x.md @@ -0,0 +1,11 @@ + + +[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 new file mode 100644 index 00000000000..a6200285366 --- /dev/null +++ b/new-docs/puppeteer.mouse._y.md @@ -0,0 +1,11 @@ + + +[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 new file mode 100644 index 00000000000..bdf8d5cae23 --- /dev/null +++ b/new-docs/puppeteer.mouse.click.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Mouse](./puppeteer.mouse.md) > [click](./puppeteer.mouse.click.md) + +## Mouse.click() method + +Signature: + +```typescript +click(x: number, y: number, options?: MouseOptions & { + delay?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| x | number | | +| y | number | | +| options | MouseOptions & { delay?: number; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.mouse.down.md b/new-docs/puppeteer.mouse.down.md new file mode 100644 index 00000000000..6ca173bf904 --- /dev/null +++ b/new-docs/puppeteer.mouse.down.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Mouse](./puppeteer.mouse.md) > [down](./puppeteer.mouse.down.md) + +## Mouse.down() method + +Signature: + +```typescript +down(options?: MouseOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | MouseOptions | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.mouse.md b/new-docs/puppeteer.mouse.md new file mode 100644 index 00000000000..26f7737fd50 --- /dev/null +++ b/new-docs/puppeteer.mouse.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Mouse](./puppeteer.mouse.md) + +## Mouse class + +Signature: + +```typescript +export declare class Mouse +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(client, keyboard)](./puppeteer.mouse._constructor_.md) | | Constructs a new instance of the Mouse class | + +## 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 | +| --- | --- | --- | +| [click(x, y, options)](./puppeteer.mouse.click.md) | | | +| [down(options)](./puppeteer.mouse.down.md) | | | +| [move(x, y, options)](./puppeteer.mouse.move.md) | | | +| [up(options)](./puppeteer.mouse.up.md) | | | + diff --git a/new-docs/puppeteer.mouse.move.md b/new-docs/puppeteer.mouse.move.md new file mode 100644 index 00000000000..0a6e3929e83 --- /dev/null +++ b/new-docs/puppeteer.mouse.move.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Mouse](./puppeteer.mouse.md) > [move](./puppeteer.mouse.move.md) + +## Mouse.move() method + +Signature: + +```typescript +move(x: number, y: number, options?: { + steps?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| x | number | | +| y | number | | +| options | { steps?: number; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.mouse.up.md b/new-docs/puppeteer.mouse.up.md new file mode 100644 index 00000000000..0fb1d50b3f3 --- /dev/null +++ b/new-docs/puppeteer.mouse.up.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Mouse](./puppeteer.mouse.md) > [up](./puppeteer.mouse.up.md) + +## Mouse.up() method + +Signature: + +```typescript +up(options?: MouseOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | MouseOptions | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.mousebuttoninput.md b/new-docs/puppeteer.mousebuttoninput.md new file mode 100644 index 00000000000..af8eb1803e6 --- /dev/null +++ b/new-docs/puppeteer.mousebuttoninput.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [MouseButtonInput](./puppeteer.mousebuttoninput.md) + +## MouseButtonInput type + +Signature: + +```typescript +export declare type MouseButtonInput = Exclude; +``` diff --git a/new-docs/puppeteer.page._.md b/new-docs/puppeteer.page._.md new file mode 100644 index 00000000000..1f444aa3d4c --- /dev/null +++ b/new-docs/puppeteer.page._.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [$](./puppeteer.page._.md) + +## Page.$() method + +Signature: + +```typescript +$(selector: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md) \| null> + diff --git a/new-docs/puppeteer.page.__.md b/new-docs/puppeteer.page.__.md new file mode 100644 index 00000000000..9f702a6d553 --- /dev/null +++ b/new-docs/puppeteer.page.__.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [$$](./puppeteer.page.__.md) + +## Page.$$() method + +Signature: + +```typescript +$$(selector: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md)\[\]> + diff --git a/new-docs/puppeteer.page.__eval.md b/new-docs/puppeteer.page.__eval.md new file mode 100644 index 00000000000..4c7800a5019 --- /dev/null +++ b/new-docs/puppeteer.page.__eval.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [$$eval](./puppeteer.page.__eval.md) + +## Page.$$eval() method + +Signature: + +```typescript +$$eval(selector: string, pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<ReturnType> + diff --git a/new-docs/puppeteer.page._accessibility.md b/new-docs/puppeteer.page._accessibility.md new file mode 100644 index 00000000000..e10dfac430b --- /dev/null +++ b/new-docs/puppeteer.page._accessibility.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_accessibility](./puppeteer.page._accessibility.md) + +## Page.\_accessibility property + +Signature: + +```typescript +_accessibility: Accessibility; +``` diff --git a/new-docs/puppeteer.page._addconsolemessage.md b/new-docs/puppeteer.page._addconsolemessage.md new file mode 100644 index 00000000000..881cda41e02 --- /dev/null +++ b/new-docs/puppeteer.page._addconsolemessage.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_addConsoleMessage](./puppeteer.page._addconsolemessage.md) + +## Page.\_addConsoleMessage() method + +Signature: + +```typescript +_addConsoleMessage(type: string, args: JSHandle[], stackTrace?: Protocol.Runtime.StackTrace): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | | +| args | [JSHandle](./puppeteer.jshandle.md)\[\] | | +| stackTrace | Protocol.Runtime.StackTrace | | + +Returns: + +void + diff --git a/new-docs/puppeteer.page._buildmetricsobject.md b/new-docs/puppeteer.page._buildmetricsobject.md new file mode 100644 index 00000000000..c74ff6b5dff --- /dev/null +++ b/new-docs/puppeteer.page._buildmetricsobject.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_buildMetricsObject](./puppeteer.page._buildmetricsobject.md) + +## Page.\_buildMetricsObject() method + +Signature: + +```typescript +_buildMetricsObject(metrics?: Protocol.Performance.Metric[]): Metrics; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| metrics | Protocol.Performance.Metric\[\] | | + +Returns: + +Metrics + diff --git a/new-docs/puppeteer.page._client.md b/new-docs/puppeteer.page._client.md new file mode 100644 index 00000000000..cca78381bf4 --- /dev/null +++ b/new-docs/puppeteer.page._client.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_client](./puppeteer.page._client.md) + +## Page.\_client property + +Signature: + +```typescript +_client: CDPSession; +``` diff --git a/new-docs/puppeteer.page._closed.md b/new-docs/puppeteer.page._closed.md new file mode 100644 index 00000000000..cb69546a024 --- /dev/null +++ b/new-docs/puppeteer.page._closed.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_closed](./puppeteer.page._closed.md) + +## Page.\_closed property + +Signature: + +```typescript +_closed: boolean; +``` diff --git a/new-docs/puppeteer.page._constructor_.md b/new-docs/puppeteer.page._constructor_.md new file mode 100644 index 00000000000..4d308809bab --- /dev/null +++ b/new-docs/puppeteer.page._constructor_.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [(constructor)](./puppeteer.page._constructor_.md) + +## Page.(constructor) + +Constructs a new instance of the `Page` class + +Signature: + +```typescript +constructor(client: CDPSession, target: Target, ignoreHTTPSErrors: boolean); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | +| target | [Target](./puppeteer.target.md) | | +| ignoreHTTPSErrors | boolean | | + diff --git a/new-docs/puppeteer.page._coverage.md b/new-docs/puppeteer.page._coverage.md new file mode 100644 index 00000000000..a07752a2dae --- /dev/null +++ b/new-docs/puppeteer.page._coverage.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_coverage](./puppeteer.page._coverage.md) + +## Page.\_coverage property + +Signature: + +```typescript +_coverage: Coverage; +``` diff --git a/new-docs/puppeteer.page._disconnectpromise.md b/new-docs/puppeteer.page._disconnectpromise.md new file mode 100644 index 00000000000..9f70c94ee45 --- /dev/null +++ b/new-docs/puppeteer.page._disconnectpromise.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_disconnectPromise](./puppeteer.page._disconnectpromise.md) + +## Page.\_disconnectPromise property + +Signature: + +```typescript +_disconnectPromise?: Promise; +``` diff --git a/new-docs/puppeteer.page._emitmetrics.md b/new-docs/puppeteer.page._emitmetrics.md new file mode 100644 index 00000000000..16d4f04509f --- /dev/null +++ b/new-docs/puppeteer.page._emitmetrics.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_emitMetrics](./puppeteer.page._emitmetrics.md) + +## Page.\_emitMetrics() method + +Signature: + +```typescript +_emitMetrics(event: Protocol.Performance.metricsPayload): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | Protocol.Performance.metricsPayload | | + +Returns: + +void + diff --git a/new-docs/puppeteer.page._emulationmanager.md b/new-docs/puppeteer.page._emulationmanager.md new file mode 100644 index 00000000000..8cb81a8eb9e --- /dev/null +++ b/new-docs/puppeteer.page._emulationmanager.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_emulationManager](./puppeteer.page._emulationmanager.md) + +## Page.\_emulationManager property + +Signature: + +```typescript +_emulationManager: EmulationManager; +``` diff --git a/new-docs/puppeteer.page._eval.md b/new-docs/puppeteer.page._eval.md new file mode 100644 index 00000000000..d5b18ad8e77 --- /dev/null +++ b/new-docs/puppeteer.page._eval.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [$eval](./puppeteer.page._eval.md) + +## Page.$eval() method + +Signature: + +```typescript +$eval(selector: string, pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<ReturnType> + diff --git a/new-docs/puppeteer.page._filechooserinterceptors.md b/new-docs/puppeteer.page._filechooserinterceptors.md new file mode 100644 index 00000000000..64cf4cbfe26 --- /dev/null +++ b/new-docs/puppeteer.page._filechooserinterceptors.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_fileChooserInterceptors](./puppeteer.page._filechooserinterceptors.md) + +## Page.\_fileChooserInterceptors property + +Signature: + +```typescript +_fileChooserInterceptors: Set; +``` diff --git a/new-docs/puppeteer.page._framemanager.md b/new-docs/puppeteer.page._framemanager.md new file mode 100644 index 00000000000..774eaee6a23 --- /dev/null +++ b/new-docs/puppeteer.page._framemanager.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_frameManager](./puppeteer.page._framemanager.md) + +## Page.\_frameManager property + +Signature: + +```typescript +_frameManager: FrameManager; +``` diff --git a/new-docs/puppeteer.page._go.md b/new-docs/puppeteer.page._go.md new file mode 100644 index 00000000000..0bfc68debaa --- /dev/null +++ b/new-docs/puppeteer.page._go.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_go](./puppeteer.page._go.md) + +## Page.\_go() method + +Signature: + +```typescript +_go(delta: number, options: WaitForOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| delta | number | | +| options | WaitForOptions | | + +Returns: + +Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null> + diff --git a/new-docs/puppeteer.page._handleexception.md b/new-docs/puppeteer.page._handleexception.md new file mode 100644 index 00000000000..b64eac16c5f --- /dev/null +++ b/new-docs/puppeteer.page._handleexception.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_handleException](./puppeteer.page._handleexception.md) + +## Page.\_handleException() method + +Signature: + +```typescript +_handleException(exceptionDetails: Protocol.Runtime.ExceptionDetails): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| exceptionDetails | Protocol.Runtime.ExceptionDetails | | + +Returns: + +void + diff --git a/new-docs/puppeteer.page._initialize.md b/new-docs/puppeteer.page._initialize.md new file mode 100644 index 00000000000..a3c2b4559c0 --- /dev/null +++ b/new-docs/puppeteer.page._initialize.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_initialize](./puppeteer.page._initialize.md) + +## Page.\_initialize() method + +Signature: + +```typescript +_initialize(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page._javascriptenabled.md b/new-docs/puppeteer.page._javascriptenabled.md new file mode 100644 index 00000000000..d33dab13c41 --- /dev/null +++ b/new-docs/puppeteer.page._javascriptenabled.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_javascriptEnabled](./puppeteer.page._javascriptenabled.md) + +## Page.\_javascriptEnabled property + +Signature: + +```typescript +_javascriptEnabled: boolean; +``` diff --git a/new-docs/puppeteer.page._keyboard.md b/new-docs/puppeteer.page._keyboard.md new file mode 100644 index 00000000000..145204f0099 --- /dev/null +++ b/new-docs/puppeteer.page._keyboard.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_keyboard](./puppeteer.page._keyboard.md) + +## Page.\_keyboard property + +Signature: + +```typescript +_keyboard: Keyboard; +``` diff --git a/new-docs/puppeteer.page._mouse.md b/new-docs/puppeteer.page._mouse.md new file mode 100644 index 00000000000..e6c6621f7d1 --- /dev/null +++ b/new-docs/puppeteer.page._mouse.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_mouse](./puppeteer.page._mouse.md) + +## Page.\_mouse property + +Signature: + +```typescript +_mouse: Mouse; +``` diff --git a/new-docs/puppeteer.page._onbindingcalled.md b/new-docs/puppeteer.page._onbindingcalled.md new file mode 100644 index 00000000000..be261b99843 --- /dev/null +++ b/new-docs/puppeteer.page._onbindingcalled.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_onBindingCalled](./puppeteer.page._onbindingcalled.md) + +## Page.\_onBindingCalled() method + +Signature: + +```typescript +_onBindingCalled(event: Protocol.Runtime.bindingCalledPayload): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | Protocol.Runtime.bindingCalledPayload | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page._onconsoleapi.md b/new-docs/puppeteer.page._onconsoleapi.md new file mode 100644 index 00000000000..a5e608be188 --- /dev/null +++ b/new-docs/puppeteer.page._onconsoleapi.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_onConsoleAPI](./puppeteer.page._onconsoleapi.md) + +## Page.\_onConsoleAPI() method + +Signature: + +```typescript +_onConsoleAPI(event: Protocol.Runtime.consoleAPICalledPayload): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | Protocol.Runtime.consoleAPICalledPayload | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page._ondialog.md b/new-docs/puppeteer.page._ondialog.md new file mode 100644 index 00000000000..a5586fea0d0 --- /dev/null +++ b/new-docs/puppeteer.page._ondialog.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_onDialog](./puppeteer.page._ondialog.md) + +## Page.\_onDialog() method + +Signature: + +```typescript +_onDialog(event: Protocol.Page.javascriptDialogOpeningPayload): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | Protocol.Page.javascriptDialogOpeningPayload | | + +Returns: + +void + diff --git a/new-docs/puppeteer.page._onfilechooser.md b/new-docs/puppeteer.page._onfilechooser.md new file mode 100644 index 00000000000..98bef7e6dcf --- /dev/null +++ b/new-docs/puppeteer.page._onfilechooser.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_onFileChooser](./puppeteer.page._onfilechooser.md) + +## Page.\_onFileChooser() method + +Signature: + +```typescript +_onFileChooser(event: Protocol.Page.fileChooserOpenedPayload): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | Protocol.Page.fileChooserOpenedPayload | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page._onlogentryadded.md b/new-docs/puppeteer.page._onlogentryadded.md new file mode 100644 index 00000000000..de2632bc999 --- /dev/null +++ b/new-docs/puppeteer.page._onlogentryadded.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_onLogEntryAdded](./puppeteer.page._onlogentryadded.md) + +## Page.\_onLogEntryAdded() method + +Signature: + +```typescript +_onLogEntryAdded(event: Protocol.Log.entryAddedPayload): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | Protocol.Log.entryAddedPayload | | + +Returns: + +void + diff --git a/new-docs/puppeteer.page._ontargetcrashed.md b/new-docs/puppeteer.page._ontargetcrashed.md new file mode 100644 index 00000000000..43acba4d825 --- /dev/null +++ b/new-docs/puppeteer.page._ontargetcrashed.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_onTargetCrashed](./puppeteer.page._ontargetcrashed.md) + +## Page.\_onTargetCrashed() method + +Signature: + +```typescript +_onTargetCrashed(): void; +``` +Returns: + +void + diff --git a/new-docs/puppeteer.page._pagebindings.md b/new-docs/puppeteer.page._pagebindings.md new file mode 100644 index 00000000000..e86af9a813e --- /dev/null +++ b/new-docs/puppeteer.page._pagebindings.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_pageBindings](./puppeteer.page._pagebindings.md) + +## Page.\_pageBindings property + +Signature: + +```typescript +_pageBindings: Map; +``` diff --git a/new-docs/puppeteer.page._screenshottask.md b/new-docs/puppeteer.page._screenshottask.md new file mode 100644 index 00000000000..b8739923ed2 --- /dev/null +++ b/new-docs/puppeteer.page._screenshottask.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_screenshotTask](./puppeteer.page._screenshottask.md) + +## Page.\_screenshotTask() method + +Signature: + +```typescript +_screenshotTask(format: 'png' | 'jpeg', options?: ScreenshotOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| format | 'png' \| 'jpeg' | | +| options | ScreenshotOptions | | + +Returns: + +Promise<Buffer \| string> + diff --git a/new-docs/puppeteer.page._screenshottaskqueue.md b/new-docs/puppeteer.page._screenshottaskqueue.md new file mode 100644 index 00000000000..f90cf45f20f --- /dev/null +++ b/new-docs/puppeteer.page._screenshottaskqueue.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_screenshotTaskQueue](./puppeteer.page._screenshottaskqueue.md) + +## Page.\_screenshotTaskQueue property + +Signature: + +```typescript +_screenshotTaskQueue: ScreenshotTaskQueue; +``` diff --git a/new-docs/puppeteer.page._sessionclosepromise.md b/new-docs/puppeteer.page._sessionclosepromise.md new file mode 100644 index 00000000000..ae962beb9cb --- /dev/null +++ b/new-docs/puppeteer.page._sessionclosepromise.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_sessionClosePromise](./puppeteer.page._sessionclosepromise.md) + +## Page.\_sessionClosePromise() method + +Signature: + +```typescript +_sessionClosePromise(): Promise; +``` +Returns: + +Promise<Error> + diff --git a/new-docs/puppeteer.page._target.md b/new-docs/puppeteer.page._target.md new file mode 100644 index 00000000000..f1afe833dda --- /dev/null +++ b/new-docs/puppeteer.page._target.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_target](./puppeteer.page._target.md) + +## Page.\_target property + +Signature: + +```typescript +_target: Target; +``` diff --git a/new-docs/puppeteer.page._timeoutsettings.md b/new-docs/puppeteer.page._timeoutsettings.md new file mode 100644 index 00000000000..5d2a310363e --- /dev/null +++ b/new-docs/puppeteer.page._timeoutsettings.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_timeoutSettings](./puppeteer.page._timeoutsettings.md) + +## Page.\_timeoutSettings property + +Signature: + +```typescript +_timeoutSettings: TimeoutSettings; +``` diff --git a/new-docs/puppeteer.page._touchscreen.md b/new-docs/puppeteer.page._touchscreen.md new file mode 100644 index 00000000000..438c92b85fd --- /dev/null +++ b/new-docs/puppeteer.page._touchscreen.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_touchscreen](./puppeteer.page._touchscreen.md) + +## Page.\_touchscreen property + +Signature: + +```typescript +_touchscreen: Touchscreen; +``` diff --git a/new-docs/puppeteer.page._tracing.md b/new-docs/puppeteer.page._tracing.md new file mode 100644 index 00000000000..84f21c3d7a1 --- /dev/null +++ b/new-docs/puppeteer.page._tracing.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_tracing](./puppeteer.page._tracing.md) + +## Page.\_tracing property + +Signature: + +```typescript +_tracing: Tracing; +``` diff --git a/new-docs/puppeteer.page._viewport.md b/new-docs/puppeteer.page._viewport.md new file mode 100644 index 00000000000..09eed122b23 --- /dev/null +++ b/new-docs/puppeteer.page._viewport.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_viewport](./puppeteer.page._viewport.md) + +## Page.\_viewport property + +Signature: + +```typescript +_viewport: Viewport | null; +``` diff --git a/new-docs/puppeteer.page._workers.md b/new-docs/puppeteer.page._workers.md new file mode 100644 index 00000000000..ef919d619dd --- /dev/null +++ b/new-docs/puppeteer.page._workers.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [\_workers](./puppeteer.page._workers.md) + +## Page.\_workers property + +Signature: + +```typescript +_workers: Map; +``` diff --git a/new-docs/puppeteer.page._x.md b/new-docs/puppeteer.page._x.md new file mode 100644 index 00000000000..39f76950c08 --- /dev/null +++ b/new-docs/puppeteer.page._x.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [$x](./puppeteer.page._x.md) + +## Page.$x() method + +Signature: + +```typescript +$x(expression: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| expression | string | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md)\[\]> + diff --git a/new-docs/puppeteer.page.accessibility.md b/new-docs/puppeteer.page.accessibility.md new file mode 100644 index 00000000000..c245042dc13 --- /dev/null +++ b/new-docs/puppeteer.page.accessibility.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [accessibility](./puppeteer.page.accessibility.md) + +## Page.accessibility property + +Signature: + +```typescript +get accessibility(): Accessibility; +``` diff --git a/new-docs/puppeteer.page.addscripttag.md b/new-docs/puppeteer.page.addscripttag.md new file mode 100644 index 00000000000..3066fce9f1e --- /dev/null +++ b/new-docs/puppeteer.page.addscripttag.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [addScriptTag](./puppeteer.page.addscripttag.md) + +## Page.addScriptTag() method + +Signature: + +```typescript +addScriptTag(options: { + url?: string; + path?: string; + content?: string; + type?: string; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | { url?: string; path?: string; content?: string; type?: string; } | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md)> + diff --git a/new-docs/puppeteer.page.addstyletag.md b/new-docs/puppeteer.page.addstyletag.md new file mode 100644 index 00000000000..4b013cf5574 --- /dev/null +++ b/new-docs/puppeteer.page.addstyletag.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [addStyleTag](./puppeteer.page.addstyletag.md) + +## Page.addStyleTag() method + +Signature: + +```typescript +addStyleTag(options: { + url?: string; + path?: string; + content?: string; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | { url?: string; path?: string; content?: string; } | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md)> + diff --git a/new-docs/puppeteer.page.authenticate.md b/new-docs/puppeteer.page.authenticate.md new file mode 100644 index 00000000000..02544b4ca2d --- /dev/null +++ b/new-docs/puppeteer.page.authenticate.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [authenticate](./puppeteer.page.authenticate.md) + +## Page.authenticate() method + +Signature: + +```typescript +authenticate(credentials: Credentials): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| credentials | Credentials | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.bringtofront.md b/new-docs/puppeteer.page.bringtofront.md new file mode 100644 index 00000000000..ee57eec52f4 --- /dev/null +++ b/new-docs/puppeteer.page.bringtofront.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [bringToFront](./puppeteer.page.bringtofront.md) + +## Page.bringToFront() method + +Signature: + +```typescript +bringToFront(): Promise; +``` +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.browser.md b/new-docs/puppeteer.page.browser.md new file mode 100644 index 00000000000..9d6ba8690e0 --- /dev/null +++ b/new-docs/puppeteer.page.browser.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [browser](./puppeteer.page.browser.md) + +## Page.browser() method + +Signature: + +```typescript +browser(): Browser; +``` +Returns: + +[Browser](./puppeteer.browser.md) + diff --git a/new-docs/puppeteer.page.browsercontext.md b/new-docs/puppeteer.page.browsercontext.md new file mode 100644 index 00000000000..5988e324b03 --- /dev/null +++ b/new-docs/puppeteer.page.browsercontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [browserContext](./puppeteer.page.browsercontext.md) + +## Page.browserContext() method + +Signature: + +```typescript +browserContext(): BrowserContext; +``` +Returns: + +[BrowserContext](./puppeteer.browsercontext.md) + diff --git a/new-docs/puppeteer.page.click.md b/new-docs/puppeteer.page.click.md new file mode 100644 index 00000000000..62317e8f842 --- /dev/null +++ b/new-docs/puppeteer.page.click.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [click](./puppeteer.page.click.md) + +## Page.click() method + +Signature: + +```typescript +click(selector: string, options?: { + delay?: number; + button?: MouseButtonInput; + clickCount?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| options | { delay?: number; button?: [MouseButtonInput](./puppeteer.mousebuttoninput.md); clickCount?: number; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.close.md b/new-docs/puppeteer.page.close.md new file mode 100644 index 00000000000..25f7f304f7d --- /dev/null +++ b/new-docs/puppeteer.page.close.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [close](./puppeteer.page.close.md) + +## Page.close() method + +Signature: + +```typescript +close(options?: { + runBeforeUnload?: boolean; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | { runBeforeUnload?: boolean; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.content.md b/new-docs/puppeteer.page.content.md new file mode 100644 index 00000000000..d93490dcd3f --- /dev/null +++ b/new-docs/puppeteer.page.content.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [content](./puppeteer.page.content.md) + +## Page.content() method + +Signature: + +```typescript +content(): Promise; +``` +Returns: + +Promise<string> + diff --git a/new-docs/puppeteer.page.cookies.md b/new-docs/puppeteer.page.cookies.md new file mode 100644 index 00000000000..1696e24c4a4 --- /dev/null +++ b/new-docs/puppeteer.page.cookies.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [cookies](./puppeteer.page.cookies.md) + +## Page.cookies() method + +Signature: + +```typescript +cookies(...urls: string[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| urls | string\[\] | | + +Returns: + +Promise<Protocol.Network.Cookie\[\]> + diff --git a/new-docs/puppeteer.page.coverage.md b/new-docs/puppeteer.page.coverage.md new file mode 100644 index 00000000000..f8ce50d1865 --- /dev/null +++ b/new-docs/puppeteer.page.coverage.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [coverage](./puppeteer.page.coverage.md) + +## Page.coverage property + +Signature: + +```typescript +get coverage(): Coverage; +``` diff --git a/new-docs/puppeteer.page.create.md b/new-docs/puppeteer.page.create.md new file mode 100644 index 00000000000..bd3ae59f369 --- /dev/null +++ b/new-docs/puppeteer.page.create.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [create](./puppeteer.page.create.md) + +## Page.create() method + +Signature: + +```typescript +static create(client: CDPSession, target: Target, ignoreHTTPSErrors: boolean, defaultViewport: Viewport | null): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | +| target | [Target](./puppeteer.target.md) | | +| ignoreHTTPSErrors | boolean | | +| defaultViewport | Viewport \| null | | + +Returns: + +Promise<[Page](./puppeteer.page.md)> + diff --git a/new-docs/puppeteer.page.deletecookie.md b/new-docs/puppeteer.page.deletecookie.md new file mode 100644 index 00000000000..58522b41a81 --- /dev/null +++ b/new-docs/puppeteer.page.deletecookie.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [deleteCookie](./puppeteer.page.deletecookie.md) + +## Page.deleteCookie() method + +Signature: + +```typescript +deleteCookie(...cookies: Protocol.Network.deleteCookiesParameters[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| cookies | Protocol.Network.deleteCookiesParameters\[\] | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.emulate.md b/new-docs/puppeteer.page.emulate.md new file mode 100644 index 00000000000..d57708f8b55 --- /dev/null +++ b/new-docs/puppeteer.page.emulate.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [emulate](./puppeteer.page.emulate.md) + +## Page.emulate() method + +Signature: + +```typescript +emulate(options: { + viewport: Viewport; + userAgent: string; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | { viewport: Viewport; userAgent: string; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.emulatemediafeatures.md b/new-docs/puppeteer.page.emulatemediafeatures.md new file mode 100644 index 00000000000..51a092060a8 --- /dev/null +++ b/new-docs/puppeteer.page.emulatemediafeatures.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [emulateMediaFeatures](./puppeteer.page.emulatemediafeatures.md) + +## Page.emulateMediaFeatures() method + +Signature: + +```typescript +emulateMediaFeatures(features?: MediaFeature[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| features | MediaFeature\[\] | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.emulatemediatype.md b/new-docs/puppeteer.page.emulatemediatype.md new file mode 100644 index 00000000000..2ebe37f2d62 --- /dev/null +++ b/new-docs/puppeteer.page.emulatemediatype.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [emulateMediaType](./puppeteer.page.emulatemediatype.md) + +## Page.emulateMediaType() method + +Signature: + +```typescript +emulateMediaType(type?: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.emulatetimezone.md b/new-docs/puppeteer.page.emulatetimezone.md new file mode 100644 index 00000000000..0cf209d7929 --- /dev/null +++ b/new-docs/puppeteer.page.emulatetimezone.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [emulateTimezone](./puppeteer.page.emulatetimezone.md) + +## Page.emulateTimezone() method + +Signature: + +```typescript +emulateTimezone(timezoneId?: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| timezoneId | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.emulatevisiondeficiency.md b/new-docs/puppeteer.page.emulatevisiondeficiency.md new file mode 100644 index 00000000000..2230df80256 --- /dev/null +++ b/new-docs/puppeteer.page.emulatevisiondeficiency.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [emulateVisionDeficiency](./puppeteer.page.emulatevisiondeficiency.md) + +## Page.emulateVisionDeficiency() method + +Signature: + +```typescript +emulateVisionDeficiency(type?: VisionDeficiency): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | VisionDeficiency | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.evaluate.md b/new-docs/puppeteer.page.evaluate.md new file mode 100644 index 00000000000..683275517a1 --- /dev/null +++ b/new-docs/puppeteer.page.evaluate.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [evaluate](./puppeteer.page.evaluate.md) + +## Page.evaluate() method + +Signature: + +```typescript +evaluate(pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<ReturnType> + diff --git a/new-docs/puppeteer.page.evaluatehandle.md b/new-docs/puppeteer.page.evaluatehandle.md new file mode 100644 index 00000000000..6d1142de336 --- /dev/null +++ b/new-docs/puppeteer.page.evaluatehandle.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [evaluateHandle](./puppeteer.page.evaluatehandle.md) + +## Page.evaluateHandle() method + +Signature: + +```typescript +evaluateHandle(pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<[JSHandle](./puppeteer.jshandle.md)> + diff --git a/new-docs/puppeteer.page.evaluateonnewdocument.md b/new-docs/puppeteer.page.evaluateonnewdocument.md new file mode 100644 index 00000000000..ba3888b07e7 --- /dev/null +++ b/new-docs/puppeteer.page.evaluateonnewdocument.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [evaluateOnNewDocument](./puppeteer.page.evaluateonnewdocument.md) + +## Page.evaluateOnNewDocument() method + +Signature: + +```typescript +evaluateOnNewDocument(pageFunction: Function | string, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pageFunction | Function \| string | | +| args | unknown\[\] | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.exposefunction.md b/new-docs/puppeteer.page.exposefunction.md new file mode 100644 index 00000000000..f91f42bd74e --- /dev/null +++ b/new-docs/puppeteer.page.exposefunction.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [exposeFunction](./puppeteer.page.exposefunction.md) + +## Page.exposeFunction() method + +Signature: + +```typescript +exposeFunction(name: string, puppeteerFunction: Function): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| puppeteerFunction | Function | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.focus.md b/new-docs/puppeteer.page.focus.md new file mode 100644 index 00000000000..b7367534cb8 --- /dev/null +++ b/new-docs/puppeteer.page.focus.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [focus](./puppeteer.page.focus.md) + +## Page.focus() method + +Signature: + +```typescript +focus(selector: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.frames.md b/new-docs/puppeteer.page.frames.md new file mode 100644 index 00000000000..e1841d642d9 --- /dev/null +++ b/new-docs/puppeteer.page.frames.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [frames](./puppeteer.page.frames.md) + +## Page.frames() method + +Signature: + +```typescript +frames(): Frame[]; +``` +Returns: + +[Frame](./puppeteer.frame.md)\[\] + diff --git a/new-docs/puppeteer.page.goback.md b/new-docs/puppeteer.page.goback.md new file mode 100644 index 00000000000..8c6136ee025 --- /dev/null +++ b/new-docs/puppeteer.page.goback.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [goBack](./puppeteer.page.goback.md) + +## Page.goBack() method + +Signature: + +```typescript +goBack(options: WaitForOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | WaitForOptions | | + +Returns: + +Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null> + diff --git a/new-docs/puppeteer.page.goforward.md b/new-docs/puppeteer.page.goforward.md new file mode 100644 index 00000000000..d6d17ece5c6 --- /dev/null +++ b/new-docs/puppeteer.page.goforward.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [goForward](./puppeteer.page.goforward.md) + +## Page.goForward() method + +Signature: + +```typescript +goForward(options: WaitForOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | WaitForOptions | | + +Returns: + +Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null> + diff --git a/new-docs/puppeteer.page.goto.md b/new-docs/puppeteer.page.goto.md new file mode 100644 index 00000000000..3463d9b8377 --- /dev/null +++ b/new-docs/puppeteer.page.goto.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [goto](./puppeteer.page.goto.md) + +## Page.goto() method + +Signature: + +```typescript +goto(url: string, options: WaitForOptions & { + referer?: string; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| url | string | | +| options | WaitForOptions & { referer?: string; } | | + +Returns: + +Promise<[HTTPResponse](./puppeteer.httpresponse.md)> + diff --git a/new-docs/puppeteer.page.hover.md b/new-docs/puppeteer.page.hover.md new file mode 100644 index 00000000000..7a6208142dd --- /dev/null +++ b/new-docs/puppeteer.page.hover.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [hover](./puppeteer.page.hover.md) + +## Page.hover() method + +Signature: + +```typescript +hover(selector: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.isclosed.md b/new-docs/puppeteer.page.isclosed.md new file mode 100644 index 00000000000..4fb87cc0378 --- /dev/null +++ b/new-docs/puppeteer.page.isclosed.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [isClosed](./puppeteer.page.isclosed.md) + +## Page.isClosed() method + +Signature: + +```typescript +isClosed(): boolean; +``` +Returns: + +boolean + diff --git a/new-docs/puppeteer.page.keyboard.md b/new-docs/puppeteer.page.keyboard.md new file mode 100644 index 00000000000..d8b7f4ecab7 --- /dev/null +++ b/new-docs/puppeteer.page.keyboard.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [keyboard](./puppeteer.page.keyboard.md) + +## Page.keyboard property + +Signature: + +```typescript +get keyboard(): Keyboard; +``` diff --git a/new-docs/puppeteer.page.mainframe.md b/new-docs/puppeteer.page.mainframe.md new file mode 100644 index 00000000000..e452cf72999 --- /dev/null +++ b/new-docs/puppeteer.page.mainframe.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [mainFrame](./puppeteer.page.mainframe.md) + +## Page.mainFrame() method + +Signature: + +```typescript +mainFrame(): Frame; +``` +Returns: + +[Frame](./puppeteer.frame.md) + diff --git a/new-docs/puppeteer.page.md b/new-docs/puppeteer.page.md new file mode 100644 index 00000000000..759c3c60b78 --- /dev/null +++ b/new-docs/puppeteer.page.md @@ -0,0 +1,135 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) + +## Page class + +Signature: + +```typescript +export declare class Page extends EventEmitter +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(client, target, ignoreHTTPSErrors)](./puppeteer.page._constructor_.md) | | Constructs a new instance of the Page class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_accessibility](./puppeteer.page._accessibility.md) | | [Accessibility](./puppeteer.accessibility.md) | | +| [\_client](./puppeteer.page._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | | +| [\_closed](./puppeteer.page._closed.md) | | boolean | | +| [\_coverage](./puppeteer.page._coverage.md) | | [Coverage](./puppeteer.coverage.md) | | +| [\_disconnectPromise](./puppeteer.page._disconnectpromise.md) | | Promise<Error> | | +| [\_emulationManager](./puppeteer.page._emulationmanager.md) | | EmulationManager | | +| [\_fileChooserInterceptors](./puppeteer.page._filechooserinterceptors.md) | | Set<Function> | | +| [\_frameManager](./puppeteer.page._framemanager.md) | | [FrameManager](./puppeteer.framemanager.md) | | +| [\_javascriptEnabled](./puppeteer.page._javascriptenabled.md) | | boolean | | +| [\_keyboard](./puppeteer.page._keyboard.md) | | [Keyboard](./puppeteer.keyboard.md) | | +| [\_mouse](./puppeteer.page._mouse.md) | | [Mouse](./puppeteer.mouse.md) | | +| [\_pageBindings](./puppeteer.page._pagebindings.md) | | Map<string, Function> | | +| [\_screenshotTaskQueue](./puppeteer.page._screenshottaskqueue.md) | | ScreenshotTaskQueue | | +| [\_target](./puppeteer.page._target.md) | | [Target](./puppeteer.target.md) | | +| [\_timeoutSettings](./puppeteer.page._timeoutsettings.md) | | TimeoutSettings | | +| [\_touchscreen](./puppeteer.page._touchscreen.md) | | [Touchscreen](./puppeteer.touchscreen.md) | | +| [\_tracing](./puppeteer.page._tracing.md) | | [Tracing](./puppeteer.tracing.md) | | +| [\_viewport](./puppeteer.page._viewport.md) | | Viewport \| null | | +| [\_workers](./puppeteer.page._workers.md) | | Map<string, [WebWorker](./puppeteer.webworker.md)> | | +| [accessibility](./puppeteer.page.accessibility.md) | | [Accessibility](./puppeteer.accessibility.md) | | +| [coverage](./puppeteer.page.coverage.md) | | [Coverage](./puppeteer.coverage.md) | | +| [keyboard](./puppeteer.page.keyboard.md) | | [Keyboard](./puppeteer.keyboard.md) | | +| [mouse](./puppeteer.page.mouse.md) | | [Mouse](./puppeteer.mouse.md) | | +| [touchscreen](./puppeteer.page.touchscreen.md) | | [Touchscreen](./puppeteer.touchscreen.md) | | +| [tracing](./puppeteer.page.tracing.md) | | [Tracing](./puppeteer.tracing.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_addConsoleMessage(type, args, stackTrace)](./puppeteer.page._addconsolemessage.md) | | | +| [\_buildMetricsObject(metrics)](./puppeteer.page._buildmetricsobject.md) | | | +| [\_emitMetrics(event)](./puppeteer.page._emitmetrics.md) | | | +| [\_go(delta, options)](./puppeteer.page._go.md) | | | +| [\_handleException(exceptionDetails)](./puppeteer.page._handleexception.md) | | | +| [\_initialize()](./puppeteer.page._initialize.md) | | | +| [\_onBindingCalled(event)](./puppeteer.page._onbindingcalled.md) | | | +| [\_onConsoleAPI(event)](./puppeteer.page._onconsoleapi.md) | | | +| [\_onDialog(event)](./puppeteer.page._ondialog.md) | | | +| [\_onFileChooser(event)](./puppeteer.page._onfilechooser.md) | | | +| [\_onLogEntryAdded(event)](./puppeteer.page._onlogentryadded.md) | | | +| [\_onTargetCrashed()](./puppeteer.page._ontargetcrashed.md) | | | +| [\_screenshotTask(format, options)](./puppeteer.page._screenshottask.md) | | | +| [\_sessionClosePromise()](./puppeteer.page._sessionclosepromise.md) | | | +| [$(selector)](./puppeteer.page._.md) | | | +| [$$(selector)](./puppeteer.page.__.md) | | | +| [$$eval(selector, pageFunction, args)](./puppeteer.page.__eval.md) | | | +| [$eval(selector, pageFunction, args)](./puppeteer.page._eval.md) | | | +| [$x(expression)](./puppeteer.page._x.md) | | | +| [addScriptTag(options)](./puppeteer.page.addscripttag.md) | | | +| [addStyleTag(options)](./puppeteer.page.addstyletag.md) | | | +| [authenticate(credentials)](./puppeteer.page.authenticate.md) | | | +| [bringToFront()](./puppeteer.page.bringtofront.md) | | | +| [browser()](./puppeteer.page.browser.md) | | | +| [browserContext()](./puppeteer.page.browsercontext.md) | | | +| [click(selector, options)](./puppeteer.page.click.md) | | | +| [close(options)](./puppeteer.page.close.md) | | | +| [content()](./puppeteer.page.content.md) | | | +| [cookies(urls)](./puppeteer.page.cookies.md) | | | +| [create(client, target, ignoreHTTPSErrors, defaultViewport)](./puppeteer.page.create.md) | static | | +| [deleteCookie(cookies)](./puppeteer.page.deletecookie.md) | | | +| [emulate(options)](./puppeteer.page.emulate.md) | | | +| [emulateMediaFeatures(features)](./puppeteer.page.emulatemediafeatures.md) | | | +| [emulateMediaType(type)](./puppeteer.page.emulatemediatype.md) | | | +| [emulateTimezone(timezoneId)](./puppeteer.page.emulatetimezone.md) | | | +| [emulateVisionDeficiency(type)](./puppeteer.page.emulatevisiondeficiency.md) | | | +| [evaluate(pageFunction, args)](./puppeteer.page.evaluate.md) | | | +| [evaluateHandle(pageFunction, args)](./puppeteer.page.evaluatehandle.md) | | | +| [evaluateOnNewDocument(pageFunction, args)](./puppeteer.page.evaluateonnewdocument.md) | | | +| [exposeFunction(name, puppeteerFunction)](./puppeteer.page.exposefunction.md) | | | +| [focus(selector)](./puppeteer.page.focus.md) | | | +| [frames()](./puppeteer.page.frames.md) | | | +| [goBack(options)](./puppeteer.page.goback.md) | | | +| [goForward(options)](./puppeteer.page.goforward.md) | | | +| [goto(url, options)](./puppeteer.page.goto.md) | | | +| [hover(selector)](./puppeteer.page.hover.md) | | | +| [isClosed()](./puppeteer.page.isclosed.md) | | | +| [mainFrame()](./puppeteer.page.mainframe.md) | | | +| [metrics()](./puppeteer.page.metrics.md) | | | +| [pdf(options)](./puppeteer.page.pdf.md) | | | +| [queryObjects(prototypeHandle)](./puppeteer.page.queryobjects.md) | | | +| [reload(options)](./puppeteer.page.reload.md) | | | +| [screenshot(options)](./puppeteer.page.screenshot.md) | | | +| [select(selector, values)](./puppeteer.page.select.md) | | | +| [setBypassCSP(enabled)](./puppeteer.page.setbypasscsp.md) | | | +| [setCacheEnabled(enabled)](./puppeteer.page.setcacheenabled.md) | | | +| [setContent(html, options)](./puppeteer.page.setcontent.md) | | | +| [setCookie(cookies)](./puppeteer.page.setcookie.md) | | | +| [setDefaultNavigationTimeout(timeout)](./puppeteer.page.setdefaultnavigationtimeout.md) | | | +| [setDefaultTimeout(timeout)](./puppeteer.page.setdefaulttimeout.md) | | | +| [setExtraHTTPHeaders(headers)](./puppeteer.page.setextrahttpheaders.md) | | | +| [setGeolocation(options)](./puppeteer.page.setgeolocation.md) | | | +| [setJavaScriptEnabled(enabled)](./puppeteer.page.setjavascriptenabled.md) | | | +| [setOfflineMode(enabled)](./puppeteer.page.setofflinemode.md) | | | +| [setRequestInterception(value)](./puppeteer.page.setrequestinterception.md) | | | +| [setUserAgent(userAgent)](./puppeteer.page.setuseragent.md) | | | +| [setViewport(viewport)](./puppeteer.page.setviewport.md) | | | +| [tap(selector)](./puppeteer.page.tap.md) | | | +| [target()](./puppeteer.page.target.md) | | | +| [title()](./puppeteer.page.title.md) | | | +| [type(selector, text, options)](./puppeteer.page.type.md) | | | +| [url()](./puppeteer.page.url.md) | | | +| [viewport()](./puppeteer.page.viewport.md) | | | +| [waitFor(selectorOrFunctionOrTimeout, options, args)](./puppeteer.page.waitfor.md) | | | +| [waitForFileChooser(options)](./puppeteer.page.waitforfilechooser.md) | | | +| [waitForFunction(pageFunction, options, args)](./puppeteer.page.waitforfunction.md) | | | +| [waitForNavigation(options)](./puppeteer.page.waitfornavigation.md) | | | +| [waitForRequest(urlOrPredicate, options)](./puppeteer.page.waitforrequest.md) | | | +| [waitForResponse(urlOrPredicate, options)](./puppeteer.page.waitforresponse.md) | | | +| [waitForSelector(selector, options)](./puppeteer.page.waitforselector.md) | | | +| [waitForXPath(xpath, options)](./puppeteer.page.waitforxpath.md) | | | +| [workers()](./puppeteer.page.workers.md) | | | + diff --git a/new-docs/puppeteer.page.metrics.md b/new-docs/puppeteer.page.metrics.md new file mode 100644 index 00000000000..f2e7ce25b94 --- /dev/null +++ b/new-docs/puppeteer.page.metrics.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [metrics](./puppeteer.page.metrics.md) + +## Page.metrics() method + +Signature: + +```typescript +metrics(): Promise; +``` +Returns: + +Promise<Metrics> + diff --git a/new-docs/puppeteer.page.mouse.md b/new-docs/puppeteer.page.mouse.md new file mode 100644 index 00000000000..72e08848c48 --- /dev/null +++ b/new-docs/puppeteer.page.mouse.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [mouse](./puppeteer.page.mouse.md) + +## Page.mouse property + +Signature: + +```typescript +get mouse(): Mouse; +``` diff --git a/new-docs/puppeteer.page.pdf.md b/new-docs/puppeteer.page.pdf.md new file mode 100644 index 00000000000..9e90436088e --- /dev/null +++ b/new-docs/puppeteer.page.pdf.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [pdf](./puppeteer.page.pdf.md) + +## Page.pdf() method + +Signature: + +```typescript +pdf(options?: PDFOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | PDFOptions | | + +Returns: + +Promise<Buffer> + diff --git a/new-docs/puppeteer.page.queryobjects.md b/new-docs/puppeteer.page.queryobjects.md new file mode 100644 index 00000000000..6a85584ae23 --- /dev/null +++ b/new-docs/puppeteer.page.queryobjects.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [queryObjects](./puppeteer.page.queryobjects.md) + +## Page.queryObjects() method + +Signature: + +```typescript +queryObjects(prototypeHandle: JSHandle): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prototypeHandle | [JSHandle](./puppeteer.jshandle.md) | | + +Returns: + +Promise<[JSHandle](./puppeteer.jshandle.md)> + diff --git a/new-docs/puppeteer.page.reload.md b/new-docs/puppeteer.page.reload.md new file mode 100644 index 00000000000..fb6a75c5392 --- /dev/null +++ b/new-docs/puppeteer.page.reload.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [reload](./puppeteer.page.reload.md) + +## Page.reload() method + +Signature: + +```typescript +reload(options?: WaitForOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | WaitForOptions | | + +Returns: + +Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null> + diff --git a/new-docs/puppeteer.page.screenshot.md b/new-docs/puppeteer.page.screenshot.md new file mode 100644 index 00000000000..c7df6de93bc --- /dev/null +++ b/new-docs/puppeteer.page.screenshot.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [screenshot](./puppeteer.page.screenshot.md) + +## Page.screenshot() method + +Signature: + +```typescript +screenshot(options?: ScreenshotOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | ScreenshotOptions | | + +Returns: + +Promise<Buffer \| string \| void> + diff --git a/new-docs/puppeteer.page.select.md b/new-docs/puppeteer.page.select.md new file mode 100644 index 00000000000..53c7c9efe99 --- /dev/null +++ b/new-docs/puppeteer.page.select.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [select](./puppeteer.page.select.md) + +## Page.select() method + +Signature: + +```typescript +select(selector: string, ...values: string[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| values | string\[\] | | + +Returns: + +Promise<string\[\]> + diff --git a/new-docs/puppeteer.page.setbypasscsp.md b/new-docs/puppeteer.page.setbypasscsp.md new file mode 100644 index 00000000000..d8a6d332ddb --- /dev/null +++ b/new-docs/puppeteer.page.setbypasscsp.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setBypassCSP](./puppeteer.page.setbypasscsp.md) + +## Page.setBypassCSP() method + +Signature: + +```typescript +setBypassCSP(enabled: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| enabled | boolean | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.setcacheenabled.md b/new-docs/puppeteer.page.setcacheenabled.md new file mode 100644 index 00000000000..707c7214115 --- /dev/null +++ b/new-docs/puppeteer.page.setcacheenabled.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setCacheEnabled](./puppeteer.page.setcacheenabled.md) + +## Page.setCacheEnabled() method + +Signature: + +```typescript +setCacheEnabled(enabled?: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| enabled | boolean | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.setcontent.md b/new-docs/puppeteer.page.setcontent.md new file mode 100644 index 00000000000..d7a427acf1a --- /dev/null +++ b/new-docs/puppeteer.page.setcontent.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setContent](./puppeteer.page.setcontent.md) + +## Page.setContent() method + +Signature: + +```typescript +setContent(html: string, options: WaitForOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| html | string | | +| options | WaitForOptions | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.setcookie.md b/new-docs/puppeteer.page.setcookie.md new file mode 100644 index 00000000000..d461a055c4a --- /dev/null +++ b/new-docs/puppeteer.page.setcookie.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setCookie](./puppeteer.page.setcookie.md) + +## Page.setCookie() method + +Signature: + +```typescript +setCookie(...cookies: Protocol.Network.CookieParam[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| cookies | Protocol.Network.CookieParam\[\] | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.setdefaultnavigationtimeout.md b/new-docs/puppeteer.page.setdefaultnavigationtimeout.md new file mode 100644 index 00000000000..22c4cc052d8 --- /dev/null +++ b/new-docs/puppeteer.page.setdefaultnavigationtimeout.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setDefaultNavigationTimeout](./puppeteer.page.setdefaultnavigationtimeout.md) + +## Page.setDefaultNavigationTimeout() method + +Signature: + +```typescript +setDefaultNavigationTimeout(timeout: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| timeout | number | | + +Returns: + +void + diff --git a/new-docs/puppeteer.page.setdefaulttimeout.md b/new-docs/puppeteer.page.setdefaulttimeout.md new file mode 100644 index 00000000000..b3f097584f2 --- /dev/null +++ b/new-docs/puppeteer.page.setdefaulttimeout.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setDefaultTimeout](./puppeteer.page.setdefaulttimeout.md) + +## Page.setDefaultTimeout() method + +Signature: + +```typescript +setDefaultTimeout(timeout: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| timeout | number | | + +Returns: + +void + diff --git a/new-docs/puppeteer.page.setextrahttpheaders.md b/new-docs/puppeteer.page.setextrahttpheaders.md new file mode 100644 index 00000000000..b97a461365a --- /dev/null +++ b/new-docs/puppeteer.page.setextrahttpheaders.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setExtraHTTPHeaders](./puppeteer.page.setextrahttpheaders.md) + +## Page.setExtraHTTPHeaders() method + +Signature: + +```typescript +setExtraHTTPHeaders(headers: Record): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| headers | Record<string, string> | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.setgeolocation.md b/new-docs/puppeteer.page.setgeolocation.md new file mode 100644 index 00000000000..add5c80a860 --- /dev/null +++ b/new-docs/puppeteer.page.setgeolocation.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setGeolocation](./puppeteer.page.setgeolocation.md) + +## Page.setGeolocation() method + +Signature: + +```typescript +setGeolocation(options: { + longitude: number; + latitude: number; + accuracy?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | { longitude: number; latitude: number; accuracy?: number; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.setjavascriptenabled.md b/new-docs/puppeteer.page.setjavascriptenabled.md new file mode 100644 index 00000000000..197cd3cd75b --- /dev/null +++ b/new-docs/puppeteer.page.setjavascriptenabled.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setJavaScriptEnabled](./puppeteer.page.setjavascriptenabled.md) + +## Page.setJavaScriptEnabled() method + +Signature: + +```typescript +setJavaScriptEnabled(enabled: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| enabled | boolean | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.setofflinemode.md b/new-docs/puppeteer.page.setofflinemode.md new file mode 100644 index 00000000000..979b0b6aa0a --- /dev/null +++ b/new-docs/puppeteer.page.setofflinemode.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setOfflineMode](./puppeteer.page.setofflinemode.md) + +## Page.setOfflineMode() method + +Signature: + +```typescript +setOfflineMode(enabled: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| enabled | boolean | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.setrequestinterception.md b/new-docs/puppeteer.page.setrequestinterception.md new file mode 100644 index 00000000000..bec372b30f2 --- /dev/null +++ b/new-docs/puppeteer.page.setrequestinterception.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setRequestInterception](./puppeteer.page.setrequestinterception.md) + +## Page.setRequestInterception() method + +Signature: + +```typescript +setRequestInterception(value: boolean): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | boolean | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.setuseragent.md b/new-docs/puppeteer.page.setuseragent.md new file mode 100644 index 00000000000..bd8e79c98c9 --- /dev/null +++ b/new-docs/puppeteer.page.setuseragent.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setUserAgent](./puppeteer.page.setuseragent.md) + +## Page.setUserAgent() method + +Signature: + +```typescript +setUserAgent(userAgent: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| userAgent | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.setviewport.md b/new-docs/puppeteer.page.setviewport.md new file mode 100644 index 00000000000..fcfd7c02430 --- /dev/null +++ b/new-docs/puppeteer.page.setviewport.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setViewport](./puppeteer.page.setviewport.md) + +## Page.setViewport() method + +Signature: + +```typescript +setViewport(viewport: Viewport): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| viewport | Viewport | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.tap.md b/new-docs/puppeteer.page.tap.md new file mode 100644 index 00000000000..9953d54a98d --- /dev/null +++ b/new-docs/puppeteer.page.tap.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [tap](./puppeteer.page.tap.md) + +## Page.tap() method + +Signature: + +```typescript +tap(selector: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.target.md b/new-docs/puppeteer.page.target.md new file mode 100644 index 00000000000..5525649d13a --- /dev/null +++ b/new-docs/puppeteer.page.target.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [target](./puppeteer.page.target.md) + +## Page.target() method + +Signature: + +```typescript +target(): Target; +``` +Returns: + +[Target](./puppeteer.target.md) + diff --git a/new-docs/puppeteer.page.title.md b/new-docs/puppeteer.page.title.md new file mode 100644 index 00000000000..931aa7ed736 --- /dev/null +++ b/new-docs/puppeteer.page.title.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [title](./puppeteer.page.title.md) + +## Page.title() method + +Signature: + +```typescript +title(): Promise; +``` +Returns: + +Promise<string> + diff --git a/new-docs/puppeteer.page.touchscreen.md b/new-docs/puppeteer.page.touchscreen.md new file mode 100644 index 00000000000..c213ac2479a --- /dev/null +++ b/new-docs/puppeteer.page.touchscreen.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [touchscreen](./puppeteer.page.touchscreen.md) + +## Page.touchscreen property + +Signature: + +```typescript +get touchscreen(): Touchscreen; +``` diff --git a/new-docs/puppeteer.page.tracing.md b/new-docs/puppeteer.page.tracing.md new file mode 100644 index 00000000000..739ad940934 --- /dev/null +++ b/new-docs/puppeteer.page.tracing.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [tracing](./puppeteer.page.tracing.md) + +## Page.tracing property + +Signature: + +```typescript +get tracing(): Tracing; +``` diff --git a/new-docs/puppeteer.page.type.md b/new-docs/puppeteer.page.type.md new file mode 100644 index 00000000000..a15925a82e0 --- /dev/null +++ b/new-docs/puppeteer.page.type.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [type](./puppeteer.page.type.md) + +## Page.type() method + +Signature: + +```typescript +type(selector: string, text: string, options?: { + delay: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| text | string | | +| options | { delay: number; } | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.page.url.md b/new-docs/puppeteer.page.url.md new file mode 100644 index 00000000000..ed85147d86e --- /dev/null +++ b/new-docs/puppeteer.page.url.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [url](./puppeteer.page.url.md) + +## Page.url() method + +Signature: + +```typescript +url(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.page.viewport.md b/new-docs/puppeteer.page.viewport.md new file mode 100644 index 00000000000..86b9a053e84 --- /dev/null +++ b/new-docs/puppeteer.page.viewport.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [viewport](./puppeteer.page.viewport.md) + +## Page.viewport() method + +Signature: + +```typescript +viewport(): Viewport | null; +``` +Returns: + +Viewport \| null + diff --git a/new-docs/puppeteer.page.waitfor.md b/new-docs/puppeteer.page.waitfor.md new file mode 100644 index 00000000000..8a2eb518ab4 --- /dev/null +++ b/new-docs/puppeteer.page.waitfor.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [waitFor](./puppeteer.page.waitfor.md) + +## Page.waitFor() method + +Signature: + +```typescript +waitFor(selectorOrFunctionOrTimeout: string | number | Function, options?: { + visible?: boolean; + hidden?: boolean; + timeout?: number; + polling?: string | number; + }, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selectorOrFunctionOrTimeout | string \| number \| Function | | +| options | { visible?: boolean; hidden?: boolean; timeout?: number; polling?: string \| number; } | | +| args | unknown\[\] | | + +Returns: + +Promise<[JSHandle](./puppeteer.jshandle.md)> + diff --git a/new-docs/puppeteer.page.waitforfilechooser.md b/new-docs/puppeteer.page.waitforfilechooser.md new file mode 100644 index 00000000000..7dbf5dcb590 --- /dev/null +++ b/new-docs/puppeteer.page.waitforfilechooser.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [waitForFileChooser](./puppeteer.page.waitforfilechooser.md) + +## Page.waitForFileChooser() method + +Signature: + +```typescript +waitForFileChooser(options?: { + timeout?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | { timeout?: number; } | | + +Returns: + +Promise<[FileChooser](./puppeteer.filechooser.md)> + diff --git a/new-docs/puppeteer.page.waitforfunction.md b/new-docs/puppeteer.page.waitforfunction.md new file mode 100644 index 00000000000..e82650f3e7f --- /dev/null +++ b/new-docs/puppeteer.page.waitforfunction.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [waitForFunction](./puppeteer.page.waitforfunction.md) + +## Page.waitForFunction() method + +Signature: + +```typescript +waitForFunction(pageFunction: Function, options?: { + timeout?: number; + polling?: string | number; + }, ...args: unknown[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pageFunction | Function | | +| options | { timeout?: number; polling?: string \| number; } | | +| args | unknown\[\] | | + +Returns: + +Promise<[JSHandle](./puppeteer.jshandle.md)> + diff --git a/new-docs/puppeteer.page.waitfornavigation.md b/new-docs/puppeteer.page.waitfornavigation.md new file mode 100644 index 00000000000..d1d7ca2474c --- /dev/null +++ b/new-docs/puppeteer.page.waitfornavigation.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [waitForNavigation](./puppeteer.page.waitfornavigation.md) + +## Page.waitForNavigation() method + +Signature: + +```typescript +waitForNavigation(options?: WaitForOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | WaitForOptions | | + +Returns: + +Promise<[HTTPResponse](./puppeteer.httpresponse.md) \| null> + diff --git a/new-docs/puppeteer.page.waitforrequest.md b/new-docs/puppeteer.page.waitforrequest.md new file mode 100644 index 00000000000..bb4b853f031 --- /dev/null +++ b/new-docs/puppeteer.page.waitforrequest.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [waitForRequest](./puppeteer.page.waitforrequest.md) + +## Page.waitForRequest() method + +Signature: + +```typescript +waitForRequest(urlOrPredicate: string | Function, options?: { + timeout?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| urlOrPredicate | string \| Function | | +| options | { timeout?: number; } | | + +Returns: + +Promise<[HTTPRequest](./puppeteer.httprequest.md)> + diff --git a/new-docs/puppeteer.page.waitforresponse.md b/new-docs/puppeteer.page.waitforresponse.md new file mode 100644 index 00000000000..a314aaa6379 --- /dev/null +++ b/new-docs/puppeteer.page.waitforresponse.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [waitForResponse](./puppeteer.page.waitforresponse.md) + +## Page.waitForResponse() method + +Signature: + +```typescript +waitForResponse(urlOrPredicate: string | Function, options?: { + timeout?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| urlOrPredicate | string \| Function | | +| options | { timeout?: number; } | | + +Returns: + +Promise<[HTTPResponse](./puppeteer.httpresponse.md)> + diff --git a/new-docs/puppeteer.page.waitforselector.md b/new-docs/puppeteer.page.waitforselector.md new file mode 100644 index 00000000000..0aecbbe7f5b --- /dev/null +++ b/new-docs/puppeteer.page.waitforselector.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [waitForSelector](./puppeteer.page.waitforselector.md) + +## Page.waitForSelector() method + +Signature: + +```typescript +waitForSelector(selector: string, options?: { + visible?: boolean; + hidden?: boolean; + timeout?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| selector | string | | +| options | { visible?: boolean; hidden?: boolean; timeout?: number; } | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md) \| null> + diff --git a/new-docs/puppeteer.page.waitforxpath.md b/new-docs/puppeteer.page.waitforxpath.md new file mode 100644 index 00000000000..8e1c433fac9 --- /dev/null +++ b/new-docs/puppeteer.page.waitforxpath.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [waitForXPath](./puppeteer.page.waitforxpath.md) + +## Page.waitForXPath() method + +Signature: + +```typescript +waitForXPath(xpath: string, options?: { + visible?: boolean; + hidden?: boolean; + timeout?: number; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| xpath | string | | +| options | { visible?: boolean; hidden?: boolean; timeout?: number; } | | + +Returns: + +Promise<[ElementHandle](./puppeteer.elementhandle.md) \| null> + diff --git a/new-docs/puppeteer.page.workers.md b/new-docs/puppeteer.page.workers.md new file mode 100644 index 00000000000..6202c7303d4 --- /dev/null +++ b/new-docs/puppeteer.page.workers.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [workers](./puppeteer.page.workers.md) + +## Page.workers() method + +Signature: + +```typescript +workers(): WebWorker[]; +``` +Returns: + +[WebWorker](./puppeteer.webworker.md)\[\] + diff --git a/new-docs/puppeteer.puppeteer.__experimental_clearqueryhandlers.md b/new-docs/puppeteer.puppeteer.__experimental_clearqueryhandlers.md new file mode 100644 index 00000000000..472cda91f80 --- /dev/null +++ b/new-docs/puppeteer.puppeteer.__experimental_clearqueryhandlers.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [\_\_experimental\_clearQueryHandlers](./puppeteer.puppeteer.__experimental_clearqueryhandlers.md) + +## Puppeteer.\_\_experimental\_clearQueryHandlers() method + +Signature: + +```typescript +__experimental_clearQueryHandlers(): void; +``` +Returns: + +void + diff --git a/new-docs/puppeteer.puppeteer.__experimental_customqueryhandlers.md b/new-docs/puppeteer.puppeteer.__experimental_customqueryhandlers.md new file mode 100644 index 00000000000..a0a3a011db2 --- /dev/null +++ b/new-docs/puppeteer.puppeteer.__experimental_customqueryhandlers.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [\_\_experimental\_customQueryHandlers](./puppeteer.puppeteer.__experimental_customqueryhandlers.md) + +## Puppeteer.\_\_experimental\_customQueryHandlers() method + +Signature: + +```typescript +__experimental_customQueryHandlers(): Map; +``` +Returns: + +Map<string, QueryHandler> + diff --git a/new-docs/puppeteer.puppeteer.__experimental_registercustomqueryhandler.md b/new-docs/puppeteer.puppeteer.__experimental_registercustomqueryhandler.md new file mode 100644 index 00000000000..a82909a0050 --- /dev/null +++ b/new-docs/puppeteer.puppeteer.__experimental_registercustomqueryhandler.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [\_\_experimental\_registerCustomQueryHandler](./puppeteer.puppeteer.__experimental_registercustomqueryhandler.md) + +## Puppeteer.\_\_experimental\_registerCustomQueryHandler() method + +Signature: + +```typescript +__experimental_registerCustomQueryHandler(name: string, queryHandler: QueryHandler): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| queryHandler | QueryHandler | | + +Returns: + +void + diff --git a/new-docs/puppeteer.puppeteer.__experimental_unregistercustomqueryhandler.md b/new-docs/puppeteer.puppeteer.__experimental_unregistercustomqueryhandler.md new file mode 100644 index 00000000000..84995244327 --- /dev/null +++ b/new-docs/puppeteer.puppeteer.__experimental_unregistercustomqueryhandler.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [\_\_experimental\_unregisterCustomQueryHandler](./puppeteer.puppeteer.__experimental_unregistercustomqueryhandler.md) + +## Puppeteer.\_\_experimental\_unregisterCustomQueryHandler() method + +Signature: + +```typescript +__experimental_unregisterCustomQueryHandler(name: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +void + diff --git a/new-docs/puppeteer.puppeteer.__productname.md b/new-docs/puppeteer.puppeteer.__productname.md new file mode 100644 index 00000000000..9dde16807e3 --- /dev/null +++ b/new-docs/puppeteer.puppeteer.__productname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [\_\_productName](./puppeteer.puppeteer.__productname.md) + +## Puppeteer.\_\_productName property + +Signature: + +```typescript +__productName: string; +``` diff --git a/new-docs/puppeteer.puppeteer._changedproduct.md b/new-docs/puppeteer.puppeteer._changedproduct.md new file mode 100644 index 00000000000..4a403a77ff7 --- /dev/null +++ b/new-docs/puppeteer.puppeteer._changedproduct.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [\_changedProduct](./puppeteer.puppeteer._changedproduct.md) + +## Puppeteer.\_changedProduct property + +Signature: + +```typescript +_changedProduct: boolean; +``` diff --git a/new-docs/puppeteer.puppeteer._constructor_.md b/new-docs/puppeteer.puppeteer._constructor_.md new file mode 100644 index 00000000000..1c81db8fe1c --- /dev/null +++ b/new-docs/puppeteer.puppeteer._constructor_.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [(constructor)](./puppeteer.puppeteer._constructor_.md) + +## Puppeteer.(constructor) + +Constructs a new instance of the `Puppeteer` class + +Signature: + +```typescript +constructor(projectRoot: string, preferredRevision: string, isPuppeteerCore: boolean, productName: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| projectRoot | string | | +| preferredRevision | string | | +| isPuppeteerCore | boolean | | +| productName | string | | + diff --git a/new-docs/puppeteer.puppeteer._ispuppeteercore.md b/new-docs/puppeteer.puppeteer._ispuppeteercore.md new file mode 100644 index 00000000000..c4c6655a9c7 --- /dev/null +++ b/new-docs/puppeteer.puppeteer._ispuppeteercore.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [\_isPuppeteerCore](./puppeteer.puppeteer._ispuppeteercore.md) + +## Puppeteer.\_isPuppeteerCore property + +Signature: + +```typescript +_isPuppeteerCore: boolean; +``` diff --git a/new-docs/puppeteer.puppeteer._launcher.md b/new-docs/puppeteer.puppeteer._launcher.md new file mode 100644 index 00000000000..df1596e2e32 --- /dev/null +++ b/new-docs/puppeteer.puppeteer._launcher.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [\_launcher](./puppeteer.puppeteer._launcher.md) + +## Puppeteer.\_launcher property + +Signature: + +```typescript +get _launcher(): ProductLauncher; +``` diff --git a/new-docs/puppeteer.puppeteer._lazylauncher.md b/new-docs/puppeteer.puppeteer._lazylauncher.md new file mode 100644 index 00000000000..5121c255d36 --- /dev/null +++ b/new-docs/puppeteer.puppeteer._lazylauncher.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [\_lazyLauncher](./puppeteer.puppeteer._lazylauncher.md) + +## Puppeteer.\_lazyLauncher property + +Signature: + +```typescript +_lazyLauncher: ProductLauncher; +``` diff --git a/new-docs/puppeteer.puppeteer._preferredrevision.md b/new-docs/puppeteer.puppeteer._preferredrevision.md new file mode 100644 index 00000000000..a5e62c2b1d4 --- /dev/null +++ b/new-docs/puppeteer.puppeteer._preferredrevision.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [\_preferredRevision](./puppeteer.puppeteer._preferredrevision.md) + +## Puppeteer.\_preferredRevision property + +Signature: + +```typescript +_preferredRevision: string; +``` diff --git a/new-docs/puppeteer.puppeteer._productname.md b/new-docs/puppeteer.puppeteer._productname.md new file mode 100644 index 00000000000..9c00de81a9d --- /dev/null +++ b/new-docs/puppeteer.puppeteer._productname.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [\_productName](./puppeteer.puppeteer._productname.md) + +## Puppeteer.\_productName property + +Signature: + +```typescript +get _productName(): string; + +set _productName(name: string); +``` diff --git a/new-docs/puppeteer.puppeteer._projectroot.md b/new-docs/puppeteer.puppeteer._projectroot.md new file mode 100644 index 00000000000..215226cc855 --- /dev/null +++ b/new-docs/puppeteer.puppeteer._projectroot.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [\_projectRoot](./puppeteer.puppeteer._projectroot.md) + +## Puppeteer.\_projectRoot property + +Signature: + +```typescript +_projectRoot: string; +``` diff --git a/new-docs/puppeteer.puppeteer.connect.md b/new-docs/puppeteer.puppeteer.connect.md new file mode 100644 index 00000000000..36baa350a0a --- /dev/null +++ b/new-docs/puppeteer.puppeteer.connect.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [connect](./puppeteer.puppeteer.connect.md) + +## Puppeteer.connect() method + +Signature: + +```typescript +connect(options: BrowserOptions & { + browserWSEndpoint?: string; + browserURL?: string; + transport?: ConnectionTransport; + product?: string; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | BrowserOptions & { browserWSEndpoint?: string; browserURL?: string; transport?: ConnectionTransport; product?: string; } | | + +Returns: + +Promise<[Browser](./puppeteer.browser.md)> + diff --git a/new-docs/puppeteer.puppeteer.createbrowserfetcher.md b/new-docs/puppeteer.puppeteer.createbrowserfetcher.md new file mode 100644 index 00000000000..dffbddfa87d --- /dev/null +++ b/new-docs/puppeteer.puppeteer.createbrowserfetcher.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [createBrowserFetcher](./puppeteer.puppeteer.createbrowserfetcher.md) + +## Puppeteer.createBrowserFetcher() method + +Signature: + +```typescript +createBrowserFetcher(options: BrowserFetcherOptions): BrowserFetcher; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) | | + +Returns: + +[BrowserFetcher](./puppeteer.browserfetcher.md) + diff --git a/new-docs/puppeteer.puppeteer.defaultargs.md b/new-docs/puppeteer.puppeteer.defaultargs.md new file mode 100644 index 00000000000..803de429765 --- /dev/null +++ b/new-docs/puppeteer.puppeteer.defaultargs.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [defaultArgs](./puppeteer.puppeteer.defaultargs.md) + +## Puppeteer.defaultArgs() method + +Signature: + +```typescript +defaultArgs(options: ChromeArgOptions): string[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | ChromeArgOptions | | + +Returns: + +string\[\] + diff --git a/new-docs/puppeteer.puppeteer.devices.md b/new-docs/puppeteer.puppeteer.devices.md new file mode 100644 index 00000000000..82469af5b85 --- /dev/null +++ b/new-docs/puppeteer.puppeteer.devices.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [devices](./puppeteer.puppeteer.devices.md) + +## Puppeteer.devices property + +Signature: + +```typescript +get devices(): DevicesMap; +``` diff --git a/new-docs/puppeteer.puppeteer.errors.md b/new-docs/puppeteer.puppeteer.errors.md new file mode 100644 index 00000000000..a614dbd5b59 --- /dev/null +++ b/new-docs/puppeteer.puppeteer.errors.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [errors](./puppeteer.puppeteer.errors.md) + +## Puppeteer.errors property + +Signature: + +```typescript +get errors(): PuppeteerErrors; +``` diff --git a/new-docs/puppeteer.puppeteer.executablepath.md b/new-docs/puppeteer.puppeteer.executablepath.md new file mode 100644 index 00000000000..7e05dc3a81b --- /dev/null +++ b/new-docs/puppeteer.puppeteer.executablepath.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [executablePath](./puppeteer.puppeteer.executablepath.md) + +## Puppeteer.executablePath() method + +Signature: + +```typescript +executablePath(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.puppeteer.launch.md b/new-docs/puppeteer.puppeteer.launch.md new file mode 100644 index 00000000000..6b458e5c9c1 --- /dev/null +++ b/new-docs/puppeteer.puppeteer.launch.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [launch](./puppeteer.puppeteer.launch.md) + +## Puppeteer.launch() method + +Signature: + +```typescript +launch(options?: LaunchOptions & ChromeArgOptions & BrowserOptions & { + product?: string; + extraPrefsFirefox?: {}; + }): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | LaunchOptions & ChromeArgOptions & BrowserOptions & { product?: string; extraPrefsFirefox?: {}; } | | + +Returns: + +Promise<[Browser](./puppeteer.browser.md)> + diff --git a/new-docs/puppeteer.puppeteer.md b/new-docs/puppeteer.puppeteer.md new file mode 100644 index 00000000000..bfbf737dc2e --- /dev/null +++ b/new-docs/puppeteer.puppeteer.md @@ -0,0 +1,50 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) + +## Puppeteer class + +The main Puppeteer class + +Signature: + +```typescript +export declare class Puppeteer +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(projectRoot, preferredRevision, isPuppeteerCore, productName)](./puppeteer.puppeteer._constructor_.md) | | Constructs a new instance of the Puppeteer class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_\_productName](./puppeteer.puppeteer.__productname.md) | | string | | +| [\_changedProduct](./puppeteer.puppeteer._changedproduct.md) | | boolean | | +| [\_isPuppeteerCore](./puppeteer.puppeteer._ispuppeteercore.md) | | boolean | | +| [\_launcher](./puppeteer.puppeteer._launcher.md) | | ProductLauncher | | +| [\_lazyLauncher](./puppeteer.puppeteer._lazylauncher.md) | | ProductLauncher | | +| [\_preferredRevision](./puppeteer.puppeteer._preferredrevision.md) | | string | | +| [\_productName](./puppeteer.puppeteer._productname.md) | | string | | +| [\_projectRoot](./puppeteer.puppeteer._projectroot.md) | | string | | +| [devices](./puppeteer.puppeteer.devices.md) | | DevicesMap | | +| [errors](./puppeteer.puppeteer.errors.md) | | [PuppeteerErrors](./puppeteer.puppeteererrors.md) | | +| [product](./puppeteer.puppeteer.product.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_\_experimental\_clearQueryHandlers()](./puppeteer.puppeteer.__experimental_clearqueryhandlers.md) | | | +| [\_\_experimental\_customQueryHandlers()](./puppeteer.puppeteer.__experimental_customqueryhandlers.md) | | | +| [\_\_experimental\_registerCustomQueryHandler(name, queryHandler)](./puppeteer.puppeteer.__experimental_registercustomqueryhandler.md) | | | +| [\_\_experimental\_unregisterCustomQueryHandler(name)](./puppeteer.puppeteer.__experimental_unregistercustomqueryhandler.md) | | | +| [connect(options)](./puppeteer.puppeteer.connect.md) | | | +| [createBrowserFetcher(options)](./puppeteer.puppeteer.createbrowserfetcher.md) | | | +| [defaultArgs(options)](./puppeteer.puppeteer.defaultargs.md) | | | +| [executablePath()](./puppeteer.puppeteer.executablepath.md) | | | +| [launch(options)](./puppeteer.puppeteer.launch.md) | | | + diff --git a/new-docs/puppeteer.puppeteer.product.md b/new-docs/puppeteer.puppeteer.product.md new file mode 100644 index 00000000000..93ef07315b4 --- /dev/null +++ b/new-docs/puppeteer.puppeteer.product.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [product](./puppeteer.puppeteer.product.md) + +## Puppeteer.product property + +Signature: + +```typescript +get product(): string; +``` diff --git a/new-docs/puppeteer.puppeteererrors.md b/new-docs/puppeteer.puppeteererrors.md new file mode 100644 index 00000000000..87295c38283 --- /dev/null +++ b/new-docs/puppeteer.puppeteererrors.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [puppeteerErrors](./puppeteer.puppeteererrors.md) + +## puppeteerErrors variable + +Signature: + +```typescript +puppeteerErrors: PuppeteerErrors +``` diff --git a/new-docs/puppeteer.securitydetails._constructor_.md b/new-docs/puppeteer.securitydetails._constructor_.md new file mode 100644 index 00000000000..3c4b8f8556b --- /dev/null +++ b/new-docs/puppeteer.securitydetails._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [SecurityDetails](./puppeteer.securitydetails.md) > [(constructor)](./puppeteer.securitydetails._constructor_.md) + +## SecurityDetails.(constructor) + +Constructs a new instance of the `SecurityDetails` class + +Signature: + +```typescript +constructor(securityPayload: Protocol.Network.SecurityDetails); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| securityPayload | Protocol.Network.SecurityDetails | | + diff --git a/new-docs/puppeteer.securitydetails.issuer.md b/new-docs/puppeteer.securitydetails.issuer.md new file mode 100644 index 00000000000..a31928a0709 --- /dev/null +++ b/new-docs/puppeteer.securitydetails.issuer.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [SecurityDetails](./puppeteer.securitydetails.md) > [issuer](./puppeteer.securitydetails.issuer.md) + +## SecurityDetails.issuer() method + +Signature: + +```typescript +issuer(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.securitydetails.md b/new-docs/puppeteer.securitydetails.md new file mode 100644 index 00000000000..d76f8c20796 --- /dev/null +++ b/new-docs/puppeteer.securitydetails.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [SecurityDetails](./puppeteer.securitydetails.md) + +## SecurityDetails class + +Signature: + +```typescript +export declare class SecurityDetails +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(securityPayload)](./puppeteer.securitydetails._constructor_.md) | | Constructs a new instance of the SecurityDetails class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [issuer()](./puppeteer.securitydetails.issuer.md) | | | +| [protocol()](./puppeteer.securitydetails.protocol.md) | | | +| [subjectAlternativeNames()](./puppeteer.securitydetails.subjectalternativenames.md) | | | +| [subjectName()](./puppeteer.securitydetails.subjectname.md) | | | +| [validFrom()](./puppeteer.securitydetails.validfrom.md) | | | +| [validTo()](./puppeteer.securitydetails.validto.md) | | | + diff --git a/new-docs/puppeteer.securitydetails.protocol.md b/new-docs/puppeteer.securitydetails.protocol.md new file mode 100644 index 00000000000..1d595f70ae7 --- /dev/null +++ b/new-docs/puppeteer.securitydetails.protocol.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [SecurityDetails](./puppeteer.securitydetails.md) > [protocol](./puppeteer.securitydetails.protocol.md) + +## SecurityDetails.protocol() method + +Signature: + +```typescript +protocol(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.securitydetails.subjectalternativenames.md b/new-docs/puppeteer.securitydetails.subjectalternativenames.md new file mode 100644 index 00000000000..7ec68476331 --- /dev/null +++ b/new-docs/puppeteer.securitydetails.subjectalternativenames.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [SecurityDetails](./puppeteer.securitydetails.md) > [subjectAlternativeNames](./puppeteer.securitydetails.subjectalternativenames.md) + +## SecurityDetails.subjectAlternativeNames() method + +Signature: + +```typescript +subjectAlternativeNames(): string[]; +``` +Returns: + +string\[\] + diff --git a/new-docs/puppeteer.securitydetails.subjectname.md b/new-docs/puppeteer.securitydetails.subjectname.md new file mode 100644 index 00000000000..9395ded5f0e --- /dev/null +++ b/new-docs/puppeteer.securitydetails.subjectname.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [SecurityDetails](./puppeteer.securitydetails.md) > [subjectName](./puppeteer.securitydetails.subjectname.md) + +## SecurityDetails.subjectName() method + +Signature: + +```typescript +subjectName(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.securitydetails.validfrom.md b/new-docs/puppeteer.securitydetails.validfrom.md new file mode 100644 index 00000000000..5642d768923 --- /dev/null +++ b/new-docs/puppeteer.securitydetails.validfrom.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [SecurityDetails](./puppeteer.securitydetails.md) > [validFrom](./puppeteer.securitydetails.validfrom.md) + +## SecurityDetails.validFrom() method + +Signature: + +```typescript +validFrom(): number; +``` +Returns: + +number + diff --git a/new-docs/puppeteer.securitydetails.validto.md b/new-docs/puppeteer.securitydetails.validto.md new file mode 100644 index 00000000000..6bf20a2fbd6 --- /dev/null +++ b/new-docs/puppeteer.securitydetails.validto.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [SecurityDetails](./puppeteer.securitydetails.md) > [validTo](./puppeteer.securitydetails.validto.md) + +## SecurityDetails.validTo() method + +Signature: + +```typescript +validTo(): number; +``` +Returns: + +number + diff --git a/new-docs/puppeteer.target._browsercontext.md b/new-docs/puppeteer.target._browsercontext.md new file mode 100644 index 00000000000..a30aeed7d19 --- /dev/null +++ b/new-docs/puppeteer.target._browsercontext.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_browserContext](./puppeteer.target._browsercontext.md) + +## Target.\_browserContext property + +Signature: + +```typescript +_browserContext: BrowserContext; +``` diff --git a/new-docs/puppeteer.target._closedcallback.md b/new-docs/puppeteer.target._closedcallback.md new file mode 100644 index 00000000000..05f7573559b --- /dev/null +++ b/new-docs/puppeteer.target._closedcallback.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_closedCallback](./puppeteer.target._closedcallback.md) + +## Target.\_closedCallback property + +Signature: + +```typescript +_closedCallback: () => void; +``` diff --git a/new-docs/puppeteer.target._constructor_.md b/new-docs/puppeteer.target._constructor_.md new file mode 100644 index 00000000000..a4cd09446c1 --- /dev/null +++ b/new-docs/puppeteer.target._constructor_.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [(constructor)](./puppeteer.target._constructor_.md) + +## Target.(constructor) + +Constructs a new instance of the `Target` class + +Signature: + +```typescript +constructor(targetInfo: Protocol.Target.TargetInfo, browserContext: BrowserContext, sessionFactory: () => Promise, ignoreHTTPSErrors: boolean, defaultViewport: Viewport | null); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| targetInfo | Protocol.Target.TargetInfo | | +| browserContext | [BrowserContext](./puppeteer.browsercontext.md) | | +| sessionFactory | () => Promise<[CDPSession](./puppeteer.cdpsession.md)> | | +| ignoreHTTPSErrors | boolean | | +| defaultViewport | Viewport \| null | | + diff --git a/new-docs/puppeteer.target._defaultviewport.md b/new-docs/puppeteer.target._defaultviewport.md new file mode 100644 index 00000000000..dfd34df6773 --- /dev/null +++ b/new-docs/puppeteer.target._defaultviewport.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_defaultViewport](./puppeteer.target._defaultviewport.md) + +## Target.\_defaultViewport property + +Signature: + +```typescript +_defaultViewport?: Viewport; +``` diff --git a/new-docs/puppeteer.target._ignorehttpserrors.md b/new-docs/puppeteer.target._ignorehttpserrors.md new file mode 100644 index 00000000000..b9fc0868f74 --- /dev/null +++ b/new-docs/puppeteer.target._ignorehttpserrors.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_ignoreHTTPSErrors](./puppeteer.target._ignorehttpserrors.md) + +## Target.\_ignoreHTTPSErrors property + +Signature: + +```typescript +_ignoreHTTPSErrors: boolean; +``` diff --git a/new-docs/puppeteer.target._initializedcallback.md b/new-docs/puppeteer.target._initializedcallback.md new file mode 100644 index 00000000000..697191a35d4 --- /dev/null +++ b/new-docs/puppeteer.target._initializedcallback.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_initializedCallback](./puppeteer.target._initializedcallback.md) + +## Target.\_initializedCallback property + +Signature: + +```typescript +_initializedCallback: (x: boolean) => void; +``` diff --git a/new-docs/puppeteer.target._initializedpromise.md b/new-docs/puppeteer.target._initializedpromise.md new file mode 100644 index 00000000000..e45f784e003 --- /dev/null +++ b/new-docs/puppeteer.target._initializedpromise.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_initializedPromise](./puppeteer.target._initializedpromise.md) + +## Target.\_initializedPromise property + +Signature: + +```typescript +_initializedPromise: Promise; +``` diff --git a/new-docs/puppeteer.target._isclosedpromise.md b/new-docs/puppeteer.target._isclosedpromise.md new file mode 100644 index 00000000000..1860101acc9 --- /dev/null +++ b/new-docs/puppeteer.target._isclosedpromise.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_isClosedPromise](./puppeteer.target._isclosedpromise.md) + +## Target.\_isClosedPromise property + +Signature: + +```typescript +_isClosedPromise: Promise; +``` diff --git a/new-docs/puppeteer.target._isinitialized.md b/new-docs/puppeteer.target._isinitialized.md new file mode 100644 index 00000000000..ce872c064d1 --- /dev/null +++ b/new-docs/puppeteer.target._isinitialized.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_isInitialized](./puppeteer.target._isinitialized.md) + +## Target.\_isInitialized property + +Signature: + +```typescript +_isInitialized: boolean; +``` diff --git a/new-docs/puppeteer.target._pagepromise.md b/new-docs/puppeteer.target._pagepromise.md new file mode 100644 index 00000000000..3ad61130725 --- /dev/null +++ b/new-docs/puppeteer.target._pagepromise.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_pagePromise](./puppeteer.target._pagepromise.md) + +## Target.\_pagePromise property + +Signature: + +```typescript +_pagePromise?: Promise; +``` diff --git a/new-docs/puppeteer.target._sessionfactory.md b/new-docs/puppeteer.target._sessionfactory.md new file mode 100644 index 00000000000..649c64cb493 --- /dev/null +++ b/new-docs/puppeteer.target._sessionfactory.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_sessionFactory](./puppeteer.target._sessionfactory.md) + +## Target.\_sessionFactory property + +Signature: + +```typescript +_sessionFactory: () => Promise; +``` diff --git a/new-docs/puppeteer.target._targetid.md b/new-docs/puppeteer.target._targetid.md new file mode 100644 index 00000000000..2935253aa82 --- /dev/null +++ b/new-docs/puppeteer.target._targetid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_targetId](./puppeteer.target._targetid.md) + +## Target.\_targetId property + +Signature: + +```typescript +_targetId: string; +``` diff --git a/new-docs/puppeteer.target._targetinfo.md b/new-docs/puppeteer.target._targetinfo.md new file mode 100644 index 00000000000..ea43c2ac5e7 --- /dev/null +++ b/new-docs/puppeteer.target._targetinfo.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_targetInfo](./puppeteer.target._targetinfo.md) + +## Target.\_targetInfo property + +Signature: + +```typescript +_targetInfo: Protocol.Target.TargetInfo; +``` diff --git a/new-docs/puppeteer.target._targetinfochanged.md b/new-docs/puppeteer.target._targetinfochanged.md new file mode 100644 index 00000000000..8e15763f424 --- /dev/null +++ b/new-docs/puppeteer.target._targetinfochanged.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_targetInfoChanged](./puppeteer.target._targetinfochanged.md) + +## Target.\_targetInfoChanged() method + +Signature: + +```typescript +_targetInfoChanged(targetInfo: Protocol.Target.TargetInfo): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| targetInfo | Protocol.Target.TargetInfo | | + +Returns: + +void + diff --git a/new-docs/puppeteer.target._workerpromise.md b/new-docs/puppeteer.target._workerpromise.md new file mode 100644 index 00000000000..d652fc5d48a --- /dev/null +++ b/new-docs/puppeteer.target._workerpromise.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [\_workerPromise](./puppeteer.target._workerpromise.md) + +## Target.\_workerPromise property + +Signature: + +```typescript +_workerPromise?: Promise; +``` diff --git a/new-docs/puppeteer.target.browser.md b/new-docs/puppeteer.target.browser.md new file mode 100644 index 00000000000..7d3bf11fc80 --- /dev/null +++ b/new-docs/puppeteer.target.browser.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [browser](./puppeteer.target.browser.md) + +## Target.browser() method + +Signature: + +```typescript +browser(): Browser; +``` +Returns: + +[Browser](./puppeteer.browser.md) + diff --git a/new-docs/puppeteer.target.browsercontext.md b/new-docs/puppeteer.target.browsercontext.md new file mode 100644 index 00000000000..007c29ac3a5 --- /dev/null +++ b/new-docs/puppeteer.target.browsercontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [browserContext](./puppeteer.target.browsercontext.md) + +## Target.browserContext() method + +Signature: + +```typescript +browserContext(): BrowserContext; +``` +Returns: + +[BrowserContext](./puppeteer.browsercontext.md) + diff --git a/new-docs/puppeteer.target.createcdpsession.md b/new-docs/puppeteer.target.createcdpsession.md new file mode 100644 index 00000000000..2d262fa588a --- /dev/null +++ b/new-docs/puppeteer.target.createcdpsession.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [createCDPSession](./puppeteer.target.createcdpsession.md) + +## Target.createCDPSession() method + +Signature: + +```typescript +createCDPSession(): Promise; +``` +Returns: + +Promise<[CDPSession](./puppeteer.cdpsession.md)> + diff --git a/new-docs/puppeteer.target.md b/new-docs/puppeteer.target.md new file mode 100644 index 00000000000..1c1f321b1ac --- /dev/null +++ b/new-docs/puppeteer.target.md @@ -0,0 +1,50 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) + +## Target class + +Signature: + +```typescript +export declare class Target +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(targetInfo, browserContext, sessionFactory, ignoreHTTPSErrors, defaultViewport)](./puppeteer.target._constructor_.md) | | Constructs a new instance of the Target class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_browserContext](./puppeteer.target._browsercontext.md) | | [BrowserContext](./puppeteer.browsercontext.md) | | +| [\_closedCallback](./puppeteer.target._closedcallback.md) | | () => void | | +| [\_defaultViewport](./puppeteer.target._defaultviewport.md) | | Viewport | | +| [\_ignoreHTTPSErrors](./puppeteer.target._ignorehttpserrors.md) | | boolean | | +| [\_initializedCallback](./puppeteer.target._initializedcallback.md) | | (x: boolean) => void | | +| [\_initializedPromise](./puppeteer.target._initializedpromise.md) | | Promise<boolean> | | +| [\_isClosedPromise](./puppeteer.target._isclosedpromise.md) | | Promise<boolean> | | +| [\_isInitialized](./puppeteer.target._isinitialized.md) | | boolean | | +| [\_pagePromise](./puppeteer.target._pagepromise.md) | | Promise<[Page](./puppeteer.page.md)> | | +| [\_sessionFactory](./puppeteer.target._sessionfactory.md) | | () => Promise<[CDPSession](./puppeteer.cdpsession.md)> | | +| [\_targetId](./puppeteer.target._targetid.md) | | string | | +| [\_targetInfo](./puppeteer.target._targetinfo.md) | | Protocol.Target.TargetInfo | | +| [\_workerPromise](./puppeteer.target._workerpromise.md) | | Promise<[WebWorker](./puppeteer.webworker.md)> | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_targetInfoChanged(targetInfo)](./puppeteer.target._targetinfochanged.md) | | | +| [browser()](./puppeteer.target.browser.md) | | | +| [browserContext()](./puppeteer.target.browsercontext.md) | | | +| [createCDPSession()](./puppeteer.target.createcdpsession.md) | | | +| [opener()](./puppeteer.target.opener.md) | | | +| [page()](./puppeteer.target.page.md) | | | +| [type()](./puppeteer.target.type.md) | | | +| [url()](./puppeteer.target.url.md) | | | +| [worker()](./puppeteer.target.worker.md) | | | + diff --git a/new-docs/puppeteer.target.opener.md b/new-docs/puppeteer.target.opener.md new file mode 100644 index 00000000000..93f2eb03e37 --- /dev/null +++ b/new-docs/puppeteer.target.opener.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [opener](./puppeteer.target.opener.md) + +## Target.opener() method + +Signature: + +```typescript +opener(): Target | null; +``` +Returns: + +[Target](./puppeteer.target.md) \| null + diff --git a/new-docs/puppeteer.target.page.md b/new-docs/puppeteer.target.page.md new file mode 100644 index 00000000000..bb8a37a628f --- /dev/null +++ b/new-docs/puppeteer.target.page.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [page](./puppeteer.target.page.md) + +## Target.page() method + +Signature: + +```typescript +page(): Promise; +``` +Returns: + +Promise<[Page](./puppeteer.page.md) \| null> + diff --git a/new-docs/puppeteer.target.type.md b/new-docs/puppeteer.target.type.md new file mode 100644 index 00000000000..e73fd0d48a6 --- /dev/null +++ b/new-docs/puppeteer.target.type.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [type](./puppeteer.target.type.md) + +## Target.type() method + +Signature: + +```typescript +type(): 'page' | 'background_page' | 'service_worker' | 'shared_worker' | 'other' | 'browser' | 'webview'; +``` +Returns: + +'page' \| 'background\_page' \| 'service\_worker' \| 'shared\_worker' \| 'other' \| 'browser' \| 'webview' + diff --git a/new-docs/puppeteer.target.url.md b/new-docs/puppeteer.target.url.md new file mode 100644 index 00000000000..0b00d226bee --- /dev/null +++ b/new-docs/puppeteer.target.url.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [url](./puppeteer.target.url.md) + +## Target.url() method + +Signature: + +```typescript +url(): string; +``` +Returns: + +string + diff --git a/new-docs/puppeteer.target.worker.md b/new-docs/puppeteer.target.worker.md new file mode 100644 index 00000000000..99069481604 --- /dev/null +++ b/new-docs/puppeteer.target.worker.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Target](./puppeteer.target.md) > [worker](./puppeteer.target.worker.md) + +## Target.worker() method + +Signature: + +```typescript +worker(): Promise; +``` +Returns: + +Promise<[WebWorker](./puppeteer.webworker.md) \| null> + diff --git a/new-docs/puppeteer.timeouterror.md b/new-docs/puppeteer.timeouterror.md new file mode 100644 index 00000000000..d8643e1f925 --- /dev/null +++ b/new-docs/puppeteer.timeouterror.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [TimeoutError](./puppeteer.timeouterror.md) + +## TimeoutError class + +Signature: + +```typescript +export declare class TimeoutError extends CustomError +``` diff --git a/new-docs/puppeteer.touchscreen._client.md b/new-docs/puppeteer.touchscreen._client.md new file mode 100644 index 00000000000..c0e1f1ca845 --- /dev/null +++ b/new-docs/puppeteer.touchscreen._client.md @@ -0,0 +1,11 @@ + + +[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._constructor_.md b/new-docs/puppeteer.touchscreen._constructor_.md new file mode 100644 index 00000000000..61062bcfdf4 --- /dev/null +++ b/new-docs/puppeteer.touchscreen._constructor_.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Touchscreen](./puppeteer.touchscreen.md) > [(constructor)](./puppeteer.touchscreen._constructor_.md) + +## Touchscreen.(constructor) + +Constructs a new instance of the `Touchscreen` class + +Signature: + +```typescript +constructor(client: CDPSession, keyboard: Keyboard); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | +| keyboard | [Keyboard](./puppeteer.keyboard.md) | | + diff --git a/new-docs/puppeteer.touchscreen._keyboard.md b/new-docs/puppeteer.touchscreen._keyboard.md new file mode 100644 index 00000000000..b40e94d320d --- /dev/null +++ b/new-docs/puppeteer.touchscreen._keyboard.md @@ -0,0 +1,11 @@ + + +[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 new file mode 100644 index 00000000000..bae9a85e399 --- /dev/null +++ b/new-docs/puppeteer.touchscreen.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Touchscreen](./puppeteer.touchscreen.md) + +## Touchscreen class + +Signature: + +```typescript +export declare class Touchscreen +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(client, keyboard)](./puppeteer.touchscreen._constructor_.md) | | Constructs a new instance of 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 | +| --- | --- | --- | +| [tap(x, y)](./puppeteer.touchscreen.tap.md) | | | + diff --git a/new-docs/puppeteer.touchscreen.tap.md b/new-docs/puppeteer.touchscreen.tap.md new file mode 100644 index 00000000000..78308f1d889 --- /dev/null +++ b/new-docs/puppeteer.touchscreen.tap.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Touchscreen](./puppeteer.touchscreen.md) > [tap](./puppeteer.touchscreen.tap.md) + +## Touchscreen.tap() method + +Signature: + +```typescript +tap(x: number, y: number): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| x | number | | +| y | number | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.tracing._client.md b/new-docs/puppeteer.tracing._client.md new file mode 100644 index 00000000000..104835ac2cc --- /dev/null +++ b/new-docs/puppeteer.tracing._client.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Tracing](./puppeteer.tracing.md) > [\_client](./puppeteer.tracing._client.md) + +## Tracing.\_client property + +Signature: + +```typescript +_client: CDPSession; +``` diff --git a/new-docs/puppeteer.tracing._constructor_.md b/new-docs/puppeteer.tracing._constructor_.md new file mode 100644 index 00000000000..7c13c17217b --- /dev/null +++ b/new-docs/puppeteer.tracing._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Tracing](./puppeteer.tracing.md) > [(constructor)](./puppeteer.tracing._constructor_.md) + +## Tracing.(constructor) + +Constructs a new instance of the `Tracing` class + +Signature: + +```typescript +constructor(client: CDPSession); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | + diff --git a/new-docs/puppeteer.tracing._path.md b/new-docs/puppeteer.tracing._path.md new file mode 100644 index 00000000000..a1eeaceb527 --- /dev/null +++ b/new-docs/puppeteer.tracing._path.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Tracing](./puppeteer.tracing.md) > [\_path](./puppeteer.tracing._path.md) + +## Tracing.\_path property + +Signature: + +```typescript +_path: string; +``` diff --git a/new-docs/puppeteer.tracing._recording.md b/new-docs/puppeteer.tracing._recording.md new file mode 100644 index 00000000000..9d269d1506c --- /dev/null +++ b/new-docs/puppeteer.tracing._recording.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Tracing](./puppeteer.tracing.md) > [\_recording](./puppeteer.tracing._recording.md) + +## Tracing.\_recording property + +Signature: + +```typescript +_recording: boolean; +``` diff --git a/new-docs/puppeteer.tracing.md b/new-docs/puppeteer.tracing.md new file mode 100644 index 00000000000..c83c3a8d378 --- /dev/null +++ b/new-docs/puppeteer.tracing.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Tracing](./puppeteer.tracing.md) + +## Tracing class + +Signature: + +```typescript +export declare class Tracing +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(client)](./puppeteer.tracing._constructor_.md) | | Constructs a new instance of the Tracing class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_client](./puppeteer.tracing._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | | +| [\_path](./puppeteer.tracing._path.md) | | string | | +| [\_recording](./puppeteer.tracing._recording.md) | | boolean | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [start(options)](./puppeteer.tracing.start.md) | | | +| [stop()](./puppeteer.tracing.stop.md) | | | + diff --git a/new-docs/puppeteer.tracing.start.md b/new-docs/puppeteer.tracing.start.md new file mode 100644 index 00000000000..976b44b305f --- /dev/null +++ b/new-docs/puppeteer.tracing.start.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Tracing](./puppeteer.tracing.md) > [start](./puppeteer.tracing.start.md) + +## Tracing.start() method + +Signature: + +```typescript +start(options?: TracingOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | TracingOptions | | + +Returns: + +Promise<void> + diff --git a/new-docs/puppeteer.tracing.stop.md b/new-docs/puppeteer.tracing.stop.md new file mode 100644 index 00000000000..a14c9d6e760 --- /dev/null +++ b/new-docs/puppeteer.tracing.stop.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Tracing](./puppeteer.tracing.md) > [stop](./puppeteer.tracing.stop.md) + +## Tracing.stop() method + +Signature: + +```typescript +stop(): Promise; +``` +Returns: + +Promise<Buffer> + diff --git a/new-docs/puppeteer.webworker._client.md b/new-docs/puppeteer.webworker._client.md new file mode 100644 index 00000000000..d242e2f939d --- /dev/null +++ b/new-docs/puppeteer.webworker._client.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WebWorker](./puppeteer.webworker.md) > [\_client](./puppeteer.webworker._client.md) + +## WebWorker.\_client property + +Signature: + +```typescript +_client: CDPSession; +``` diff --git a/new-docs/puppeteer.webworker._constructor_.md b/new-docs/puppeteer.webworker._constructor_.md new file mode 100644 index 00000000000..503a1e75e5a --- /dev/null +++ b/new-docs/puppeteer.webworker._constructor_.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WebWorker](./puppeteer.webworker.md) > [(constructor)](./puppeteer.webworker._constructor_.md) + +## WebWorker.(constructor) + +Constructs a new instance of the `WebWorker` class + +Signature: + +```typescript +constructor(client: CDPSession, url: string, consoleAPICalled: ConsoleAPICalledCallback, exceptionThrown: ExceptionThrownCallback); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| client | [CDPSession](./puppeteer.cdpsession.md) | | +| url | string | | +| consoleAPICalled | ConsoleAPICalledCallback | | +| exceptionThrown | ExceptionThrownCallback | | + diff --git a/new-docs/puppeteer.webworker._executioncontextcallback.md b/new-docs/puppeteer.webworker._executioncontextcallback.md new file mode 100644 index 00000000000..9420943152d --- /dev/null +++ b/new-docs/puppeteer.webworker._executioncontextcallback.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WebWorker](./puppeteer.webworker.md) > [\_executionContextCallback](./puppeteer.webworker._executioncontextcallback.md) + +## WebWorker.\_executionContextCallback property + +Signature: + +```typescript +_executionContextCallback: (value: ExecutionContext) => void; +``` diff --git a/new-docs/puppeteer.webworker._executioncontextpromise.md b/new-docs/puppeteer.webworker._executioncontextpromise.md new file mode 100644 index 00000000000..524f168091b --- /dev/null +++ b/new-docs/puppeteer.webworker._executioncontextpromise.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WebWorker](./puppeteer.webworker.md) > [\_executionContextPromise](./puppeteer.webworker._executioncontextpromise.md) + +## WebWorker.\_executionContextPromise property + +Signature: + +```typescript +_executionContextPromise: Promise; +``` diff --git a/new-docs/puppeteer.webworker._url.md b/new-docs/puppeteer.webworker._url.md new file mode 100644 index 00000000000..1f218cd66fa --- /dev/null +++ b/new-docs/puppeteer.webworker._url.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WebWorker](./puppeteer.webworker.md) > [\_url](./puppeteer.webworker._url.md) + +## WebWorker.\_url property + +Signature: + +```typescript +_url: string; +``` diff --git a/new-docs/puppeteer.webworker.evaluate.md b/new-docs/puppeteer.webworker.evaluate.md new file mode 100644 index 00000000000..aa9774ee1d8 --- /dev/null +++ b/new-docs/puppeteer.webworker.evaluate.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WebWorker](./puppeteer.webworker.md) > [evaluate](./puppeteer.webworker.evaluate.md) + +## WebWorker.evaluate() method + +Signature: + +```typescript +evaluate(pageFunction: Function | string, ...args: any[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pageFunction | Function \| string | | +| args | any\[\] | | + +Returns: + +Promise<ReturnType> + diff --git a/new-docs/puppeteer.webworker.evaluatehandle.md b/new-docs/puppeteer.webworker.evaluatehandle.md new file mode 100644 index 00000000000..d882d863d63 --- /dev/null +++ b/new-docs/puppeteer.webworker.evaluatehandle.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WebWorker](./puppeteer.webworker.md) > [evaluateHandle](./puppeteer.webworker.evaluatehandle.md) + +## WebWorker.evaluateHandle() method + +Signature: + +```typescript +evaluateHandle(pageFunction: Function | string, ...args: any[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pageFunction | Function \| string | | +| args | any\[\] | | + +Returns: + +Promise<[JSHandle](./puppeteer.jshandle.md)> + diff --git a/new-docs/puppeteer.webworker.executioncontext.md b/new-docs/puppeteer.webworker.executioncontext.md new file mode 100644 index 00000000000..e798b2827ea --- /dev/null +++ b/new-docs/puppeteer.webworker.executioncontext.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WebWorker](./puppeteer.webworker.md) > [executionContext](./puppeteer.webworker.executioncontext.md) + +## WebWorker.executionContext() method + +Signature: + +```typescript +executionContext(): Promise; +``` +Returns: + +Promise<[ExecutionContext](./puppeteer.executioncontext.md)> + diff --git a/new-docs/puppeteer.webworker.md b/new-docs/puppeteer.webworker.md new file mode 100644 index 00000000000..c041406b478 --- /dev/null +++ b/new-docs/puppeteer.webworker.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WebWorker](./puppeteer.webworker.md) + +## WebWorker class + +Signature: + +```typescript +export declare class WebWorker extends EventEmitter +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(client, url, consoleAPICalled, exceptionThrown)](./puppeteer.webworker._constructor_.md) | | Constructs a new instance of the WebWorker class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_client](./puppeteer.webworker._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | | +| [\_executionContextCallback](./puppeteer.webworker._executioncontextcallback.md) | | (value: [ExecutionContext](./puppeteer.executioncontext.md)) => void | | +| [\_executionContextPromise](./puppeteer.webworker._executioncontextpromise.md) | | Promise<[ExecutionContext](./puppeteer.executioncontext.md)> | | +| [\_url](./puppeteer.webworker._url.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [evaluate(pageFunction, args)](./puppeteer.webworker.evaluate.md) | | | +| [evaluateHandle(pageFunction, args)](./puppeteer.webworker.evaluatehandle.md) | | | +| [executionContext()](./puppeteer.webworker.executioncontext.md) | | | +| [url()](./puppeteer.webworker.url.md) | | | + diff --git a/new-docs/puppeteer.webworker.url.md b/new-docs/puppeteer.webworker.url.md new file mode 100644 index 00000000000..2d458a0a981 --- /dev/null +++ b/new-docs/puppeteer.webworker.url.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [WebWorker](./puppeteer.webworker.md) > [url](./puppeteer.webworker.url.md) + +## WebWorker.url() method + +Signature: + +```typescript +url(): string; +``` +Returns: + +string +