thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
782c1d4873
puppeteer/new-docs/puppeteer.md

110 lines
8.8 KiB
Markdown
Raw Normal View History

chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md)
## puppeteer package
## Classes
| Class | Description |
| --- | --- |
| [Accessibility](./puppeteer.accessibility.md) | The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or [switches](https://en.wikipedia.org/wiki/Switch_access)<!-- -->. |
| [Browser](./puppeteer.browser.md) | A Browser is created when Puppeteer connects to a Chromium instance, either through [Puppeteer.launch()](./puppeteer.puppeteer.launch.md) or [Puppeteer.connect()](./puppeteer.puppeteer.connect.md)<!-- -->. |
| [BrowserContext](./puppeteer.browsercontext.md) | 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](./puppeteer.browser.newpage.md) creates a page in the default browser context. |
docs(new): add TSDoc comments to BrowserFetcher (#6078)
2020-06-24 08:33:19 +00:00
| [BrowserFetcher](./puppeteer.browserfetcher.md) | BrowserFetcher can download and manage different versions of Chromium and Firefox. |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
| [CDPSession](./puppeteer.cdpsession.md) | The <code>CDPSession</code> instances are used to talk raw Chrome Devtools Protocol. |
| [Connection](./puppeteer.connection.md) | |
| [ConsoleMessage](./puppeteer.consolemessage.md) | ConsoleMessage objects are dispatched by page via the 'console' event. |
docs(new): Add TSDoc to Coverage class (#6106)
2020-06-29 08:53:28 +00:00
| [Coverage](./puppeteer.coverage.md) | The Coverage class provides methods to gathers information about parts of JavaScript and CSS that were used by the page. |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
| [Dialog](./puppeteer.dialog.md) | Dialog instances are dispatched by the [Page](./puppeteer.page.md) via the <code>dialog</code> event. |
| [ElementHandle](./puppeteer.elementhandle.md) | ElementHandle represents an in-page DOM element. |
| [EventEmitter](./puppeteer.eventemitter.md) | The EventEmitter class that many Puppeteer classes extend. |
docs(new): add TSDoc comments to Puppeteer (#6032) (#6094) Co-authored-by: Martin Splitt <mr.avgp@googlemail.com>
2020-06-24 15:11:10 +00:00
| [ExecutionContext](./puppeteer.executioncontext.md) | This class represents a context for JavaScript execution. A \[Page\] might have many execution contexts: - each [frame](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) has "default" execution context that is always created after frame is attached to DOM. This context is returned by the method. - [Extension](https://developer.chrome.com/extensions)<!-- -->'s content scripts create additional execution contexts.<!-- -->Besides pages, execution contexts can be found in [workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API)<!-- -->. |
docs(new): migrate FileChooser docs to TSDoc (#6092) Co-authored-by: martinsplitt <martin@geekonaut.de>
2020-06-24 10:18:53 +00:00
| [FileChooser](./puppeteer.filechooser.md) | File choosers let you react to the page requesting for a file. |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
| [Frame](./puppeteer.frame.md) | |
chore(docs): document HTTPRequest with TSDoc (#6146) * chore(docs): document HTTPRequest with TSDoc * doclint * example
2020-07-03 13:28:45 +00:00
| [HTTPRequest](./puppeteer.httprequest.md) | Represents an HTTP request sent by a page. |
docs(new): migrate HTTPResponse docs to TSDoc (#6085) Co-authored-by: Changhao Han <changhaohan@chromium.org>
2020-06-25 09:26:36 +00:00
| [HTTPResponse](./puppeteer.httpresponse.md) | The HTTPResponse class represents responses which are received by the [Page](./puppeteer.page.md) class. |
docs(new): migrate JSHandle docs to TSDoc (#6102)
2020-06-25 14:49:35 +00:00
| [JSHandle](./puppeteer.jshandle.md) | Represents an in-page JavaScript object. JSHandles can be created with the [page.evaluateHandle](./puppeteer.page.evaluatehandle.md) method. |
docs(new): add TSDoc comments to Keyboard (#6099) Co-authored-by: Tim van der Lippe <tvanderlippe@google.com>
2020-06-25 09:56:55 +00:00
| [Keyboard](./puppeteer.keyboard.md) | Keyboard provides an api for managing a virtual keyboard. The high level api is [Keyboard.type()](./puppeteer.keyboard.type.md)<!-- -->, which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page. |
docs(new): Adds TSDoc to Mouse class (#6086) * Adds tsdoc to Mouse class * Updates puppeteer class tsdoc * docs(new): add TSDoc comments to BrowserFetcher (#6078) * Adds tsdoc for Touchscreen (#6087) Co-authored-by: martinsplitt <martin@geekonaut.de> * Adds tsdoc to Mouse class * Fixes tsdoc comment for Mouse class Co-authored-by: martinsplitt <martin@geekonaut.de>
2020-06-24 09:00:13 +00:00
| [Mouse](./puppeteer.mouse.md) | The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport. |
chore(docs): migrate & document all Page events (#6154) * chore(docs): migrate & document all Page events Rather than a generic `Events.ts` file we can instead document events as an enum within each individual class. It's easier to document and work with, and it's clearer where events originate from.
2020-07-06 10:34:55 +00:00
| [Page](./puppeteer.page.md) | Page provides methods to interact with a single tab or [extension background page](https://developer.chrome.com/extensions/background_pages) in Chromium. |
docs(new): add TSDoc comments to Puppeteer (#6032)
2020-06-24 14:21:46 +00:00
| [Puppeteer](./puppeteer.puppeteer.md) | The main Puppeteer class Puppeteer module provides a method to launch a browser instance. |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
| [SecurityDetails](./puppeteer.securitydetails.md) | The SecurityDetails class represents the security details of a response that was received over a secure connection. |
| [Target](./puppeteer.target.md) | |
| [TimeoutError](./puppeteer.timeouterror.md) | TimeoutError is emitted whenever certain operations are terminated due to timeout. |
docs(new): migrate Touchscreen docs to TSDoc (#6087) Co-authored-by: martinsplitt <martin@geekonaut.de>
2020-06-24 08:34:37 +00:00
| [Touchscreen](./puppeteer.touchscreen.md) | The Touchscreen class exposes touchscreen events. |
docs(new): Adds TSDoc to Tracing class (#6088) * Adds tsdoc to Tracing class * Updates tsdocs Co-authored-by: martinsplitt <martin@geekonaut.de>
2020-06-24 12:57:59 +00:00
| [Tracing](./puppeteer.tracing.md) | The Tracing class exposes the tracing audit interface. |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
| [WebWorker](./puppeteer.webworker.md) | The WebWorker class represents a [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API)<!-- -->. |
## Enumerations
| Enumeration | Description |
| --- | --- |
chore(docs): define events enum for `Browser` (#6165)
2020-07-06 11:23:40 +00:00
| [BrowserEmittedEvents](./puppeteer.browseremittedevents.md) | All the events a [browser instance](./puppeteer.browser.md) may emit. |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
| [PageEmittedEvents](./puppeteer.pageemittedevents.md) | All the events that a page instance may emit. |
## Interfaces
| Interface | Description |
| --- | --- |
| [BoundingBox](./puppeteer.boundingbox.md) | |
| [BoxModel](./puppeteer.boxmodel.md) | |
| [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) | |
chore(docs): reduce warnings when generating docs (#6138) * chore(docs): reduce warnings when generating docs This is a bunch of small miscellaneous fixes that reduce the amount of warnings logged when generating our new docs. The long term goal is to get this list down to 0 warnings, but I'll do it in multiple PRs. * satisfy doclint
2020-07-02 11:15:39 +00:00
| [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) | |
| [BrowserOptions](./puppeteer.browseroptions.md) | Generic browser options that can be passed when launching any browser. |
| [ChromeArgOptions](./puppeteer.chromeargoptions.md) | Launcher options that only apply to Chrome. |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
| [ClickOptions](./puppeteer.clickoptions.md) | |
| [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) | |
chore(docs): document HTTPRequest with TSDoc (#6146) * chore(docs): document HTTPRequest with TSDoc * doclint * example
2020-07-03 13:28:45 +00:00
| [ContinueRequestOverrides](./puppeteer.continuerequestoverrides.md) | |
docs(new): Add TSDoc to Coverage class (#6106)
2020-06-29 08:53:28 +00:00
| [CoverageEntry](./puppeteer.coverageentry.md) | The CoverageEntry class represents one entry of the coverage report. |
chore(docs): fix more documentation warnings (#6145)
2020-07-02 15:13:22 +00:00
| [Credentials](./puppeteer.credentials.md) | |
docs(new): Add TSDoc to Coverage class (#6106)
2020-06-29 08:53:28 +00:00
| [CSSCoverageOptions](./puppeteer.csscoverageoptions.md) | Set of configurable options for CSS coverage. |
docs(new): migrate Page.ts to TSDoc (part 0 / 2) (#6104) * docs(new): migrate Page.ts to TSDoc (part 0 / 2) Co-authored-by: Changhao Han <changhaohan@chromium.org>
2020-06-26 07:24:56 +00:00
| [GeolocationOptions](./puppeteer.geolocationoptions.md) | |
docs(new): Add TSDoc to Coverage class (#6106)
2020-06-29 08:53:28 +00:00
| [JSCoverageOptions](./puppeteer.jscoverageoptions.md) | Set of configurable options for JS coverage. |
feat(types): improve typing of `.evaluate()` (#6096) * feat(types): improve typing of `.evaluate()` This is the start of the work to take the types from the `@types/puppeteer` repository and port them into our repo so we can ship our built-in types out the box. This change types the `evaluate` function properly. It takes a generic type which is the type of the function you're passing, and the arguments and the return that you get back from the `evaluate` call are typed correctly.
2020-06-25 12:38:01 +00:00
| [JSONObject](./puppeteer.jsonobject.md) | |
chore(docs): reduce warnings when generating docs (#6138) * chore(docs): reduce warnings when generating docs This is a bunch of small miscellaneous fixes that reduce the amount of warnings logged when generating our new docs. The long term goal is to get this list down to 0 warnings, but I'll do it in multiple PRs. * satisfy doclint
2020-07-02 11:15:39 +00:00
| [LaunchOptions](./puppeteer.launchoptions.md) | Generic launch options that can be passed when launching any browser. |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
| [Metrics](./puppeteer.metrics.md) | |
chore(docs): reduce warnings when generating docs (#6138) * chore(docs): reduce warnings when generating docs This is a bunch of small miscellaneous fixes that reduce the amount of warnings logged when generating our new docs. The long term goal is to get this list down to 0 warnings, but I'll do it in multiple PRs. * satisfy doclint
2020-07-02 11:15:39 +00:00
| [MouseOptions](./puppeteer.mouseoptions.md) | |
feat: add Mouse#wheel (#6141)
2020-07-06 07:27:17 +00:00
| [MouseWheelOptions](./puppeteer.mousewheeloptions.md) | |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
| [PressOptions](./puppeteer.pressoptions.md) | |
chore(docs): reduce warnings when generating docs (#6138) * chore(docs): reduce warnings when generating docs This is a bunch of small miscellaneous fixes that reduce the amount of warnings logged when generating our new docs. The long term goal is to get this list down to 0 warnings, but I'll do it in multiple PRs. * satisfy doclint
2020-07-02 11:15:39 +00:00
| [ProductLauncher](./puppeteer.productlauncher.md) | Describes a launcher - a class that is able to create and launch a browser instance. |
docs(new): migrate HTTPResponse docs to TSDoc (#6085) Co-authored-by: Changhao Han <changhaohan@chromium.org>
2020-06-25 09:26:36 +00:00
| [RemoteAddress](./puppeteer.remoteaddress.md) | |
chore(docs): document HTTPRequest with TSDoc (#6146) * chore(docs): document HTTPRequest with TSDoc * doclint * example
2020-07-03 13:28:45 +00:00
| [ResponseForRequest](./puppeteer.responseforrequest.md) | Required response data to fulfill a request with. |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
| [SerializedAXNode](./puppeteer.serializedaxnode.md) | Represents a Node and the properties of it that are relevant to Accessibility. |
| [SnapshotOptions](./puppeteer.snapshotoptions.md) | |
chore(docs): reduce warnings when generating docs (#6138) * chore(docs): reduce warnings when generating docs This is a bunch of small miscellaneous fixes that reduce the amount of warnings logged when generating our new docs. The long term goal is to get this list down to 0 warnings, but I'll do it in multiple PRs. * satisfy doclint
2020-07-02 11:15:39 +00:00
| [TracingOptions](./puppeteer.tracingoptions.md) | |
docs(new): migrate Page.ts to TSDoc (part 0 / 2) (#6104) * docs(new): migrate Page.ts to TSDoc (part 0 / 2) Co-authored-by: Changhao Han <changhaohan@chromium.org>
2020-06-26 07:24:56 +00:00
| [WaitForOptions](./puppeteer.waitforoptions.md) | |
chore(docs): fix more documentation warnings (#6145)
2020-07-02 15:13:22 +00:00
| [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) | |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
| [WaitForTargetOptions](./puppeteer.waitfortargetoptions.md) | |
docs(new): migrate Page.ts to TSDoc (part 0 / 2) (#6104) * docs(new): migrate Page.ts to TSDoc (part 0 / 2) Co-authored-by: Changhao Han <changhaohan@chromium.org>
2020-06-26 07:24:56 +00:00
| [WaitTimeoutOptions](./puppeteer.waittimeoutoptions.md) | |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
## Variables
| Variable | Description |
| --- | --- |
chore(docs): reduce warnings when generating docs (#6138) * chore(docs): reduce warnings when generating docs This is a bunch of small miscellaneous fixes that reduce the amount of warnings logged when generating our new docs. The long term goal is to get this list down to 0 warnings, but I'll do it in multiple PRs. * satisfy doclint
2020-07-02 11:15:39 +00:00
| [devicesMap](./puppeteer.devicesmap.md) | |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
| [EVALUATION\_SCRIPT\_URL](./puppeteer.evaluation_script_url.md) | |
| [puppeteerErrors](./puppeteer.puppeteererrors.md) | |
## Type Aliases
| Type Alias | Description |
| --- | --- |
| [ConsoleMessageType](./puppeteer.consolemessagetype.md) | The supported types for console messages. |
chore(docs): reduce warnings when generating docs (#6138) * chore(docs): reduce warnings when generating docs This is a bunch of small miscellaneous fixes that reduce the amount of warnings logged when generating our new docs. The long term goal is to get this list down to 0 warnings, but I'll do it in multiple PRs. * satisfy doclint
2020-07-02 11:15:39 +00:00
| [DevicesMap](./puppeteer.devicesmap.md) | |
chore(docs): document HTTPRequest with TSDoc (#6146) * chore(docs): document HTTPRequest with TSDoc * doclint * example
2020-07-03 13:28:45 +00:00
| [ErrorCode](./puppeteer.errorcode.md) | |
feat(types): improve typing of `.evaluate()` (#6096) * feat(types): improve typing of `.evaluate()` This is the start of the work to take the types from the `@types/puppeteer` repository and port them into our repo so we can ship our built-in types out the box. This change types the `evaluate` function properly. It takes a generic type which is the type of the function you're passing, and the arguments and the return that you get back from the `evaluate` call are typed correctly.
2020-06-25 12:38:01 +00:00
| [EvaluateFn](./puppeteer.evaluatefn.md) | |
| [EvaluateFnReturnType](./puppeteer.evaluatefnreturntype.md) | |
feat(types): add (and fix) `evaluateHandle` types (#6130) This change started as a small change to pull types from DefinitelyTyped over to Puppeteer for the `evaluateHandle` function but instead ended up also fixing what looks to be a long standing issue with our existing documentation. `evaluateHandle` can in fact return an `ElementHandle` rather than a `JSHandle`. Note that `ElementHandle` extends `JSHandle` so whilst the docs are technically correct (all ElementHandles are JSHandles) it's confusing because JSHandles don't have methods like `click` on them, but ElementHandles do. if you return something that is an HTML element: ``` const button = page.evaluateHandle(() => document.querySelector('button')); // this is an ElementHandle, not a JSHandle ``` Therefore I've updated the original docs and added a large explanation to the TSDoc for `page.evaluateHandle`. In TypeScript land we'll assume the function will return a `JSHandle` but you can tell TS otherwise via the generic argument, which can only be `JSHandle` (the default) or `ElementHandle`: ``` const button = page.evaluateHandle<ElementHandle>(() => document.querySelector('button')); ```
2020-07-01 11:44:08 +00:00
| [EvaluateHandleFn](./puppeteer.evaluatehandlefn.md) | |
feat(types): improve typing of `.evaluate()` (#6096) * feat(types): improve typing of `.evaluate()` This is the start of the work to take the types from the `@types/puppeteer` repository and port them into our repo so we can ship our built-in types out the box. This change types the `evaluate` function properly. It takes a generic type which is the type of the function you're passing, and the arguments and the return that you get back from the `evaluate` call are typed correctly.
2020-06-25 12:38:01 +00:00
| [JSONArray](./puppeteer.jsonarray.md) | |
chore(docs): reduce warnings when generating docs (#6138) * chore(docs): reduce warnings when generating docs This is a bunch of small miscellaneous fixes that reduce the amount of warnings logged when generating our new docs. The long term goal is to get this list down to 0 warnings, but I'll do it in multiple PRs. * satisfy doclint
2020-07-02 11:15:39 +00:00
| [KeyInput](./puppeteer.keyinput.md) | All the valid keys that can be passed to functions that take user input, such as [keyboard.press](./puppeteer.keyboard.press.md) |
| [MouseButton](./puppeteer.mousebutton.md) | |
| [Platform](./puppeteer.platform.md) | Supported platforms. |
| [Product](./puppeteer.product.md) | Supported products. |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
| [PuppeteerErrors](./puppeteer.puppeteererrors.md) | |
feat(types): improve typing of `.evaluate()` (#6096) * feat(types): improve typing of `.evaluate()` This is the start of the work to take the types from the `@types/puppeteer` repository and port them into our repo so we can ship our built-in types out the box. This change types the `evaluate` function properly. It takes a generic type which is the type of the function you're passing, and the arguments and the return that you get back from the `evaluate` call are typed correctly.
2020-06-25 12:38:01 +00:00
| [Serializable](./puppeteer.serializable.md) | |
| [SerializableOrJSHandle](./puppeteer.serializableorjshandle.md) | |
feat(types): add types for `$eval` (#6135) This pulls in the types (based on the DefinitelyTyped repo) for `page.$eval` (and the `$eval` method on other classes). The `$eval` method is quite hard to type due to the way we wrap and unwrap ElementHandles that are passed to / returned from the `pageFunction` that users provide. Longer term we can improve the types by providing type overloads as DefinitelyTyped does but I've deferred that for now (see the `TODO` in the code for more details).
2020-07-02 09:09:34 +00:00
| [UnwrapElementHandle](./puppeteer.unwrapelementhandle.md) | Unwraps a DOM element out of an ElementHandle instance |
| [WrapElementHandle](./puppeteer.wrapelementhandle.md) | Wraps a DOM element into an ElementHandle instance |
chore: fix ESLint violation and lessen rule strictness (#6081)
2020-06-23 11:55:42 +00:00
Reference in New Issue Copy Permalink