mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
api(cdp): rename ChromiumSession to CDPSession (#1380)
This commit is contained in:
parent
19dd2338d9
commit
e692dd6e62
22
docs/api.md
22
docs/api.md
@ -29,7 +29,7 @@
|
|||||||
- [class: ChromiumBrowser](#class-chromiumbrowser)
|
- [class: ChromiumBrowser](#class-chromiumbrowser)
|
||||||
- [class: ChromiumBrowserContext](#class-chromiumbrowsercontext)
|
- [class: ChromiumBrowserContext](#class-chromiumbrowsercontext)
|
||||||
- [class: ChromiumCoverage](#class-chromiumcoverage)
|
- [class: ChromiumCoverage](#class-chromiumcoverage)
|
||||||
- [class: ChromiumSession](#class-chromiumsession)
|
- [class: CDPSession](#class-cdpsession)
|
||||||
- [class: FirefoxBrowser](#class-firefoxbrowser)
|
- [class: FirefoxBrowser](#class-firefoxbrowser)
|
||||||
- [class: WebKitBrowser](#class-webkitbrowser)
|
- [class: WebKitBrowser](#class-webkitbrowser)
|
||||||
- [Environment Variables](#environment-variables)
|
- [Environment Variables](#environment-variables)
|
||||||
@ -3742,7 +3742,7 @@ await browser.stopTracing();
|
|||||||
<!-- GEN:stop -->
|
<!-- GEN:stop -->
|
||||||
|
|
||||||
#### chromiumBrowser.newBrowserCDPSession()
|
#### chromiumBrowser.newBrowserCDPSession()
|
||||||
- returns: <[Promise]<[ChromiumSession]>> Promise that resolves to the newly created browser
|
- returns: <[Promise]<[CDPSession]>> Promise that resolves to the newly created browser
|
||||||
session.
|
session.
|
||||||
|
|
||||||
#### chromiumBrowser.startTracing([page, options])
|
#### chromiumBrowser.startTracing([page, options])
|
||||||
@ -3815,7 +3815,7 @@ Emitted when new service worker is created in the context.
|
|||||||
|
|
||||||
#### chromiumBrowserContext.newCDPSession(page)
|
#### chromiumBrowserContext.newCDPSession(page)
|
||||||
- `page` <[Page]> Page to create new session for.
|
- `page` <[Page]> Page to create new session for.
|
||||||
- returns: <[Promise]<[ChromiumSession]>> Promise that resolves to the newly created session.
|
- returns: <[Promise]<[CDPSession]>> Promise that resolves to the newly created session.
|
||||||
|
|
||||||
### class: ChromiumCoverage
|
### class: ChromiumCoverage
|
||||||
|
|
||||||
@ -3882,11 +3882,11 @@ const v8toIstanbul = require('v8-to-istanbul');
|
|||||||
> **NOTE** JavaScript Coverage doesn't include anonymous scripts by default. However, scripts with sourceURLs are
|
> **NOTE** JavaScript Coverage doesn't include anonymous scripts by default. However, scripts with sourceURLs are
|
||||||
reported.
|
reported.
|
||||||
|
|
||||||
### class: ChromiumSession
|
### class: CDPSession
|
||||||
|
|
||||||
* extends: [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter)
|
* extends: [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter)
|
||||||
|
|
||||||
The `ChromiumSession` instances are used to talk raw Chrome Devtools Protocol:
|
The `CDPSession` instances are used to talk raw Chrome Devtools Protocol:
|
||||||
- protocol methods can be called with `session.send` method.
|
- protocol methods can be called with `session.send` method.
|
||||||
- protocol events can be subscribed to with `session.on` method.
|
- protocol events can be subscribed to with `session.on` method.
|
||||||
|
|
||||||
@ -3906,17 +3906,17 @@ await client.send('Animation.setPlaybackRate', {
|
|||||||
```
|
```
|
||||||
|
|
||||||
<!-- GEN:toc -->
|
<!-- GEN:toc -->
|
||||||
- [chromiumSession.detach()](#chromiumsessiondetach)
|
- [cdpSession.detach()](#cdpsessiondetach)
|
||||||
- [chromiumSession.send(method[, params])](#chromiumsessionsendmethod-params)
|
- [cdpSession.send(method[, params])](#cdpsessionsendmethod-params)
|
||||||
<!-- GEN:stop -->
|
<!-- GEN:stop -->
|
||||||
|
|
||||||
#### chromiumSession.detach()
|
#### cdpSession.detach()
|
||||||
- returns: <[Promise]>
|
- returns: <[Promise]>
|
||||||
|
|
||||||
Detaches the chromiumSession from the target. Once detached, the chromiumSession object won't emit any events and can't be used
|
Detaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be used
|
||||||
to send messages.
|
to send messages.
|
||||||
|
|
||||||
#### chromiumSession.send(method[, params])
|
#### cdpSession.send(method[, params])
|
||||||
- `method` <[string]> protocol method name
|
- `method` <[string]> protocol method name
|
||||||
- `params` <[Object]> Optional method parameters
|
- `params` <[Object]> Optional method parameters
|
||||||
- returns: <[Promise]<[Object]>>
|
- returns: <[Promise]<[Object]>>
|
||||||
@ -4040,7 +4040,7 @@ const { chromium } = require('playwright');
|
|||||||
[ChromiumBrowser]: #class-chromiumbrowser "ChromiumBrowser"
|
[ChromiumBrowser]: #class-chromiumbrowser "ChromiumBrowser"
|
||||||
[ChromiumBrowserContext]: #class-chromiumbrowsercontext "ChromiumBrowserContext"
|
[ChromiumBrowserContext]: #class-chromiumbrowsercontext "ChromiumBrowserContext"
|
||||||
[ChromiumCoverage]: #class-chromiumcoverage "ChromiumCoverage"
|
[ChromiumCoverage]: #class-chromiumcoverage "ChromiumCoverage"
|
||||||
[ChromiumSession]: #class-chromiumsession "ChromiumSession"
|
[CDPSession]: #class-cdpsession "CDPSession"
|
||||||
[ConsoleMessage]: #class-consolemessage "ConsoleMessage"
|
[ConsoleMessage]: #class-consolemessage "ConsoleMessage"
|
||||||
[Dialog]: #class-dialog "Dialog"
|
[Dialog]: #class-dialog "Dialog"
|
||||||
[ElementHandle]: #class-elementhandle "ElementHandle"
|
[ElementHandle]: #class-elementhandle "ElementHandle"
|
||||||
|
|||||||
@ -31,7 +31,7 @@ export { Selectors } from './selectors';
|
|||||||
export { CRBrowser as ChromiumBrowser } from './chromium/crBrowser';
|
export { CRBrowser as ChromiumBrowser } from './chromium/crBrowser';
|
||||||
export { CRBrowserContext as ChromiumBrowserContext } from './chromium/crBrowser';
|
export { CRBrowserContext as ChromiumBrowserContext } from './chromium/crBrowser';
|
||||||
export { CRCoverage as ChromiumCoverage } from './chromium/crCoverage';
|
export { CRCoverage as ChromiumCoverage } from './chromium/crCoverage';
|
||||||
export { CRSession as ChromiumSession } from './chromium/crConnection';
|
export { CRSession as CDPSession } from './chromium/crConnection';
|
||||||
|
|
||||||
export { FFBrowser as FirefoxBrowser } from './firefox/ffBrowser';
|
export { FFBrowser as FirefoxBrowser } from './firefox/ffBrowser';
|
||||||
|
|
||||||
|
|||||||
@ -85,12 +85,12 @@ const BROWSER_CONFIGS = [
|
|||||||
...require('../lib/events').Events,
|
...require('../lib/events').Events,
|
||||||
...require('../lib/chromium/events').Events,
|
...require('../lib/chromium/events').Events,
|
||||||
},
|
},
|
||||||
missingCoverage: ['browserContext.setGeolocation', 'browserContext.setOffline', 'worker.url'],
|
missingCoverage: ['browserContext.setGeolocation', 'browserContext.setOffline', 'worker.url', 'cDPSession.send', 'cDPSession.detach'],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: 'WebKit',
|
name: 'WebKit',
|
||||||
events: require('../lib/events').Events,
|
events: require('../lib/events').Events,
|
||||||
missingCoverage: ['browserContext.clearPermissions'],
|
missingCoverage: ['browserContext.clearPermissions', 'cDPSession.send', 'cDPSession.detach'],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: 'Chromium',
|
name: 'Chromium',
|
||||||
|
|||||||
@ -326,6 +326,8 @@ function checkSources(sources, externalDependencies) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function expandPrefix(name) {
|
function expandPrefix(name) {
|
||||||
|
if (name === 'CRSession')
|
||||||
|
return 'CDPSession';
|
||||||
if (name.startsWith('CR'))
|
if (name.startsWith('CR'))
|
||||||
return 'Chromium' + name.substring(2);
|
return 'Chromium' + name.substring(2);
|
||||||
if (name.startsWith('FF'))
|
if (name.startsWith('FF'))
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user