From 15dde692f3966feaa5f2653ce1bb6af6977f6590 Mon Sep 17 00:00:00 2001 From: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com> Date: Thu, 11 Apr 2024 13:01:13 +0200 Subject: [PATCH] docs: update links to point to property table (#12249) --- .github/dependabot.yml | 17 +- docs/api/index.md | 346 ++++----- docs/api/puppeteer.accessibility.md | 2 +- docs/api/puppeteer.actionoptions.md | 2 +- docs/api/puppeteer.autofilldata.md | 2 +- docs/api/puppeteer.boundingbox.md | 4 +- docs/api/puppeteer.boxmodel.md | 12 +- docs/api/puppeteer.browser.md | 36 +- docs/api/puppeteer.browserconnectoptions.md | 12 +- docs/api/puppeteer.browsercontext.md | 22 +- docs/api/puppeteer.browsercontextevents.md | 6 +- docs/api/puppeteer.browsercontextoptions.md | 4 +- docs/api/puppeteer.browserevents.md | 8 +- .../puppeteer.browserlaunchargumentoptions.md | 10 +- docs/api/puppeteer.cdpsession.md | 8 +- docs/api/puppeteer.cdpsessionevent.md | 4 +- docs/api/puppeteer.cdpsessionevents.md | 4 +- docs/api/puppeteer.clickoptions.md | 2 +- docs/api/puppeteer.commandoptions.md | 2 +- docs/api/puppeteer.commoneventemitter.md | 12 +- docs/api/puppeteer.configuration.md | 22 +- docs/api/puppeteer.connection.md | 16 +- docs/api/puppeteer.connectiontransport.md | 8 +- docs/api/puppeteer.connectoptions.md | 8 +- docs/api/puppeteer.consolemessage.md | 12 +- docs/api/puppeteer.consolemessagelocation.md | 6 +- .../api/puppeteer.continuerequestoverrides.md | 8 +- docs/api/puppeteer.cookie.md | 30 +- docs/api/puppeteer.cookieparam.md | 26 +- docs/api/puppeteer.coverage.md | 10 +- docs/api/puppeteer.coverageentry.md | 6 +- docs/api/puppeteer.credentials.md | 4 +- docs/api/puppeteer.csscoverage.md | 6 +- docs/api/puppeteer.csscoverageoptions.md | 2 +- docs/api/puppeteer.customqueryhandler.md | 4 +- docs/api/puppeteer.debuginfo.md | 2 +- docs/api/puppeteer.deletecookiesrequest.md | 8 +- docs/api/puppeteer.device.md | 4 +- docs/api/puppeteer.devicerequestprompt.md | 8 +- .../puppeteer.devicerequestpromptdevice.md | 4 +- docs/api/puppeteer.dialog.md | 10 +- docs/api/puppeteer.elementhandle.click.md | 2 +- docs/api/puppeteer.elementhandle.hover.md | 2 +- docs/api/puppeteer.elementhandle.md | 76 +- .../api/puppeteer.elementscreenshotoptions.md | 2 +- docs/api/puppeteer.eventemitter.md | 12 +- docs/api/puppeteer.filechooser.md | 6 +- docs/api/puppeteer.frame.md | 66 +- .../api/puppeteer.frameaddscripttagoptions.md | 10 +- docs/api/puppeteer.frameaddstyletagoptions.md | 6 +- .../puppeteer.framewaitforfunctionoptions.md | 6 +- docs/api/puppeteer.geolocationoptions.md | 6 +- docs/api/puppeteer.gotooptions.md | 4 +- docs/api/puppeteer.httprequest.md | 48 +- docs/api/puppeteer.httpresponse.md | 30 +- .../api/puppeteer.interceptresolutionstate.md | 4 +- .../puppeteer.internalnetworkconditions.md | 2 +- docs/api/puppeteer.jscoverage.md | 6 +- docs/api/puppeteer.jscoverageentry.md | 2 +- docs/api/puppeteer.jscoverageoptions.md | 8 +- docs/api/puppeteer.jshandle.md | 24 +- docs/api/puppeteer.keyboard.md | 10 +- docs/api/puppeteer.keyboardtypeoptions.md | 2 +- docs/api/puppeteer.keydownoptions.md | 4 +- docs/api/puppeteer.launchoptions.md | 26 +- docs/api/puppeteer.locator.md | 34 +- docs/api/puppeteer.locatorevents.md | 2 +- docs/api/puppeteer.locatoroptions.md | 10 +- docs/api/puppeteer.locatorscrolloptions.md | 4 +- docs/api/puppeteer.mediafeature.md | 4 +- docs/api/puppeteer.metrics.md | 26 +- docs/api/puppeteer.mouse.md | 22 +- docs/api/puppeteer.mouseclickoptions.md | 4 +- docs/api/puppeteer.mousemoveoptions.md | 2 +- docs/api/puppeteer.mouseoptions.md | 6 +- docs/api/puppeteer.mousewheeloptions.md | 4 +- docs/api/puppeteer.moveable.md | 2 +- docs/api/puppeteer.networkconditions.md | 6 +- .../puppeteer.newdocumentscriptevaluation.md | 2 +- docs/api/puppeteer.offset.md | 4 +- docs/api/puppeteer.page.click.md | 2 +- docs/api/puppeteer.page.hover.md | 2 +- ...uppeteer.page.isdraginterceptionenabled.md | 2 +- docs/api/puppeteer.page.md | 194 ++--- .../api/puppeteer.page.setdraginterception.md | 2 +- docs/api/puppeteer.page.tap.md | 2 +- docs/api/puppeteer.page.viewport.md | 2 +- docs/api/puppeteer.pageevents.md | 38 +- docs/api/puppeteer.pdfmargin.md | 8 +- docs/api/puppeteer.pdfoptions.md | 36 +- docs/api/puppeteer.point.md | 4 +- docs/api/puppeteer.productlauncher.md | 8 +- docs/api/puppeteer.protocolerror.md | 4 +- docs/api/puppeteer.puppeteerlaunchoptions.md | 4 +- docs/api/puppeteer.puppeteernode.launch.md | 4 +- docs/api/puppeteer.puppeteernode.md | 20 +- docs/api/puppeteer.remoteaddress.md | 4 +- docs/api/puppeteer.responseforrequest.md | 8 +- docs/api/puppeteer.screencastoptions.md | 10 +- docs/api/puppeteer.screenrecorder.md | 2 +- docs/api/puppeteer.screenshotclip.md | 2 +- docs/api/puppeteer.screenshotoptions.md | 20 +- docs/api/puppeteer.securitydetails.md | 12 +- docs/api/puppeteer.serializedaxnode.md | 52 +- docs/api/puppeteer.snapshotoptions.md | 4 +- docs/api/puppeteer.target.md | 18 +- docs/api/puppeteer.touchscreen.md | 8 +- docs/api/puppeteer.tracing.md | 4 +- docs/api/puppeteer.tracingoptions.md | 6 +- docs/api/puppeteer.viewport.md | 12 +- .../puppeteer.waitfornetworkidleoptions.md | 4 +- docs/api/puppeteer.waitforoptions.md | 4 +- docs/api/puppeteer.waitforselectoroptions.md | 8 +- docs/api/puppeteer.waitfortargetoptions.md | 2 +- docs/api/puppeteer.waittimeoutoptions.md | 2 +- docs/api/puppeteer.webworker.md | 10 +- docs/browsers-api/browsers.cli.md | 4 +- .../browsers.getinstalledbrowsersoptions.md | 2 +- .../browsers-api/browsers.installedbrowser.md | 14 +- docs/browsers-api/browsers.installoptions.md | 16 +- docs/browsers-api/browsers.launchoptions.md | 20 +- docs/browsers-api/browsers.options.md | 8 +- docs/browsers-api/browsers.process.md | 12 +- docs/browsers-api/browsers.profileoptions.md | 4 +- docs/browsers-api/browsers.systemoptions.md | 6 +- .../browsers-api/browsers.uninstalloptions.md | 8 +- docs/browsers-api/index.md | 58 +- packages/puppeteer-core/src/api/Browser.ts | 2 +- .../puppeteer-core/src/api/ElementHandle.ts | 4 +- packages/puppeteer-core/src/api/Page.ts | 13 +- .../puppeteer-core/src/common/PDFOptions.ts | 2 +- .../puppeteer-core/src/node/PuppeteerNode.ts | 6 +- .../docgen/src/custom_markdown_documenter.ts | 42 +- website/package-lock.json | 684 +++++++++--------- website/package.json | 12 +- 135 files changed, 1355 insertions(+), 1301 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 1d95e44dd83..8ab0f255602 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -20,8 +20,8 @@ updates: dependency-type: development patterns: - '*' - - package-ecosystem: github-actions - directory: / + - package-ecosystem: npm + directory: /website schedule: interval: weekly day: 'sunday' @@ -31,7 +31,7 @@ updates: all: patterns: - '*' - - package-ecosystem: docker + - package-ecosystem: github-actions directory: / schedule: interval: weekly @@ -42,3 +42,14 @@ updates: all: patterns: - '*' + - package-ecosystem: docker + directory: / + schedule: + interval: weekly + day: 'sunday' + time: '05:00' + timezone: Europe/Berlin + groups: + all: + patterns: + - '*' diff --git a/docs/api/index.md b/docs/api/index.md index 04b297da46b..aa62b2a7688 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -17,7 +17,7 @@ Description -[Accessibility](./puppeteer.accessibility.md) +[Accessibility](./puppeteer.accessibility.md) @@ -26,7 +26,7 @@ The Accessibility class provides methods for inspecting the browser's accessibil -[Browser](./puppeteer.browser.md) +[Browser](./puppeteer.browser.md) @@ -34,12 +34,12 @@ The Accessibility class provides methods for inspecting the browser's accessibil - connected to via [Puppeteer.connect()](./puppeteer.puppeteer.connect.md) or - launched by [PuppeteerNode.launch()](./puppeteer.puppeteernode.launch.md). -[Browser](./puppeteer.browser.md) [emits](./puppeteer.eventemitter.md) various events which are documented in the [BrowserEvent](./puppeteer.browserevent.md) enum. +[Browser](./puppeteer.browser.md) [emits](./puppeteer.eventemitter.emit.md) various events which are documented in the [BrowserEvent](./puppeteer.browserevent.md) enum. -[BrowserContext](./puppeteer.browsercontext.md) +[BrowserContext](./puppeteer.browsercontext.md) @@ -54,7 +54,7 @@ If a [page](./puppeteer.page.md) opens another [page](./puppeteer.page.md), e.g. -[CDPSession](./puppeteer.cdpsession.md) +[CDPSession](./puppeteer.cdpsession.md) @@ -63,14 +63,14 @@ The `CDPSession` instances are used to talk raw Chrome Devtools Protocol. -[Connection](./puppeteer.connection.md) +[Connection](./puppeteer.connection.md) -[ConsoleMessage](./puppeteer.consolemessage.md) +[ConsoleMessage](./puppeteer.consolemessage.md) @@ -79,7 +79,7 @@ ConsoleMessage objects are dispatched by page via the 'console' event. -[Coverage](./puppeteer.coverage.md) +[Coverage](./puppeteer.coverage.md) @@ -88,14 +88,14 @@ The Coverage class provides methods to gather information about parts of JavaScr -[CSSCoverage](./puppeteer.csscoverage.md) +[CSSCoverage](./puppeteer.csscoverage.md) -[DeviceRequestPrompt](./puppeteer.devicerequestprompt.md) +[DeviceRequestPrompt](./puppeteer.devicerequestprompt.md) @@ -104,7 +104,7 @@ Device request prompts let you respond to the page requesting for a device throu -[DeviceRequestPromptDevice](./puppeteer.devicerequestpromptdevice.md) +[DeviceRequestPromptDevice](./puppeteer.devicerequestpromptdevice.md) @@ -113,7 +113,7 @@ Device in a request prompt. -[Dialog](./puppeteer.dialog.md) +[Dialog](./puppeteer.dialog.md) @@ -122,7 +122,7 @@ Dialog instances are dispatched by the [Page](./puppeteer.page.md) via the `dial -[ElementHandle](./puppeteer.elementhandle.md) +[ElementHandle](./puppeteer.elementhandle.md) @@ -131,7 +131,7 @@ ElementHandle represents an in-page DOM element. -[EventEmitter](./puppeteer.eventemitter.md) +[EventEmitter](./puppeteer.eventemitter.md) @@ -140,7 +140,7 @@ The EventEmitter class that many Puppeteer classes extend. -[FileChooser](./puppeteer.filechooser.md) +[FileChooser](./puppeteer.filechooser.md) @@ -149,7 +149,7 @@ File choosers let you react to the page requesting for a file. -[Frame](./puppeteer.frame.md) +[Frame](./puppeteer.frame.md) @@ -160,7 +160,7 @@ To understand frames, you can think of frames as `