mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
9fdf2ba280
Also took the opportunity to pull out the PDF types into their own file to clear up `Page.ts` slightly and give the PDF code a more natural place to live.
10 KiB
10 KiB
puppeteer package
Classes
Class | Description |
---|---|
Accessibility | The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by assistive technology such as screen readers or switches. |
Browser | A Browser is created when Puppeteer connects to a Chromium instance, either through Puppeteer.launch() or Puppeteer.connect(). |
BrowserContext | BrowserContexts provide a way to operate multiple independent browser sessions. When a browser is launched, it has a single BrowserContext used by default. The method Browser.newPage creates a page in the default browser context. |
BrowserFetcher | BrowserFetcher can download and manage different versions of Chromium and Firefox. |
CDPSession | The CDPSession instances are used to talk raw Chrome Devtools Protocol. |
ConsoleMessage | ConsoleMessage objects are dispatched by page via the 'console' event. |
Coverage | The Coverage class provides methods to gathers information about parts of JavaScript and CSS that were used by the page. |
Dialog | Dialog instances are dispatched by the Page via the dialog event. |
ElementHandle | ElementHandle represents an in-page DOM element. |
EventEmitter | The EventEmitter class that many Puppeteer classes extend. |
ExecutionContext | This class represents a context for JavaScript execution. A [Page] might have many execution contexts: - each frame has "default" execution context that is always created after frame is attached to DOM. This context is returned by the method. - Extension's content scripts create additional execution contexts.Besides pages, execution contexts can be found in workers. |
FileChooser | File choosers let you react to the page requesting for a file. |
Frame | At every point of time, page exposes its current frame tree via the page.mainFrame and frame.childFrames methods. |
HTTPRequest | Represents an HTTP request sent by a page. |
HTTPResponse | The HTTPResponse class represents responses which are received by the Page class. |
JSHandle | Represents an in-page JavaScript object. JSHandles can be created with the page.evaluateHandle method. |
Keyboard | Keyboard provides an api for managing a virtual keyboard. The high level api is Keyboard.type(), which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page. |
Mouse | The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport. |
Page | Page provides methods to interact with a single tab or extension background page in Chromium. |
Puppeteer | The main Puppeteer class. Provides the launch method to launch a browser.When you require or import the Puppeteer npm package you get back an instance of this class. |
SecurityDetails | The SecurityDetails class represents the security details of a response that was received over a secure connection. |
Target | |
TimeoutError | TimeoutError is emitted whenever certain operations are terminated due to timeout. |
Touchscreen | The Touchscreen class exposes touchscreen events. |
Tracing | The Tracing class exposes the tracing audit interface. |
WebWorker | The WebWorker class represents a WebWorker. |
Enumerations
Enumeration | Description |
---|---|
BrowserContextEmittedEvents | |
BrowserEmittedEvents | All the events a browser instance may emit. |
PageEmittedEvents | All the events that a page instance may emit. |
Interfaces
Interface | Description |
---|---|
BoundingBox | |
BoxModel | |
BrowserFetcherOptions | |
BrowserFetcherRevisionInfo | |
BrowserOptions | Generic browser options that can be passed when launching any browser. |
ChromeArgOptions | Launcher options that only apply to Chrome. |
ClickOptions | |
ConsoleMessageLocation | |
ContinueRequestOverrides | |
CoverageEntry | The CoverageEntry class represents one entry of the coverage report. |
Credentials | |
CSSCoverageOptions | Set of configurable options for CSS coverage. |
FrameAddScriptTagOptions | |
FrameAddStyleTagOptions | |
FrameWaitForFunctionOptions | |
GeolocationOptions | |
JSCoverageOptions | Set of configurable options for JS coverage. |
JSONObject | |
LaunchOptions | Generic launch options that can be passed when launching any browser. |
Metrics | |
MouseOptions | |
MouseWheelOptions | |
PDFMargin | |
PDFOptions | Valid options to configure PDF generation via Page.pdf(). |
PressOptions | |
ProductLauncher | Describes a launcher - a class that is able to create and launch a browser instance. |
RemoteAddress | |
ResponseForRequest | Required response data to fulfill a request with. |
SerializedAXNode | Represents a Node and the properties of it that are relevant to Accessibility. |
SnapshotOptions | |
TracingOptions | |
WaitForOptions | |
WaitForSelectorOptions | |
WaitForTargetOptions | |
WaitTimeoutOptions |
Namespaces
Namespace | Description |
---|---|
Protocol | ******************************************************************** Auto-generated by protocol-dts-generator.ts, do not edit manually. * ******************************************************************** |
Variables
Variable | Description |
---|---|
devicesMap | |
EVALUATION_SCRIPT_URL | |
puppeteerErrors |
Type Aliases
Type Alias | Description |
---|---|
ConsoleMessageType | The supported types for console messages. |
DevicesMap | |
ErrorCode | |
EvaluateFn | |
EvaluateFnReturnType | |
EvaluateHandleFn | |
JSONArray | |
KeyInput | All the valid keys that can be passed to functions that take user input, such as keyboard.press |
MouseButton | |
PaperFormat | All the valid paper format types when printing a PDF. |
Platform | Supported platforms. |
Product | Supported products. |
PuppeteerErrors | |
PuppeteerLifeCycleEvent | |
Serializable | |
SerializableOrJSHandle | |
UnwrapElementHandle | Unwraps a DOM element out of an ElementHandle instance |
UnwrapPromiseLike | |
WrapElementHandle | Wraps a DOM element into an ElementHandle instance |