Typedef

Static Public Summary
public	BoxModel: Object
public	BrowserHistogramQuery: Object
public	BrowserInitOptions: Object
public	CDPAnimation: Object
public	CDPAnimationEffect: Object
public	CDPBucket: Object
public	CDPCookie: Object
public	CDPDatabase: Object
public	CDPFrameResource: Object
public	CDPFrameResourceTree: Object
public	CDPHistogram: Object
public	CDPKeyframeStyle: Object
public	CDPKeyframesRule: Object
public	CDPLogEntry: Object
public	CDPNavigationEntry: Object
public	CDPSecurityDetails: Object
public	CDPServiceWorkerErrorMessage: Object
public	CDPServiceWorkerRegistration: Object
public	CDPServiceWorkerVersion: Object
public	CDPSignedCertificateTimestamp: Object
public	CDPTargetInfo: Object
public	CRIOptions: Object
public	ConnectionTypes: Chrome \| CRIConnection \| CDPSession \| Object
public	ConsoleMessage.Location: Object
public	ConsoleMessageArgsInit: Object
public	CookieParam: Object
public	CookieToBeDeleted: Object
public	CoverageEntry: Object
public	DOMRGBA: Object
public	Device: Object
public	DeviceDescriptorViewPort: Object
public	EnabledExtras: Object
public	GetEncodedResponseArgs: Object
public	GetEncodedResponseResults: Object
public	KeyDefinition: Object
public	KeyDescription: Object
public	Metrics: Object
public	ModifyCookieParam: Object
public	NetIdleOptions: Object
public	NetworkConditions: Object
public	PDFOptions: Object
public	PageInitOptions: Object
public	SQLQueryResults: Object
public	ScreenshotOptions: Object
public	SerializedAXNode: Object
public	ServiceWorkerInfo: Object
public	TargetInit: Object
public	UserAgentOverride: Object
public	Viewport: Object
public	WindowBounds: Object

Static Public

public BoxModel: Object source

Properties:

Name	Type	Attribute	Description
content	Array<{x: number, y: number}>
padding	Array<{x: number, y: number}>
border	Array<{x: number, y: number}>
margin	Array<{x: number, y: number}>
width	number
height	number

public BrowserHistogramQuery: Object source

Properties:

Name	Type	Attribute	Description
query	string	optional
delta	boolean	optional

public BrowserInitOptions: Object source

Properties:

Name	Type	Attribute	Description
process	Object	optional
contextIds	Array<string>	optional nullable: true
ignoreHTTPSErrors	boolean	optional nullable: true
defaultViewport	Object	optional nullable: true
closeCallback	function(): Promise	optional nullable: true
additionalDomains	EnabledExtras	optional nullable: true
browserWSEndpoint	string	optional nullable: true

public CDPAnimation: Object source

Properties:

Name	Type	Attribute	Description
id	string		`Animation`'s id.
name	string		`Animation`'s name.
pausedState	boolean		`Animation`'s internal paused state.
playState	string		`Animation`'s play state.
playbackRate	number		`Animation`'s playback rate.
startTime	number		`Animation`'s start time.
currentTime	number		`Animation`'s current time.
type	string		Animation type of `Animation`. Values: CSSTransition, CSSAnimation, WebAnimation
source	CDPAnimationEffect	optional	`Animation`'s source animation node.
cssId	string	optional	A unique ID for `Animation` representing the sources that triggered this CSS animation/transition.

public CDPAnimationEffect: Object source

Properties:

Name	Type	Attribute	Description
delay	number		`AnimationEffect`'s delay.
endDelay	number		`AnimationEffect`'s end delay.
iterationStart	number		`AnimationEffect`'s iteration start.
iterations	number		`AnimationEffect`'s iterations.
duration	number		`AnimationEffect`'s iteration duration.
direction	string		`AnimationEffect`'s playback direction.
fill	string		`AnimationEffect`'s fill mode.
backendNodeId	string	optional	`AnimationEffect`'s target node.
keyframesRule	CDPKeyframesRule	optional	`AnimationEffect`'s keyframes.
easing	string		`AnimationEffect`'s timing function.

public CDPBucket: Object source

Properties:

Name	Type	Attribute	Description
low	number		Minimum value (inclusive).
high	number		Maximum value (exclusive).
count	number		Number of samples.

public CDPCookie: Object source

Properties:

Name	Type	Attribute	Description
name	string	nullable: false
value	string	nullable: false
domain	string	optional nullable: true
path	string	optional nullable: true
expires	number	optional nullable: true
size	number	optional nullable: true
httpOnly	boolean	optional nullable: true
secure	boolean	optional nullable: true
session	boolean	optional nullable: true
sameSite	string	optional nullable: true

public CDPDatabase: Object source

Properties:

Name	Type	Attribute	Description
id	DatabaseId		Database ID.
domain	string		Database domain.
name	string		Database name.
version	string		Database version.

public CDPFrameResource: Object source

Properties:

Name	Type	Attribute	Description
url	string		Resource URL.
type	ResourceType		Type of this resource as it was perceived by the rendering engine. Values: Document, Stylesheet, Image, Media, Font, Script, TextTrack, XHR, Fetch, EventSource, WebSocket, Manifest, SignedExchange, Ping, CSPViolationReport, Other
mimeType	string		Resource mimeType as determined by the browser.
lastModified	number	optional	last-modified timestamp as reported by server.
contentSize	number	optional	Resource content size.
failed	boolean	optional	True if the resource failed to load.
canceled	boolean	optional	True if the resource was canceled during loading.

public CDPFrameResourceTree: Object source

Properties:

Name	Type	Attribute	Description
frame	Object		Frame information for this tree item.
childFrames	Array<CDPFrameResourceTree>	optional	Child frames.
resources	Array<CDPFrameResource>		Information about frame resources.

public CDPHistogram: Object source

Properties:

Name	Type	Attribute	Description
name	string		Name.
sum	number		Sum of sample values.
count	number		Total number of samples.
buckets	Array<CDPBucket>		Buckets.

public CDPKeyframeStyle: Object source

Properties:

Name	Type	Attribute	Description
offset	string		Keyframe's time offset.
easing	string		`AnimationEffect`'s timing function.

public CDPKeyframesRule: Object source

Properties:

Name	Type	Attribute	Description
name	string	optional	CSS keyframed animation's name.
keyframes	Array<CDPKeyframeStyle>		List of animation keyframes.

public CDPLogEntry: Object source

Properties:

Name	Type	Attribute	Description
source	string		Log entry source. Values: xml, javascript, network, storage, appcache, rendering, security, deprecation, worker, violation, intervention, recommendation, other
level	string		Log entry severity. Values: verbose, info, warning, error
text	string		Logged text.
timestamp	number		Timestamp when this entry was added.
url	string	optional	URL of the resource if known.
lineNumber	number	optional	Line number in the resource.
stackTrace	Object	optional	JavaScript stack trace.
networkRequestId	string	optional	Identifier of the network request associated with this entry.
workerId	string	optional	Identifier of the worker associated with this entry.
args	Array<Object>	optional	Call arguments.

public CDPNavigationEntry: Object source

Properties:

Name	Type	Attribute	Description
id	number		Unique id of the navigation history entry.
url	string		URL of the navigation history entry.
userTypedURL	string		URL that the user typed in the url bar.
title	string		Title of the navigation history entry.
transitionType	string		Transition type - values: ink, typed, address_bar, auto_bookmark, auto_subframe, manual_subframe, generated, auto_toplevel, form_submit, reload, keyword, keyword_generated, other

public CDPSecurityDetails: Object source

Properties:

Name	Type	Attribute	Description
protocol	string		Protocol name (e.g. "TLS 1.2" or "QUIC").
keyExchange	string		Key Exchange used by the connection, or the empty string if not applicable.
keyExchangeGroup	string	optional	(EC)DH group used by the connection, if applicable.
cipher	string		Cipher name.
mac	string	optional	TLS MAC. Note that AEAD ciphers do not have separate MACs.
certificateId	string		Certificate ID value.
subjectName	string		Certificate subject name.
sanList	Array<string>		Subject Alternative Name (SAN) DNS names and IP addresses.
issuer	string		Name of the issuing CA.
validFrom	number		Certificate valid from date.
validTo	number		Certificate valid to (expiration) date
signedCertificateTimestampList	Array<CDPSignedCertificateTimestamp>		List of signed certificate timestamps (SCTs).
certificateTransparencyCompliance	string		Whether the request complied with Certificate Transparency policy. Values: unknown, not-compliant, compliant

public CDPServiceWorkerErrorMessage: Object source

Properties:

Name	Type	Attribute	Description
errorMessage	string
registrationId	string
versionId	string
sourceURL	string
lineNumber	number
columnNumber	number

public CDPServiceWorkerRegistration: Object source

Properties:

Name	Type	Attribute	Description
registrationId	string
scopeURL	string
isDeleted	boolean

public CDPServiceWorkerVersion: Object source

Properties:

Name	Type	Attribute	Description
versionId	string
registrationId	string
scriptURL	string
runningStatus	string		values: stopped, starting, running, stopping
status	string		values: new, installing, installed, activating, activated, redundant
scriptLastModified	number	optional	The Last-Modified header value of the main script.
scriptResponseTime	number	optional	The time at which the response headers of the main script were received from the server. For cached script it is the last time the cache entry was validated.
controlledClients	Array<string>	optional
targetId	string	optional

public CDPSignedCertificateTimestamp: Object source

Properties:

Name	Type	Attribute	Description
status	string		Validation status.
origin	string		Origin.
logDescription	string		Log name / description.
logId	string		Log ID.
timestamp	string		Issuance date.
hashAlgorithm	string		Hash algorithm.
signatureAlgorithm	string		Signature algorithm.
signatureData	string		Signature data.

public CDPTargetInfo: Object source

Properties:

Name	Type	Attribute	Description
targetId	string
type	string
title	string
url	string
attached	boolean		Whether the target has an attached client.
openerId	string	optional	Opener target Id
browserContextId	string	optional	EXPERIMENTAL

public CRIOptions: Object source

Properties:

Name	Type	Attribute	Description
host	string	optional nullable: true	HTTP frontend host. Defaults to localhost
port	number	optional nullable: true	HTTP frontend port. Defaults to 9222
secure	boolean	optional nullable: true	HTTPS/WSS frontend. Defaults to false
useHostName	boolean	optional nullable: true	do not perform a DNS lookup of the host. Defaults to false
target	function \| object \| string	optional nullable: true	determines which target this client should attach to. The behavior changes according to the type a function that takes the array returned by the List method and returns a target or its numeric index relative to the array a target object like those returned by the New and List methods a string representing the raw WebSocket URL, in this case host and port are not used to fetch the target list, yet they are used to complete the URL if relative a string representing the target id Defaults to a function which returns the first available target according to the implementation (note that at most one connection can be established to the same target)
protocol	Object	optional nullable: true	Chrome Debugging Protocol descriptor object. Defaults to use the protocol chosen according to the local option
local	boolean	optional nullable: true	boolean indicating whether the protocol must be fetched remotely or if the local version must be used. It has no effect if the protocol option is set. Defaults to false

public ConnectionTypes: Chrome | CRIConnection | CDPSession | Object source

public ConsoleMessage.Location: Object source

Properties:

Name	Type	Attribute	Description
url	string
lineNumber	number
columnNumber	number

public ConsoleMessageArgsInit: Object source

Properties:

Name	Type	Attribute	Description
context	ExecutionContext	optional nullable: true
jsHandleFactory	function(arg: Object): JSHandle	optional nullable: true

public CookieParam: Object source

Properties:

Name	Type	Attribute	Description
name	string	nullable: false
value	string	nullable: false
url	string	optional nullable: true
domain	string	optional nullable: true
path	string	optional nullable: true
expires	number	optional nullable: true
httpOnly	boolean	optional nullable: true
secure	boolean	optional nullable: true
sameSite	string	optional nullable: true

public CookieToBeDeleted: Object source

Properties:

Name	Type	Attribute	Description
name	string
url	string	optional nullable: true
domain	string	optional nullable: true
path	string	optional nullable: true

public CoverageEntry: Object source

Properties:

Name	Type	Attribute	Description
url	string
text	string
ranges	Array<{start: number, end: number}>

public DOMRGBA: Object source

Properties:

Name	Type	Attribute	Description
r	number
g	number
b	number
a	number	optional nullable: true

public Device: Object source

Properties:

Name	Type	Attribute	Description
name	string	nullable: false
userAgent	string	nullable: false
viewPort	DeviceDescriptorViewPort	nullable: false

public DeviceDescriptorViewPort: Object source

Properties:

Name	Type	Attribute	Description
width	number	nullable: false
height	number	nullable: false
deviceScaleFactor	number	nullable: false
isMobile	boolean	nullable: false
hasTouch	boolean	nullable: false
isLandscape	boolean	nullable: false

public EnabledExtras: Object source

Properties:

Name	Type	Attribute	Description
animation	boolean	optional default: false nullable: true
console	boolean	optional default: false nullable: true
coverage	boolean	optional default: false nullable: true
database	boolean	optional default: false nullable: true
log	boolean	optional default: false nullable: true
performance	boolean	optional default: false nullable: true
security	boolean	optional default: false nullable: true
serviceWorkers	boolean	optional default: false nullable: true
workers	boolean	optional default: false nullable: true

public GetEncodedResponseArgs: Object source

Properties:

Name	Type	Attribute	Description
requestId	string		Identifier of the network request to get content for
encoding	string		The encoding to use. Allowed values: webp, jpeg, png
quality	number	optional	The quality of the encoding (0-1). (defaults to 1)
sizeOnly	boolean	optional	Whether to only return the size information (defaults to false)

public GetEncodedResponseResults: Object source

Properties:

Name	Type	Attribute	Description
body	string	optional	The encoded body as a base64 string. Omitted if sizeOnly is true.
originalSize	number		Size before re-encoding
encodedSize	number		Size after re-encoding

public KeyDefinition: Object source

Properties:

Name	Type	Attribute	Description
keyCode	number
shiftKeyCode	number
key	string
shiftKey	string
code	string
text	string
shiftText	string
location	number

public KeyDescription: Object source

Properties:

Name	Type	Attribute	Description
keyCode	number
key	string
text	string
code	string
location	number

public Metrics: Object source

Properties:

Name	Type	Attribute	Description
Timestamp	number
Documents	number
Frames	number
JSEventListeners	number
Nodes	number
LayoutCount	number
RecalcStyleCount	number
LayoutDuration	number
RecalcStyleDuration	number
ScriptDuration	number
TaskDuration	number
JSHeapUsedSize	number
JSHeapTotalSize	number

public ModifyCookieParam: Object source

Properties:

Name	Type	Attribute	Description
name	string	nullable: true
value	string	nullable: true
url	string	nullable: true
domain	string	nullable: true
path	string	nullable: true
expires	number	nullable: true
httpOnly	boolean	nullable: true
secure	boolean	nullable: true
sameSite	string	nullable: true

public NetIdleOptions: Object source

Properties:

Name	Type	Attribute	Description
globalWait	number	optional default: 40000	Maximum amount of time, in milliseconds, to wait for network idle to occur
numInflight	number	optional default: 2	The number of inflight requests (requests with no response) that should exist before starting the inflightIdle timer
inflightIdle	number	optional default: 1500	Amount of time, in milliseconds, that should elapse when there are only numInflight requests for network idle to be determined

public NetworkConditions: Object source

Properties:

Name	Type	Attribute	Description
offline	boolean
latency	number
downloadThroughput	number
{number}uploadThroughput	*
connectionType	string	optional nullable: true

public PDFOptions: Object source

Properties:

Name	Type	Attribute	Description
scale	number
displayHeaderFooter	boolean
headerTemplate	string
footerTemplate	string
printBackground	boolean
landscape	boolean
pageRanges	string
format	string
width	string \| number
height	string \| number
preferCSSPageSize	boolean	optional
margin	{top?: string\|number, bottom?: string\|number, left?: string\|number, right?: string\|number}	optional nullable: false
path	string	optional

public PageInitOptions: Object source

Properties:

Name	Type	Attribute	Description
ignoreHTTPSErrors	boolean	optional
target	Target	optional nullable: true
defaultViewPort	Object	optional nullable: true
screenshotTaskQueue	TaskQueue	optional nullable: true
additionalDomains	EnabledExtras	optional nullable: true

public SQLQueryResults: Object source

Properties:

Name	Type	Attribute	Description
columnNames	Array<string>	optional
values	Array<string>	optional
sqlError	{message: string, code: number}	optional

public ScreenshotOptions: Object source

Properties:

Name	Type	Attribute	Description
type	string
path	string
fullPage	boolean
clip	{x: number, y: number, width: number, height: number}
quality	number
omitBackground	boolean
encoding	string

public SerializedAXNode: Object source

Properties:

Name	Type	Attribute	Description
role	string
name	string
value	string \| number
description	string
keyshortcuts	string
roledescription	string
valuetext	string
disabled	boolean
expanded	boolean
focused	boolean
modal	boolean
multiline	boolean
multiselectable	boolean
readonly	boolean
required	boolean
selected	boolean
checked	boolean \| "mixed"
pressed	boolean \| "mixed"
level	number
valuemin	number
valuemax	number
autocomplete	string
haspopup	string
invalid	string
orientation	string
children	Array<SerializedAXNode>

public ServiceWorkerInfo: Object source

Properties:

Name	Type	Attribute	Description
versionId	string
registrationId	string
scopeURL	string
isDeleted	boolean
runningStatus	string		stopped, starting, running, stopping
status	string		new, installing, installed, activating, activated, redundant
scriptLastModified	number	optional	The Last-Modified header value of the main script.
scriptResponseTime	number	optional	The time at which the response headers of the main script were received from the server. For cached script it is the last time the cache entry was validated.
controlledClients	Array<string>	optional
targetId	string	optional

public TargetInit: Object source

Properties:

Name	Type	Attribute	Description
targetInfo	Object
browserContext	BrowserContext	optional nullable: true
sessionFactory	function(): Promise<CDPSession>	optional nullable: true
pageOpts	PageInitOptions	optional nullable: true
client	Chrome \| CDPSession \| CRIConnection	optional

public UserAgentOverride: Object source

Properties:

Name	Type	Attribute	Description
userAgent	string
acceptLanguage	string	optional nullable: true
platform	string	optional nullable: true

public Viewport: Object source

Properties:

Name	Type	Attribute	Description
width	number
height	number
deviceScaleFactor	number	optional
isMobile	boolean	optional
isLandscape	boolean	optional
hasTouch	boolean	optional

public WindowBounds: Object source

Properties:

Name	Type	Attribute	Description
left	number	optional	The offset from the left edge of the screen to the window in pixels.
top	number	optional	The offset from the top edge of the screen to the window in pixels.
width	number	optional	The window width in pixels.
height	number	optional	The window height in pixels.
windowState	string	optional	The window state. Default to normal. Values: normal, minimized, maximized, fullscreen