puppeteer/new-docs/puppeteer.protocol.md
2020-07-13 14:01:35 +01:00

6.8 KiB

Home > puppeteer > Protocol

Protocol namespace

******************************************************************** Auto-generated by protocol-dts-generator.ts, do not edit manually. * ********************************************************************

Signature:

export namespace Protocol 

Namespaces

Namespace Description
Accessibility
Animation
ApplicationCache
Audits Audits domain allows investigation of page violations and possible improvements.
BackgroundService Defines events for background web platform features.
Browser The Browser domain defines methods and events for browser managing.
CacheStorage
Cast A domain for interacting with Cast, Presentation API, and Remote Playback API functionalities.
Console This domain is deprecated - use Runtime or Log instead.
CSS This domain exposes CSS read/write operations. All CSS objects (stylesheets, rules, and styles) have an associated id used in subsequent operations on the related object. Each object type has a specific id structure, and those are not interchangeable between objects of different kinds. CSS objects can be loaded using the get*ForNode() calls (which accept a DOM node id). A client can also keep track of stylesheets via the styleSheetAdded/styleSheetRemoved events and subsequently load the required stylesheet contents using the getStyleSheetText methods.
Database
Debugger Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing breakpoints, stepping through execution, exploring stack traces, etc.
DeviceOrientation
DOM This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object that has an id. This id can be used to get additional information on the Node, resolve it into the JavaScript object wrapper, etc. It is important that client receives DOM events only for the nodes that are known to the client. Backend keeps track of the nodes that were sent to the client and never sends the same node twice. It is client's responsibility to collect information about the nodes that were sent to the client.

Note that iframe owner elements will return corresponding document elements as their child nodes.

DOMDebugger DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript execution will stop on these operations as if there was a regular breakpoint set.
DOMSnapshot This domain facilitates obtaining document snapshots with DOM, layout, and style information.
DOMStorage Query and modify DOM storage.
Emulation This domain emulates different environments for the page.
Fetch A domain for letting clients substitute browser's network layer with client code.
HeadlessExperimental This domain provides experimental commands only supported in headless mode.
HeapProfiler
IndexedDB
Input
Inspector
IO Input/Output operations for streams produced by DevTools.
LayerTree
Log Provides access to log entries.
Media This domain allows detailed inspection of media elements
Memory
Network Network domain allows tracking network activities of the page. It exposes information about http, file, data and other requests and responses, their headers, bodies, timing, etc.
Overlay This domain provides various functionality related to drawing atop the inspected page.
Page Actions and events related to the inspected page belong to the page domain.
Performance
Profiler
Runtime Runtime domain exposes JavaScript runtime by means of remote evaluation and mirror objects. Evaluation results are returned as mirror object that expose object type, string representation and unique identifier that can be used for further object reference. Original objects are maintained in memory unless they are either explicitly released or are released along with the other objects in their object group.
Schema This domain is deprecated.
Security Security
ServiceWorker
Storage
SystemInfo The SystemInfo domain defines methods and events for querying low-level system information.
Target Supports additional targets discovery and allows to attach to them.
Tethering The Tethering domain defines methods and events for browser port binding.
Tracing
WebAudio This domain allows inspection of Web Audio API. https://webaudio.github.io/web-audio-api/
WebAuthn This domain allows configuring virtual authenticators to test the WebAuthn API.

Type Aliases

Type Alias Description
integer