puppeteer/new-docs/puppeteer.page.md
Jack Franklin 086c08998b
chore: commit base new-docs (#5973)
This adds the new docs that are generated by API Extractor via TSDoc.
They are sparse because we do not yet use TSDoc in the codebase. This is
the starting point and from here we can work through all the different
classes and improve the documentation.
2020-06-04 15:56:45 +01:00

8.7 KiB

Home > puppeteer > Page

Page class

Signature:

export declare class Page extends EventEmitter 

Constructors

Constructor Modifiers Description
(constructor)(client, target, ignoreHTTPSErrors) Constructs a new instance of the Page class

Properties

Property Modifiers Type Description
_accessibility Accessibility
_client CDPSession
_closed boolean
_coverage Coverage
_disconnectPromise Promise<Error>
_emulationManager EmulationManager
_fileChooserInterceptors Set<Function>
_frameManager FrameManager
_javascriptEnabled boolean
_keyboard Keyboard
_mouse Mouse
_pageBindings Map<string, Function>
_screenshotTaskQueue ScreenshotTaskQueue
_target Target
_timeoutSettings TimeoutSettings
_touchscreen Touchscreen
_tracing Tracing
_viewport Viewport | null
_workers Map<string, WebWorker>
accessibility Accessibility
coverage Coverage
keyboard Keyboard
mouse Mouse
touchscreen Touchscreen
tracing Tracing

Methods

Method Modifiers Description
_addConsoleMessage(type, args, stackTrace)
_buildMetricsObject(metrics)
_emitMetrics(event)
_go(delta, options)
_handleException(exceptionDetails)
_initialize()
_onBindingCalled(event)
_onConsoleAPI(event)
_onDialog(event)
_onFileChooser(event)
_onLogEntryAdded(event)
_onTargetCrashed()
_screenshotTask(format, options)
_sessionClosePromise()
$(selector)
$$(selector)
$$eval(selector, pageFunction, args)
$eval(selector, pageFunction, args)
$x(expression)
addScriptTag(options)
addStyleTag(options)
authenticate(credentials)
bringToFront()
browser()
browserContext()
click(selector, options)
close(options)
content()
cookies(urls)
create(client, target, ignoreHTTPSErrors, defaultViewport) static
deleteCookie(cookies)
emulate(options)
emulateMediaFeatures(features)
emulateMediaType(type)
emulateTimezone(timezoneId)
emulateVisionDeficiency(type)
evaluate(pageFunction, args)
evaluateHandle(pageFunction, args)
evaluateOnNewDocument(pageFunction, args)
exposeFunction(name, puppeteerFunction)
focus(selector)
frames()
goBack(options)
goForward(options)
goto(url, options)
hover(selector)
isClosed()
mainFrame()
metrics()
pdf(options)
queryObjects(prototypeHandle)
reload(options)
screenshot(options)
select(selector, values)
setBypassCSP(enabled)
setCacheEnabled(enabled)
setContent(html, options)
setCookie(cookies)
setDefaultNavigationTimeout(timeout)
setDefaultTimeout(timeout)
setExtraHTTPHeaders(headers)
setGeolocation(options)
setJavaScriptEnabled(enabled)
setOfflineMode(enabled)
setRequestInterception(value)
setUserAgent(userAgent)
setViewport(viewport)
tap(selector)
target()
title()
type(selector, text, options)
url()
viewport()
waitFor(selectorOrFunctionOrTimeout, options, args)
waitForFileChooser(options)
waitForFunction(pageFunction, options, args)
waitForNavigation(options)
waitForRequest(urlOrPredicate, options)
waitForResponse(urlOrPredicate, options)
waitForSelector(selector, options)
waitForXPath(xpath, options)
workers()