Jack Franklin 23f18d8cc0 docs(new): start documenting the Page class (#6001) ...

This PR starts exploring the Page class and how to best document it. It explores how best to document events in the system, and I think pulling them out into an `enum` is the best solution here. It lets us end up with a page of docs that explicitly lists all the events the page class can ever emit.

2020-06-12 11:10:12 +01:00

..

index.md

…

puppeteer.accessibility.md

…

puppeteer.accessibility.snapshot.md

…

puppeteer.browser._closecallback.md

…

puppeteer.browser._connection.md

…

puppeteer.browser._constructor_.md

…

puppeteer.browser._contexts.md

…

puppeteer.browser._createpageincontext.md

…

puppeteer.browser._defaultcontext.md

…

puppeteer.browser._defaultviewport.md

…

puppeteer.browser._disposecontext.md

…

puppeteer.browser._getversion.md

…

puppeteer.browser._ignorehttpserrors.md

…

puppeteer.browser._process.md

…

puppeteer.browser._targetcreated.md

…

puppeteer.browser._targetdestroyed.md

…

puppeteer.browser._targetinfochanged.md

…

puppeteer.browser._targets.md

…

puppeteer.browser.browsercontexts.md

…

puppeteer.browser.close.md

…

puppeteer.browser.create.md

…

puppeteer.browser.createincognitobrowsercontext.md

…

puppeteer.browser.defaultbrowsercontext.md

…

puppeteer.browser.disconnect.md

…

puppeteer.browser.isconnected.md

…

puppeteer.browser.md

…

puppeteer.browser.newpage.md

…

puppeteer.browser.pages.md

…

puppeteer.browser.process.md

…

puppeteer.browser.target.md

…

puppeteer.browser.targets.md

…

puppeteer.browser.useragent.md

…

puppeteer.browser.version.md

…

puppeteer.browser.waitfortarget.md

…

puppeteer.browser.wsendpoint.md

…

puppeteer.browsercontext._browser.md

…

puppeteer.browsercontext._connection.md

…

puppeteer.browsercontext._constructor_.md

…

puppeteer.browsercontext._id.md

…

puppeteer.browsercontext.browser.md

…

puppeteer.browsercontext.clearpermissionoverrides.md

…

puppeteer.browsercontext.close.md

…

puppeteer.browsercontext.isincognito.md

…

puppeteer.browsercontext.md

…

puppeteer.browsercontext.newpage.md

…

puppeteer.browsercontext.overridepermissions.md

…

puppeteer.browsercontext.pages.md

…

puppeteer.browsercontext.targets.md

…

puppeteer.browsercontext.waitfortarget.md

…

puppeteer.browserfetcher._constructor_.md

…

puppeteer.browserfetcher._getfolderpath.md

…

puppeteer.browserfetcher.candownload.md

…

puppeteer.browserfetcher.download.md

…

puppeteer.browserfetcher.host.md

…

puppeteer.browserfetcher.localrevisions.md

…

puppeteer.browserfetcher.md

…

puppeteer.browserfetcher.platform.md

…

puppeteer.browserfetcher.product.md

…

puppeteer.browserfetcher.remove.md

…

puppeteer.browserfetcher.revisioninfo.md

…

puppeteer.browserfetcheroptions.host.md

…

puppeteer.browserfetcheroptions.md

…

puppeteer.browserfetcheroptions.path.md

…

puppeteer.browserfetcheroptions.platform.md

…

puppeteer.browserfetcheroptions.product.md

…

puppeteer.cdpsession._callbacks.md

…

puppeteer.cdpsession._connection.md

…

puppeteer.cdpsession._constructor_.md

…

puppeteer.cdpsession._onclosed.md

…

puppeteer.cdpsession._onmessage.md

…

puppeteer.cdpsession._sessionid.md

…

puppeteer.cdpsession._targettype.md

…

puppeteer.cdpsession.detach.md

…

puppeteer.cdpsession.md

…

puppeteer.cdpsession.send.md

…

puppeteer.connection._callbacks.md

…

puppeteer.connection._closed.md

…

puppeteer.connection._constructor_.md

…

puppeteer.connection._delay.md

…

puppeteer.connection._lastid.md

…

puppeteer.connection._onclose.md

…

puppeteer.connection._onmessage.md

…

puppeteer.connection._rawsend.md

…

puppeteer.connection._sessions.md

…

puppeteer.connection._transport.md

…

puppeteer.connection._url.md

…

puppeteer.connection.createsession.md

…

puppeteer.connection.dispose.md

…

puppeteer.connection.fromsession.md

…

puppeteer.connection.md

…

puppeteer.connection.send.md

…

puppeteer.connection.session.md

…

puppeteer.connection.url.md

…

puppeteer.consolemessage._constructor_.md

…

puppeteer.consolemessage.args.md

…

puppeteer.consolemessage.location.md

…

puppeteer.consolemessage.md

…

puppeteer.consolemessage.text.md

…

puppeteer.consolemessage.type.md

…

puppeteer.coverage._constructor_.md

…

puppeteer.coverage._csscoverage.md

…

puppeteer.coverage._jscoverage.md

…

puppeteer.coverage.md

…

puppeteer.coverage.startcsscoverage.md

…

puppeteer.coverage.startjscoverage.md

…

puppeteer.coverage.stopcsscoverage.md

…

puppeteer.coverage.stopjscoverage.md

…

puppeteer.createjshandle.md

…

puppeteer.dialog.accept.md

feat(new-docs): migrate Dialog documentation to TSDoc (#5981)

2020-06-09 09:19:42 +01:00

puppeteer.dialog.defaultvalue.md

feat(new-docs): migrate Dialog documentation to TSDoc (#5981)

2020-06-09 09:19:42 +01:00

puppeteer.dialog.dismiss.md

feat(new-docs): migrate Dialog documentation to TSDoc (#5981)

2020-06-09 09:19:42 +01:00

puppeteer.dialog.md

feat(new-docs): migrate Dialog documentation to TSDoc (#5981)

2020-06-09 09:19:42 +01:00

puppeteer.dialog.message.md

feat(new-docs): migrate Dialog documentation to TSDoc (#5981)

2020-06-09 09:19:42 +01:00

puppeteer.dialog.type.md

feat(new-docs): migrate Dialog documentation to TSDoc (#5981)

2020-06-09 09:19:42 +01:00

puppeteer.elementhandle.__.md

…

puppeteer.elementhandle.__eval.md

…

puppeteer.elementhandle._.md

…

puppeteer.elementhandle._clickablepoint.md

…

puppeteer.elementhandle._constructor_.md

…

puppeteer.elementhandle._eval.md

…

puppeteer.elementhandle._framemanager.md

…

puppeteer.elementhandle._fromprotocolquad.md

…

puppeteer.elementhandle._getboxmodel.md

…

puppeteer.elementhandle._intersectquadwithviewport.md

…

puppeteer.elementhandle._page.md

…

puppeteer.elementhandle._scrollintoviewifneeded.md

…

puppeteer.elementhandle._x.md

…

puppeteer.elementhandle.aselement.md

…

puppeteer.elementhandle.boundingbox.md

…

puppeteer.elementhandle.boxmodel.md

…

puppeteer.elementhandle.click.md

…

puppeteer.elementhandle.contentframe.md

…

puppeteer.elementhandle.focus.md

…

puppeteer.elementhandle.hover.md

…

puppeteer.elementhandle.isintersectingviewport.md

…

puppeteer.elementhandle.md

…

puppeteer.elementhandle.press.md

…

puppeteer.elementhandle.screenshot.md

…

puppeteer.elementhandle.select.md

…

puppeteer.elementhandle.tap.md

…

puppeteer.elementhandle.type.md

…

puppeteer.elementhandle.uploadfile.md

…

puppeteer.evaluation_script_url.md

chore: commit base new-docs (#5973)

2020-06-04 15:56:45 +01:00

puppeteer.executioncontext._adoptbackendnodeid.md

…

puppeteer.executioncontext._adoptelementhandle.md

…

puppeteer.executioncontext._client.md

…

puppeteer.executioncontext._constructor_.md

…

puppeteer.executioncontext._contextid.md

…

puppeteer.executioncontext._world.md

…

puppeteer.executioncontext.evaluate.md

…

puppeteer.executioncontext.evaluatehandle.md

…

puppeteer.executioncontext.frame.md

…

puppeteer.executioncontext.md

…

puppeteer.executioncontext.queryobjects.md

…

puppeteer.filechooser._constructor_.md

…

puppeteer.filechooser.accept.md

…

puppeteer.filechooser.cancel.md

…

puppeteer.filechooser.ismultiple.md

…

puppeteer.filechooser.md

…

puppeteer.frame.__.md

…

puppeteer.frame.__eval.md

…

puppeteer.frame._.md

…

puppeteer.frame._childframes.md

…

puppeteer.frame._client.md

…

puppeteer.frame._constructor_.md

…

puppeteer.frame._detach.md

…

puppeteer.frame._detached.md

…

puppeteer.frame._eval.md

…

puppeteer.frame._framemanager.md

…

puppeteer.frame._id.md

…

puppeteer.frame._lifecycleevents.md

…

puppeteer.frame._loaderid.md

…

puppeteer.frame._mainworld.md

…

puppeteer.frame._name.md

…

puppeteer.frame._navigated.md

…

puppeteer.frame._navigatedwithindocument.md

…

puppeteer.frame._onlifecycleevent.md

…

puppeteer.frame._onloadingstopped.md

…

puppeteer.frame._parentframe.md

…

puppeteer.frame._secondaryworld.md

…

puppeteer.frame._url.md

…

puppeteer.frame._x.md

…

puppeteer.frame.addscripttag.md

…

puppeteer.frame.addstyletag.md

…

puppeteer.frame.childframes.md

…

puppeteer.frame.click.md

…

puppeteer.frame.content.md

…

puppeteer.frame.evaluate.md

…

puppeteer.frame.evaluatehandle.md

…

puppeteer.frame.executioncontext.md

…

puppeteer.frame.focus.md

…

puppeteer.frame.goto.md

…

puppeteer.frame.hover.md

…

puppeteer.frame.isdetached.md

…

puppeteer.frame.md

…

puppeteer.frame.name.md

…

puppeteer.frame.parentframe.md

…

puppeteer.frame.select.md

…

puppeteer.frame.setcontent.md

…

puppeteer.frame.tap.md

…

puppeteer.frame.title.md

…

puppeteer.frame.type.md

…

puppeteer.frame.url.md

…

puppeteer.frame.waitfor.md

…

puppeteer.frame.waitforfunction.md

…

puppeteer.frame.waitfornavigation.md

…

puppeteer.frame.waitforselector.md

…

puppeteer.frame.waitforxpath.md

…

puppeteer.framemanager._client.md

…

puppeteer.framemanager._constructor_.md

…

puppeteer.framemanager._contextidtocontext.md

…

puppeteer.framemanager._ensureisolatedworld.md

…

puppeteer.framemanager._frames.md

…

puppeteer.framemanager._handleframetree.md

…

puppeteer.framemanager._isolatedworlds.md

…

puppeteer.framemanager._mainframe.md

…

puppeteer.framemanager._networkmanager.md

…

puppeteer.framemanager._onexecutioncontextcreated.md

…

puppeteer.framemanager._onexecutioncontextdestroyed.md

…

puppeteer.framemanager._onexecutioncontextscleared.md

…

puppeteer.framemanager._onframeattached.md

…

puppeteer.framemanager._onframedetached.md

…

puppeteer.framemanager._onframenavigated.md

…

puppeteer.framemanager._onframenavigatedwithindocument.md

…

puppeteer.framemanager._onframestoppedloading.md

…

puppeteer.framemanager._onlifecycleevent.md

…

puppeteer.framemanager._page.md

…

puppeteer.framemanager._removeframesrecursively.md

…

puppeteer.framemanager._timeoutsettings.md

…

puppeteer.framemanager.executioncontextbyid.md

…

puppeteer.framemanager.frame.md

…

puppeteer.framemanager.frames.md

…

puppeteer.framemanager.initialize.md

…

puppeteer.framemanager.mainframe.md

…

puppeteer.framemanager.md

…

puppeteer.framemanager.navigateframe.md

…

puppeteer.framemanager.networkmanager.md

…

puppeteer.framemanager.page.md

…

puppeteer.framemanager.waitforframenavigation.md

…

puppeteer.httprequest._constructor_.md

…

puppeteer.httprequest._failuretext.md

…

puppeteer.httprequest._frommemorycache.md

…

puppeteer.httprequest._interceptionid.md

…

puppeteer.httprequest._redirectchain.md

…

puppeteer.httprequest._requestid.md

…

puppeteer.httprequest._response.md

…

puppeteer.httprequest.abort.md

…

puppeteer.httprequest.continue.md

…

puppeteer.httprequest.failure.md

…

puppeteer.httprequest.frame.md

…

puppeteer.httprequest.headers.md

…

puppeteer.httprequest.isnavigationrequest.md

…

puppeteer.httprequest.md

…

puppeteer.httprequest.method.md

…

puppeteer.httprequest.postdata.md

…

puppeteer.httprequest.redirectchain.md

…

puppeteer.httprequest.resourcetype.md

…

puppeteer.httprequest.respond.md

…

puppeteer.httprequest.response.md

…

puppeteer.httprequest.url.md

…

puppeteer.httpresponse._constructor_.md

…

puppeteer.httpresponse._resolvebody.md

…

puppeteer.httpresponse.buffer.md

…

puppeteer.httpresponse.frame.md

…

puppeteer.httpresponse.fromcache.md

…

puppeteer.httpresponse.fromserviceworker.md

…

puppeteer.httpresponse.headers.md

…

puppeteer.httpresponse.json.md

…

puppeteer.httpresponse.md

…

puppeteer.httpresponse.ok.md

…

puppeteer.httpresponse.remoteaddress.md

…

puppeteer.httpresponse.request.md

…

puppeteer.httpresponse.securitydetails.md

…

puppeteer.httpresponse.status.md

…

puppeteer.httpresponse.statustext.md

…

puppeteer.httpresponse.text.md

…

puppeteer.httpresponse.url.md

…

puppeteer.jshandle._client.md

…

puppeteer.jshandle._constructor_.md

…

puppeteer.jshandle._context.md

…

puppeteer.jshandle._disposed.md

…

puppeteer.jshandle._remoteobject.md

…

puppeteer.jshandle.aselement.md

…

puppeteer.jshandle.dispose.md

…

puppeteer.jshandle.evaluate.md

…

puppeteer.jshandle.evaluatehandle.md

…

puppeteer.jshandle.executioncontext.md

…

puppeteer.jshandle.getproperties.md

…

puppeteer.jshandle.getproperty.md

…

puppeteer.jshandle.jsonvalue.md

…

puppeteer.jshandle.md

…

puppeteer.jshandle.tostring.md

…

puppeteer.keyboard._client.md

…

puppeteer.keyboard._constructor_.md

…

puppeteer.keyboard._modifiers.md

…

puppeteer.keyboard._pressedkeys.md

…

puppeteer.keyboard.down.md

…

puppeteer.keyboard.md

…

puppeteer.keyboard.press.md

…

puppeteer.keyboard.sendcharacter.md

…

puppeteer.keyboard.type.md

…

puppeteer.keyboard.up.md

…

puppeteer.md

docs(new): start documenting the Page class (#6001)

2020-06-12 11:10:12 +01:00

puppeteer.mouse._button.md

…

puppeteer.mouse._client.md

…

puppeteer.mouse._constructor_.md

…

puppeteer.mouse._keyboard.md

…

puppeteer.mouse._x.md

…

puppeteer.mouse._y.md

…

puppeteer.mouse.click.md

…

puppeteer.mouse.down.md

…

puppeteer.mouse.md

…

puppeteer.mouse.move.md

…

puppeteer.mouse.up.md

…

puppeteer.mousebuttoninput.md

…

puppeteer.page.__.md

…

puppeteer.page.__eval.md

…

puppeteer.page._.md

…

puppeteer.page._eval.md

…

puppeteer.page._x.md

…

puppeteer.page.accessibility.md

…

puppeteer.page.addscripttag.md

…

puppeteer.page.addstyletag.md

…

puppeteer.page.authenticate.md

…

puppeteer.page.bringtofront.md

…

puppeteer.page.browser.md

…

puppeteer.page.browsercontext.md

…

puppeteer.page.click.md

…

puppeteer.page.close.md

…

puppeteer.page.content.md

…

puppeteer.page.cookies.md

…

puppeteer.page.coverage.md

…

puppeteer.page.deletecookie.md

…

puppeteer.page.emulate.md

…

puppeteer.page.emulatemediafeatures.md

…

puppeteer.page.emulatemediatype.md

…

puppeteer.page.emulatetimezone.md

…

puppeteer.page.emulatevisiondeficiency.md

…

puppeteer.page.evaluate.md

…

puppeteer.page.evaluatehandle.md

…

puppeteer.page.evaluateonnewdocument.md

…

puppeteer.page.exposefunction.md

…

puppeteer.page.focus.md

…

puppeteer.page.frames.md

…

puppeteer.page.goback.md

…

puppeteer.page.goforward.md

…

puppeteer.page.goto.md

…

puppeteer.page.hover.md

…

puppeteer.page.isclosed.md

…

puppeteer.page.isjavascriptenabled.md

feat(api): add Page.isJavaScriptEnabled + mark properties as private (#5993)

2020-06-10 16:15:02 +01:00

puppeteer.page.keyboard.md

…

puppeteer.page.mainframe.md

…

puppeteer.page.md

docs(new): start documenting the Page class (#6001)

2020-06-12 11:10:12 +01:00

puppeteer.page.metrics.md

…

puppeteer.page.mouse.md

…

puppeteer.page.pdf.md

…

puppeteer.page.queryobjects.md

…

puppeteer.page.reload.md

…

puppeteer.page.screenshot.md

…

puppeteer.page.select.md

…

puppeteer.page.setbypasscsp.md

…

puppeteer.page.setcacheenabled.md

…

puppeteer.page.setcontent.md

…

puppeteer.page.setcookie.md

…

puppeteer.page.setdefaultnavigationtimeout.md

…

puppeteer.page.setdefaulttimeout.md

…

puppeteer.page.setextrahttpheaders.md

…

puppeteer.page.setgeolocation.md

…

puppeteer.page.setjavascriptenabled.md

…

puppeteer.page.setofflinemode.md

…

puppeteer.page.setrequestinterception.md

…

puppeteer.page.setuseragent.md

…

puppeteer.page.setviewport.md

…

puppeteer.page.tap.md

…

puppeteer.page.target.md

…

puppeteer.page.title.md

…

puppeteer.page.touchscreen.md

…

puppeteer.page.tracing.md

…

puppeteer.page.type.md

…

puppeteer.page.url.md

…

puppeteer.page.viewport.md

…

puppeteer.page.waitfor.md

…

puppeteer.page.waitforfilechooser.md

…

puppeteer.page.waitforfunction.md

…

puppeteer.page.waitfornavigation.md

…

puppeteer.page.waitforrequest.md

…

puppeteer.page.waitforresponse.md

…

puppeteer.page.waitforselector.md

…

puppeteer.page.waitforxpath.md

…

puppeteer.page.workers.md

…

puppeteer.pageemittedevents.md

docs(new): start documenting the Page class (#6001)

2020-06-12 11:10:12 +01:00

puppeteer.puppeteer.__experimental_clearqueryhandlers.md

…

puppeteer.puppeteer.__experimental_customqueryhandlers.md

…

puppeteer.puppeteer.__experimental_registercustomqueryhandler.md

…

puppeteer.puppeteer.__experimental_unregistercustomqueryhandler.md

…

puppeteer.puppeteer.__productname.md

…

puppeteer.puppeteer._changedproduct.md

…

puppeteer.puppeteer._constructor_.md

…

puppeteer.puppeteer._ispuppeteercore.md

…

puppeteer.puppeteer._launcher.md

…

puppeteer.puppeteer._lazylauncher.md

…

puppeteer.puppeteer._preferredrevision.md

…

puppeteer.puppeteer._productname.md

…

puppeteer.puppeteer._projectroot.md

…

puppeteer.puppeteer.connect.md

…

puppeteer.puppeteer.createbrowserfetcher.md

…

puppeteer.puppeteer.defaultargs.md

…

puppeteer.puppeteer.devices.md

…

puppeteer.puppeteer.errors.md

…

puppeteer.puppeteer.executablepath.md

…

puppeteer.puppeteer.launch.md

…

puppeteer.puppeteer.md

…

puppeteer.puppeteer.product.md

…

puppeteer.puppeteererrors.md

…

puppeteer.securitydetails._constructor_.md

…

puppeteer.securitydetails.issuer.md

…

puppeteer.securitydetails.md

chore: commit base new-docs (#5973)

2020-06-04 15:56:45 +01:00

puppeteer.securitydetails.protocol.md

…

puppeteer.securitydetails.subjectalternativenames.md

…

puppeteer.securitydetails.subjectname.md

…

puppeteer.securitydetails.validfrom.md

…

puppeteer.securitydetails.validto.md

…

puppeteer.serializedaxnode.autocomplete.md

…

puppeteer.serializedaxnode.checked.md

…

puppeteer.serializedaxnode.children.md

…

puppeteer.serializedaxnode.description.md

…

puppeteer.serializedaxnode.disabled.md

…

puppeteer.serializedaxnode.expanded.md

…

puppeteer.serializedaxnode.focused.md

…

puppeteer.serializedaxnode.haspopup.md

…

puppeteer.serializedaxnode.invalid.md

…

puppeteer.serializedaxnode.keyshortcuts.md

…

puppeteer.serializedaxnode.level.md

…

puppeteer.serializedaxnode.md

…

puppeteer.serializedaxnode.modal.md

…

puppeteer.serializedaxnode.multiline.md

…

puppeteer.serializedaxnode.multiselectable.md

…

puppeteer.serializedaxnode.name.md

…

puppeteer.serializedaxnode.orientation.md

…

puppeteer.serializedaxnode.pressed.md

…

puppeteer.serializedaxnode.readonly.md

…

puppeteer.serializedaxnode.required.md

…

puppeteer.serializedaxnode.role.md

…

puppeteer.serializedaxnode.roledescription.md

…

puppeteer.serializedaxnode.selected.md

…

puppeteer.serializedaxnode.value.md

…

puppeteer.serializedaxnode.valuemax.md

…

puppeteer.serializedaxnode.valuemin.md

…

puppeteer.serializedaxnode.valuetext.md

…

puppeteer.snapshotoptions.interestingonly.md

…

puppeteer.snapshotoptions.md

…

puppeteer.snapshotoptions.root.md

…

puppeteer.target._browsercontext.md

…

puppeteer.target._closedcallback.md

…

puppeteer.target._constructor_.md

…

puppeteer.target._defaultviewport.md

…

puppeteer.target._ignorehttpserrors.md

…

puppeteer.target._initializedcallback.md

…

puppeteer.target._initializedpromise.md

…

puppeteer.target._isclosedpromise.md

…

puppeteer.target._isinitialized.md

…

puppeteer.target._pagepromise.md

…

puppeteer.target._sessionfactory.md

…

puppeteer.target._targetid.md

…

puppeteer.target._targetinfo.md

…

puppeteer.target._targetinfochanged.md

…

puppeteer.target._workerpromise.md

…

puppeteer.target.browser.md

…

puppeteer.target.browsercontext.md

…

puppeteer.target.createcdpsession.md

…

puppeteer.target.md

…

puppeteer.target.opener.md

…

puppeteer.target.page.md

…

puppeteer.target.type.md

…

puppeteer.target.url.md

…

puppeteer.target.worker.md

…

puppeteer.timeouterror.md

…

puppeteer.touchscreen._client.md

…

puppeteer.touchscreen._constructor_.md

…

puppeteer.touchscreen._keyboard.md

…

puppeteer.touchscreen.md

…

puppeteer.touchscreen.tap.md

…

puppeteer.tracing._client.md

…

puppeteer.tracing._constructor_.md

…

puppeteer.tracing._path.md

…

puppeteer.tracing._recording.md

…

puppeteer.tracing.md

…

puppeteer.tracing.start.md

…

puppeteer.tracing.stop.md

…

puppeteer.webworker._client.md

…

puppeteer.webworker._constructor_.md

…

puppeteer.webworker._executioncontextcallback.md

…

puppeteer.webworker._executioncontextpromise.md

…

puppeteer.webworker._url.md

…

puppeteer.webworker.evaluate.md

…

puppeteer.webworker.evaluatehandle.md

…

puppeteer.webworker.executioncontext.md

…

puppeteer.webworker.md

…

puppeteer.webworker.url.md

…