Google Git
Sign in
webkit / WebKit / 5549cdc34b021e0f42036a79dc545fd3130e6d99 / . / Source / WebInspectorUI / Versions / Inspector-iOS-11.0.json
blob: d69673e71faec70d6c09866bc5952767041b739e [file] [log] [blame]
{"domains":[
{
"domain": "ApplicationCache",
"availability": ["web"],
"types": [
{
"id": "ApplicationCacheResource",
"type": "object",
"description": "Detailed application cache resource information.",
"properties": [
{ "name": "url", "type": "string", "description": "Resource url." },
{ "name": "size", "type": "integer", "description": "Resource size." },
{ "name": "type", "type": "string", "description": "Resource type." }
]
},
{
"id": "ApplicationCache",
"type": "object",
"description": "Detailed application cache information.",
"properties": [
{ "name": "manifestURL", "type": "string", "description": "Manifest URL." },
{ "name": "size", "type": "number", "description": "Application cache size." },
{ "name": "creationTime", "type": "number", "description": "Application cache creation time." },
{ "name": "updateTime", "type": "number", "description": "Application cache update time." },
{ "name": "resources", "type": "array", "items": { "$ref": "ApplicationCacheResource" }, "description": "Application cache resources." }
]
},
{
"id": "FrameWithManifest",
"type": "object",
"description": "Frame identifier - manifest URL pair.",
"properties": [
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Frame identifier." },
{ "name": "manifestURL", "type": "string", "description": "Manifest URL." },
{ "name": "status", "type": "integer", "description": "Application cache status." }
]
}
],
"commands": [
{
"name": "getFramesWithManifests",
"description": "Returns array of frame identifiers with manifest urls for each frame containing a document associated with some application cache.",
"returns": [
{ "name": "frameIds", "type": "array", "items": { "$ref": "FrameWithManifest" }, "description": "Array of frame identifiers with manifest urls for each frame containing a document associated with some application cache." }
]
},
{
"name": "enable",
"description": "Enables application cache domain notifications."
},
{
"name": "getManifestForFrame",
"description": "Returns manifest URL for document in the given frame.",
"parameters": [
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Identifier of the frame containing document whose manifest is retrieved." }
],
"returns": [
{ "name": "manifestURL", "type": "string", "description": "Manifest URL for document in the given frame." }
]
},
{
"name": "getApplicationCacheForFrame",
"description": "Returns relevant application cache data for the document in given frame.",
"parameters": [
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Identifier of the frame containing document whose application cache is retrieved." }
],
"returns": [
{ "name": "applicationCache", "$ref": "ApplicationCache", "description": "Relevant application cache data for the document in given frame." }
]
}
],
"events": [
{
"name": "applicationCacheStatusUpdated",
"parameters": [
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Identifier of the frame containing document whose application cache updated status." },
{ "name": "manifestURL", "type": "string", "description": "Manifest URL." },
{ "name": "status", "type": "integer", "description": "Updated application cache status." }
]
},
{
"name": "networkStateUpdated",
"parameters": [
{ "name": "isNowOnline", "type": "boolean" }
]
}
]
}
,
{
"domain": "CSS",
"description": "This domain exposes CSS read/write operations. All CSS objects, like stylesheets, rules, and styles, have an associated <code>id</code> used in subsequent operations on the related object. Each object type has a specific <code>id</code> structure, and those are not interchangeable between objects of different kinds. CSS objects can be loaded using the <code>get*ForNode()</code> calls (which accept a DOM node id). Alternatively, a client can discover all the existing stylesheets with the <code>getAllStyleSheets()</code> method and subsequently load the required stylesheet contents using the <code>getStyleSheet[Text]()</code> methods.",
"availability": ["web"],
"types": [
{
"id": "StyleSheetId",
"type": "string"
},
{
"id": "CSSStyleId",
"type": "object",
"description": "This object identifies a CSS style in a unique way.",
"properties": [
{ "name": "styleSheetId", "$ref": "StyleSheetId", "description": "Enclosing stylesheet identifier." },
{ "name": "ordinal", "type": "integer", "description": "The style ordinal within the stylesheet." }
]
},
{
"id": "StyleSheetOrigin",
"type": "string",
"enum": ["user", "user-agent", "inspector", "regular"],
"description": "Stylesheet type: \"user\" for user stylesheets, \"user-agent\" for user-agent stylesheets, \"inspector\" for stylesheets created by the inspector (i.e. those holding the \"via inspector\" rules), \"regular\" for regular stylesheets."
},
{
"id": "CSSRuleId",
"type": "object",
"description": "This object identifies a CSS rule in a unique way.",
"properties": [
{ "name": "styleSheetId", "$ref": "StyleSheetId", "description": "Enclosing stylesheet identifier." },
{ "name": "ordinal", "type": "integer", "description": "The rule ordinal within the stylesheet." }
]
},
{
"id": "PseudoIdMatches",
"type": "object",
"description": "CSS rule collection for a single pseudo style.",
"properties": [
{ "name": "pseudoId", "type": "integer", "description": "Pseudo style identifier (see <code>enum PseudoId</code> in <code>RenderStyleConstants.h</code>)."},
{ "name": "matches", "type": "array", "items": { "$ref": "RuleMatch" }, "description": "Matches of CSS rules applicable to the pseudo style."}
]
},
{
"id": "InheritedStyleEntry",
"type": "object",
"description": "CSS rule collection for a single pseudo style.",
"properties": [
{ "name": "inlineStyle", "$ref": "CSSStyle", "optional": true, "description": "The ancestor node's inline style, if any, in the style inheritance chain." },
{ "name": "matchedCSSRules", "type": "array", "items": { "$ref": "RuleMatch" }, "description": "Matches of CSS rules matching the ancestor node in the style inheritance chain." }
]
},
{
"id": "RuleMatch",
"type": "object",
"description": "Match data for a CSS rule.",
"properties": [
{ "name": "rule", "$ref": "CSSRule", "description": "CSS rule in the match." },
{ "name": "matchingSelectors", "type": "array", "items": { "type": "integer" }, "description": "Matching selector indices in the rule's selectorList selectors (0-based)." }
]
},
{
"id": "CSSSelector",
"type": "object",
"description": "CSS selector.",
"properties": [
{ "name": "text", "type": "string", "description": "Canonicalized selector text." },
{ "name": "specificity", "optional": true, "type": "array", "items": { "type": "integer" }, "description": "Specificity (a, b, c) tuple. Included if the selector is sent in response to CSS.getMatchedStylesForNode which provides a context element." },
{ "name": "dynamic", "optional": true, "type": "boolean", "description": "Whether or not the specificity can be dynamic. Included if the selector is sent in response to CSS.getMatchedStylesForNode which provides a context element." }
]
},
{
"id": "SelectorList",
"type": "object",
"description": "Selector list data.",
"properties": [
{ "name": "selectors", "type": "array", "items": { "$ref": "CSSSelector" }, "description": "Selectors in the list." },
{ "name": "text", "type": "string", "description": "Rule selector text." },
{ "name": "range", "$ref": "SourceRange", "optional": true, "description": "Rule selector range in the underlying resource (if available)." }
]
},
{
"id": "CSSStyleAttribute",
"type": "object",
"description": "CSS style information for a DOM style attribute.",
"properties": [
{ "name": "name", "type": "string", "description": "DOM attribute name (e.g. \"width\")."},
{ "name": "style", "$ref": "CSSStyle", "description": "CSS style generated by the respective DOM attribute."}
]
},
{
"id": "CSSStyleSheetHeader",
"type": "object",
"description": "CSS stylesheet meta-information.",
"properties": [
{ "name": "styleSheetId", "$ref": "StyleSheetId", "description": "The stylesheet identifier."},
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Owner frame identifier."},
{ "name": "sourceURL", "type": "string", "description": "Stylesheet resource URL."},
{ "name": "origin", "$ref": "StyleSheetOrigin", "description": "Stylesheet origin."},
{ "name": "title", "type": "string", "description": "Stylesheet title."},
{ "name": "disabled", "type": "boolean", "description": "Denotes whether the stylesheet is disabled."},
{ "name": "isInline", "type": "boolean", "description": "Whether this stylesheet is a <style> tag created by the parser. This is not set for document.written <style> tags." },
{ "name": "startLine", "type": "number", "description": "Line offset of the stylesheet within the resource (zero based)." },
{ "name": "startColumn", "type": "number", "description": "Column offset of the stylesheet within the resource (zero based)." }
]
},
{
"id": "CSSStyleSheetBody",
"type": "object",
"description": "CSS stylesheet contents.",
"properties": [
{ "name": "styleSheetId", "$ref": "StyleSheetId", "description": "The stylesheet identifier."},
{ "name": "rules", "type": "array", "items": { "$ref": "CSSRule" }, "description": "Stylesheet resource URL."},
{ "name": "text", "type": "string", "optional": true, "description": "Stylesheet resource contents (if available)."}
]
},
{
"id": "CSSRule",
"type": "object",
"description": "CSS rule representation.",
"properties": [
{ "name": "ruleId", "$ref": "CSSRuleId", "optional": true, "description": "The CSS rule identifier (absent for user agent stylesheet and user-specified stylesheet rules)."},
{ "name": "selectorList", "$ref": "SelectorList", "description": "Rule selector data." },
{ "name": "sourceURL", "type": "string", "optional": true, "description": "Parent stylesheet resource URL (for regular rules)."},
{ "name": "sourceLine", "type": "integer", "description": "Line ordinal of the rule selector start character in the resource."},
{ "name": "origin", "$ref": "StyleSheetOrigin", "description": "Parent stylesheet's origin."},
{ "name": "style", "$ref": "CSSStyle", "description": "Associated style declaration." },
{ "name": "media", "type": "array", "items": { "$ref": "CSSMedia" }, "optional": true, "description": "Media list array (for rules involving media queries). The array enumerates media queries starting with the innermost one, going outwards." }
]
},
{
"id": "SourceRange",
"type": "object",
"description": "Text range within a resource.",
"properties": [
{ "name": "startLine", "type": "integer", "description": "Start line of range." },
{ "name": "startColumn", "type": "integer", "description": "Start column of range (inclusive)." },
{ "name": "endLine", "type": "integer", "description": "End line of range" },
{ "name": "endColumn", "type": "integer", "description": "End column of range (exclusive)." }
]
},
{
"id": "ShorthandEntry",
"type": "object",
"properties": [
{ "name": "name", "type": "string", "description": "Shorthand name." },
{ "name": "value", "type": "string", "description": "Shorthand value." }
]
},
{
"id": "CSSPropertyInfo",
"type": "object",
"properties": [
{ "name": "name", "type": "string", "description": "Property name." },
{ "name": "longhands", "type": "array", "optional": true, "items": { "type": "string" }, "description": "Longhand property names." },
{ "name": "values", "type": "array", "optional": true, "items": { "type": "string" }, "description": "Supported values for this property." }
]
},
{
"id": "CSSComputedStyleProperty",
"type": "object",
"properties": [
{ "name": "name", "type": "string", "description": "Computed style property name." },
{ "name": "value", "type": "string", "description": "Computed style property value." }
]
},
{
"id": "CSSStyle",
"type": "object",
"description": "CSS style representation.",
"properties": [
{ "name": "styleId", "$ref": "CSSStyleId", "optional": true, "description": "The CSS style identifier (absent for attribute styles)." },
{ "name": "cssProperties", "type": "array", "items": { "$ref": "CSSProperty" }, "description": "CSS properties in the style." },
{ "name": "shorthandEntries", "type": "array", "items": { "$ref": "ShorthandEntry" }, "description": "Computed values for all shorthands found in the style." },
{ "name": "cssText", "type": "string", "optional": true, "description": "Style declaration text (if available)." },
{ "name": "range", "$ref": "SourceRange", "optional": true, "description": "Style declaration range in the enclosing stylesheet (if available)." },
{ "name": "width", "type": "string", "optional": true, "description": "The effective \"width\" property value from this style." },
{ "name": "height", "type": "string", "optional": true, "description": "The effective \"height\" property value from this style." }
]
},
{
"id": "CSSPropertyStatus",
"type": "string",
"enum": ["active", "inactive", "disabled", "style"],
"description": "The property status: \"active\" if the property is effective in the style, \"inactive\" if the property is overridden by a same-named property in this style later on, \"disabled\" if the property is disabled by the user, \"style\" (implied if absent) if the property is reported by the browser rather than by the CSS source parser."
},
{
"id": "CSSProperty",
"type": "object",
"description": "CSS style effective visual dimensions and source offsets.",
"properties": [
{ "name": "name", "type": "string", "description": "The property name." },
{ "name": "value", "type": "string", "description": "The property value." },
{ "name": "priority", "type": "string", "optional": true, "description": "The property priority (implies \"\" if absent)." },
{ "name": "implicit", "type": "boolean", "optional": true, "description": "Whether the property is implicit (implies <code>false</code> if absent)." },
{ "name": "text", "type": "string", "optional": true, "description": "The full property text as specified in the style." },
{ "name": "parsedOk", "type": "boolean", "optional": true, "description": "Whether the property is understood by the browser (implies <code>true</code> if absent)." },
{ "name": "status", "$ref": "CSSPropertyStatus", "optional": true, "description": "Whether the property is active or disabled." },
{ "name": "range", "$ref": "SourceRange", "optional": true, "description": "The entire property range in the enclosing style declaration (if available)." }
]
},
{
"id": "CSSMedia",
"type": "object",
"description": "CSS media query descriptor.",
"properties": [
{ "name": "text", "type": "string", "description": "Media query text." },
{ "name": "source", "type": "string", "enum": ["mediaRule", "importRule", "linkedSheet", "inlineSheet"], "description": "Source of the media query: \"mediaRule\" if specified by a @media rule, \"importRule\" if specified by an @import rule, \"linkedSheet\" if specified by a \"media\" attribute in a linked stylesheet's LINK tag, \"inlineSheet\" if specified by a \"media\" attribute in an inline stylesheet's STYLE tag." },
{ "name": "sourceURL", "type": "string", "optional": true, "description": "URL of the document containing the media query description." },
{ "name": "sourceLine", "type": "integer", "optional": true, "description": "Line in the document containing the media query (not defined for the \"stylesheet\" source)." }
]
},
{
"id": "Region",
"type": "object",
"description": "This object represents a region that flows from a Named Flow.",
"properties": [
{ "name": "regionOverset", "type": "string", "enum": ["overset", "fit", "empty"], "description": "The \"overset\" attribute of a Named Flow." },
{ "name": "nodeId", "$ref": "DOM.NodeId", "description": "The corresponding DOM node id." }
]
},
{
"id": "NamedFlow",
"type": "object",
"description": "This object represents a Named Flow.",
"properties": [
{ "name": "documentNodeId", "$ref": "DOM.NodeId", "description": "The document node id." },
{ "name": "name", "type": "string", "description": "Named Flow identifier." },
{ "name": "overset", "type": "boolean", "description": "The \"overset\" attribute of a Named Flow." },
{ "name": "content", "type": "array", "items": { "$ref": "DOM.NodeId" }, "description": "An array of nodes that flow into the Named Flow." },
{ "name": "regions", "type": "array", "items": { "$ref": "Region" }, "description": "An array of regions associated with the Named Flow." }
]
}
],
"commands": [
{
"name": "enable",
"description": "Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been enabled until the result of this command is received."
},
{
"name": "disable",
"description": "Disables the CSS agent for the given page."
},
{
"name": "getMatchedStylesForNode",
"description": "Returns requested styles for a DOM node identified by <code>nodeId</code>.",
"parameters": [
{ "name": "nodeId", "$ref": "DOM.NodeId" },
{ "name": "includePseudo", "type": "boolean", "optional": true, "description": "Whether to include pseudo styles (default: true)." },
{ "name": "includeInherited", "type": "boolean", "optional": true, "description": "Whether to include inherited styles (default: true)." }
],
"returns": [
{ "name": "matchedCSSRules", "type": "array", "items": { "$ref": "RuleMatch" }, "optional": true, "description": "CSS rules matching this node, from all applicable stylesheets." },
{ "name": "pseudoElements", "type": "array", "items": { "$ref": "PseudoIdMatches" }, "optional": true, "description": "Pseudo style matches for this node." },
{ "name": "inherited", "type": "array", "items": { "$ref": "InheritedStyleEntry" }, "optional": true, "description": "A chain of inherited styles (from the immediate node parent up to the DOM tree root)." }
]
},
{
"name": "getInlineStylesForNode",
"description": "Returns the styles defined inline (explicitly in the \"style\" attribute and implicitly, using DOM attributes) for a DOM node identified by <code>nodeId</code>.",
"parameters": [
{ "name": "nodeId", "$ref": "DOM.NodeId" }
],
"returns": [
{ "name": "inlineStyle", "$ref": "CSSStyle", "optional": true, "description": "Inline style for the specified DOM node." },
{ "name": "attributesStyle", "$ref": "CSSStyle", "optional": true, "description": "Attribute-defined element style (e.g. resulting from \"width=20 height=100%\")."}
]
},
{
"name": "getComputedStyleForNode",
"description": "Returns the computed style for a DOM node identified by <code>nodeId</code>.",
"parameters": [
{ "name": "nodeId", "$ref": "DOM.NodeId" }
],
"returns": [
{ "name": "computedStyle", "type": "array", "items": { "$ref": "CSSComputedStyleProperty" }, "description": "Computed style for the specified DOM node." }
]
},
{
"name": "getAllStyleSheets",
"description": "Returns metainfo entries for all known stylesheets.",
"returns": [
{ "name": "headers", "type": "array", "items": { "$ref": "CSSStyleSheetHeader" }, "description": "Descriptor entries for all available stylesheets." }
]
},
{
"name": "getStyleSheet",
"description": "Returns stylesheet data for the specified <code>styleSheetId</code>.",
"parameters": [
{ "name": "styleSheetId", "$ref": "StyleSheetId" }
],
"returns": [
{ "name": "styleSheet", "$ref": "CSSStyleSheetBody", "description": "Stylesheet contents for the specified <code>styleSheetId</code>." }
]
},
{
"name": "getStyleSheetText",
"description": "Returns the current textual content and the URL for a stylesheet.",
"parameters": [
{ "name": "styleSheetId", "$ref": "StyleSheetId" }
],
"returns": [
{ "name": "text", "type": "string", "description": "The stylesheet text." }
]
},
{
"name": "setStyleSheetText",
"description": "Sets the new stylesheet text, thereby invalidating all existing <code>CSSStyleId</code>'s and <code>CSSRuleId</code>'s contained by this stylesheet.",
"parameters": [
{ "name": "styleSheetId", "$ref": "StyleSheetId" },
{ "name": "text", "type": "string" }
]
},
{
"name": "setStyleText",
"description": "Sets the new <code>text</code> for the respective style.",
"parameters": [
{ "name": "styleId", "$ref": "CSSStyleId" },
{ "name": "text", "type": "string" }
],
"returns": [
{ "name": "style", "$ref": "CSSStyle", "description": "The resulting style after the text modification." }
]
},
{
"name": "setRuleSelector",
"description": "Modifies the rule selector.",
"parameters": [
{ "name": "ruleId", "$ref": "CSSRuleId" },
{ "name": "selector", "type": "string" }
],
"returns": [
{ "name": "rule", "$ref": "CSSRule", "description": "The resulting rule after the selector modification." }
]
},
{
"name": "createStyleSheet",
"description": "Creates a new special \"inspector\" stylesheet in the frame with given <code>frameId</code>.",
"parameters": [
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Identifier of the frame where the new \"inspector\" stylesheet should be created." }
],
"returns": [
{ "name": "styleSheetId", "$ref": "StyleSheetId", "description": "Identifier of the created \"inspector\" stylesheet." }
]
},
{
"name": "addRule",
"description": "Creates a new empty rule with the given <code>selector</code> in a stylesheet with given <code>styleSheetId</code>.",
"parameters": [
{ "name": "styleSheetId", "$ref": "StyleSheetId" },
{ "name": "selector", "type": "string" }
],
"returns": [
{ "name": "rule", "$ref": "CSSRule", "description": "The newly created rule." }
]
},
{
"name": "getSupportedCSSProperties",
"description": "Returns all supported CSS property names.",
"returns": [
{ "name": "cssProperties", "type": "array", "items": { "$ref": "CSSPropertyInfo" }, "description": "Supported property metainfo." }
]
},
{
"name": "getSupportedSystemFontFamilyNames",
"description": "Returns all supported system font family names.",
"returns": [
{ "name": "fontFamilyNames", "type": "array", "items": { "type": "string" }, "description": "Supported system font families." }
]
},
{
"name": "forcePseudoState",
"description": "Ensures that the given node will have specified pseudo-classes whenever its style is computed by the browser.",
"parameters": [
{ "name": "nodeId", "$ref": "DOM.NodeId", "description": "The element id for which to force the pseudo state." },
{ "name": "forcedPseudoClasses", "type": "array", "items": { "type": "string", "enum": ["active", "focus", "hover", "visited"] }, "description": "Element pseudo classes to force when computing the element's style." }
]
},
{
"name": "getNamedFlowCollection",
"description": "Returns the Named Flows from the document.",
"parameters": [
{ "name": "documentNodeId", "$ref": "DOM.NodeId", "description": "The document node id for which to get the Named Flow Collection." }
],
"returns": [
{ "name": "namedFlows", "type": "array", "items": { "$ref": "NamedFlow" }, "description": "An array containing the Named Flows in the document." }
]
}
],
"events": [
{
"name": "mediaQueryResultChanged",
"description": "Fires whenever a MediaQuery result changes (for example, after a browser window has been resized.) The current implementation considers only viewport-dependent media features."
},
{
"name": "styleSheetChanged",
"description": "Fired whenever a stylesheet is changed as a result of the client operation.",
"parameters": [
{ "name": "styleSheetId", "$ref": "StyleSheetId" }
]
},
{
"name": "styleSheetAdded",
"description": "Fired whenever an active document stylesheet is added.",
"parameters": [
{ "name": "header", "$ref": "CSSStyleSheetHeader", "description": "Added stylesheet metainfo." }
]
},
{
"name": "styleSheetRemoved",
"description": "Fired whenever an active document stylesheet is removed.",
"parameters": [
{ "name": "styleSheetId", "$ref": "StyleSheetId", "description": "Identifier of the removed stylesheet." }
]
},
{
"name": "namedFlowCreated",
"description": "Fires when a Named Flow is created.",
"parameters": [
{ "name": "namedFlow", "$ref": "NamedFlow", "description": "The new Named Flow." }
]
},
{
"name": "namedFlowRemoved",
"description": "Fires when a Named Flow is removed: has no associated content nodes and regions.",
"parameters": [
{ "name": "documentNodeId", "$ref": "DOM.NodeId", "description": "The document node id." },
{ "name": "flowName", "type": "string", "description": "Identifier of the removed Named Flow." }
]
},
{
"name": "regionOversetChanged",
"description": "Fires if any of the regionOverset values changed in a Named Flow's region chain.",
"parameters": [
{ "name": "namedFlow", "$ref": "NamedFlow", "description": "The Named Flow containing the regions whose regionOverset values changed." }
]
},
{
"name": "registeredNamedFlowContentElement",
"description": "Fires when a Named Flow's has been registered with a new content node.",
"parameters": [
{ "name": "documentNodeId", "$ref": "DOM.NodeId", "description": "The document node id." },
{ "name": "flowName", "type": "string", "description": "Named Flow identifier for which the new content element was registered." },
{ "name": "contentNodeId", "$ref": "DOM.NodeId", "description": "The node id of the registered content node." },
{ "name": "nextContentNodeId", "$ref": "DOM.NodeId", "description": "The node id of the element following the registered content node." }
]
},
{
"name": "unregisteredNamedFlowContentElement",
"description": "Fires when a Named Flow's has been registered with a new content node.",
"parameters": [
{ "name": "documentNodeId", "$ref": "DOM.NodeId", "description": "The document node id." },
{ "name": "flowName", "type": "string", "description": "Named Flow identifier for which the new content element was unregistered." },
{ "name": "contentNodeId", "$ref": "DOM.NodeId", "description": "The node id of the unregistered content node." }
]
}
]
}
,
{
"domain": "Console",
"description": "Console domain defines methods and events for interaction with the JavaScript console. Console collects messages created by means of the <a href='http://getfirebug.com/wiki/index.php/Console_API'>JavaScript Console API</a>. One needs to enable this domain using <code>enable</code> command in order to start receiving the console messages. Browser collects messages issued while console domain is not enabled as well and reports them using <code>messageAdded</code> notification upon enabling.",
"workerSupported": true,
"types": [
{
"id": "ConsoleMessage",
"type": "object",
"description": "Console message.",
"properties": [
{ "name": "source", "type": "string", "enum": ["xml", "javascript", "network", "console-api", "storage", "appcache", "rendering", "css", "security", "content-blocker", "other"], "description": "Message source." },
{ "name": "level", "type": "string", "enum": ["log", "info", "warning", "error", "debug"], "description": "Message severity." },
{ "name": "text", "type": "string", "description": "Message text." },
{ "name": "type", "type": "string", "optional": true, "enum": ["log", "dir", "dirxml", "table", "trace", "clear", "startGroup", "startGroupCollapsed", "endGroup", "assert", "timing", "profile", "profileEnd"], "description": "Console message type." },
{ "name": "url", "type": "string", "optional": true, "description": "URL of the message origin." },
{ "name": "line", "type": "integer", "optional": true, "description": "Line number in the resource that generated this message." },
{ "name": "column", "type": "integer", "optional": true, "description": "Column number on the line in the resource that generated this message." },
{ "name": "repeatCount", "type": "integer", "optional": true, "description": "Repeat count for repeated messages." },
{ "name": "parameters", "type": "array", "items": { "$ref": "Runtime.RemoteObject" }, "optional": true, "description": "Message parameters in case of the formatted message." },
{ "name": "stackTrace", "type": "array", "items": { "$ref": "CallFrame" }, "optional": true, "description": "JavaScript stack trace for assertions and error messages." },
{ "name": "networkRequestId", "$ref": "Network.RequestId", "optional": true, "description": "Identifier of the network request associated with this message." }
]
},
{
"id": "CallFrame",
"type": "object",
"description": "Stack entry for console errors and assertions.",
"properties": [
{ "name": "functionName", "type": "string", "description": "JavaScript function name." },
{ "name": "url", "type": "string", "description": "JavaScript script name or url." },
{ "name": "scriptId", "$ref": "Debugger.ScriptId", "description": "Script identifier." },
{ "name": "lineNumber", "type": "integer", "description": "JavaScript script line number." },
{ "name": "columnNumber", "type": "integer", "description": "JavaScript script column number." }
]
},
{
"id": "StackTrace",
"description": "Call frames for async function calls, console assertions, and error messages.",
"type": "object",
"properties": [
{ "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" } },
{ "name": "topCallFrameIsBoundary", "type": "boolean", "optional": true, "description": "Whether the first item in <code>callFrames</code> is the native function that scheduled the asynchronous operation (e.g. setTimeout)." },
{ "name": "truncated", "type": "boolean", "optional": true, "description": "Whether one or more frames have been truncated from the bottom of the stack." },
{ "name": "parentStackTrace", "$ref": "StackTrace", "optional": true, "description": "Parent StackTrace." }
]
}
],
"commands": [
{
"name": "enable",
"description": "Enables console domain, sends the messages collected so far to the client by means of the <code>messageAdded</code> notification."
},
{
"name": "disable",
"description": "Disables console domain, prevents further console messages from being reported to the client."
},
{
"name": "clearMessages",
"description": "Clears console messages collected in the browser."
},
{
"name": "setMonitoringXHREnabled",
"description": "Toggles monitoring of XMLHttpRequest. If <code>true</code>, console will receive messages upon each XHR issued.",
"parameters": [
{ "name": "enabled", "type": "boolean", "description": "Monitoring enabled state." }
]
},
{
"name": "addInspectedNode",
"description": "Enables console to refer to the node with given id via $0 (see Command Line API for more details).",
"parameters": [
{ "name": "nodeId", "$ref": "DOM.NodeId", "description": "DOM node id to be accessible by means of $0 command line API." }
]
}
],
"events": [
{
"name": "messageAdded",
"description": "Issued when new console message is added.",
"parameters": [
{ "name": "message", "$ref": "ConsoleMessage", "description": "Console message that has been added." }
]
},
{
"name": "messageRepeatCountUpdated",
"description": "Issued when subsequent message(s) are equal to the previous one(s).",
"parameters": [
{ "name": "count", "type": "integer", "description": "New repeat count value." }
]
},
{
"name": "messagesCleared",
"description": "Issued when console is cleared. This happens either upon <code>clearMessages</code> command or after page navigation."
},
{
"name": "heapSnapshot",
"description": "Issued from console.takeHeapSnapshot.",
"parameters": [
{ "name": "timestamp", "type": "number" },
{ "name": "snapshotData", "$ref": "Heap.HeapSnapshotData", "description": "Snapshot at the end of tracking." },
{ "name": "title", "type": "string", "optional": true, "description": "Optional title provided to console.takeHeapSnapshot." }
]
}
]
}
,
{
"domain": "DOM",
"description": "This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object that has an <code>id</code>. This <code>id</code> can be used to get additional information on the Node, resolve it into the JavaScript object wrapper, etc. It is important that client receives DOM events only for the nodes that are known to the client. Backend keeps track of the nodes that were sent to the client and never sends the same node twice. It is client's responsibility to collect information about the nodes that were sent to the client.<p>Note that <code>iframe</code> owner elements will return corresponding document elements as their child nodes.</p>",
"availability": ["web"],
"types": [
{
"id": "NodeId",
"type": "integer",
"description": "Unique DOM node identifier."
},
{
"id": "BackendNodeId",
"type": "integer",
"description": "Unique DOM node identifier used to reference a node that may not have been pushed to the front-end."
},
{
"id": "PseudoType",
"type": "string",
"enum": ["before", "after"],
"description": "Pseudo element type."
},
{
"id": "ShadowRootType",
"type": "string",
"enum": ["user-agent", "open", "closed"],
"description": "Shadow root type."
},
{
"id": "CustomElementState",
"type": "string",
"enum": ["builtin", "custom", "waiting", "failed"],
"description": "Custom element state."
},
{
"id": "LiveRegionRelevant",
"type": "string",
"enum": ["additions", "removals", "text"],
"description": "Token values of @aria-relevant attribute."
},
{
"id": "Node",
"type": "object",
"description": "DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes. DOMNode is a base node mirror type.",
"properties": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Node identifier that is passed into the rest of the DOM messages as the <code>nodeId</code>. Backend will only push node with given <code>id</code> once. It is aware of all requested nodes and will only fire DOM events for nodes known to the client." },
{ "name": "nodeType", "type": "integer", "description": "<code>Node</code>'s nodeType." },
{ "name": "nodeName", "type": "string", "description": "<code>Node</code>'s nodeName." },
{ "name": "localName", "type": "string", "description": "<code>Node</code>'s localName." },
{ "name": "nodeValue", "type": "string", "description": "<code>Node</code>'s nodeValue." },
{ "name": "childNodeCount", "type": "integer", "optional": true, "description": "Child count for <code>Container</code> nodes." },
{ "name": "children", "type": "array", "optional": true, "items": { "$ref": "Node" }, "description": "Child nodes of this node when requested with children." },
{ "name": "attributes", "type": "array", "optional": true, "items": { "type": "string" }, "description": "Attributes of the <code>Element</code> node in the form of flat array <code>[name1, value1, name2, value2]</code>." },
{ "name": "documentURL", "type": "string", "optional": true, "description": "Document URL that <code>Document</code> or <code>FrameOwner</code> node points to." },
{ "name": "baseURL", "type": "string", "optional": true, "description": "Base URL that <code>Document</code> or <code>FrameOwner</code> node uses for URL completion." },
{ "name": "publicId", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s publicId." },
{ "name": "systemId", "type": "string", "optional": true, "description": "<code>DocumentType</code>'s systemId." },
{ "name": "xmlVersion", "type": "string", "optional": true, "description": "<code>Document</code>'s XML version in case of XML documents." },
{ "name": "name", "type": "string", "optional": true, "description": "<code>Attr</code>'s name." },
{ "name": "value", "type": "string", "optional": true, "description": "<code>Attr</code>'s value." },
{ "name": "pseudoType", "$ref": "PseudoType", "optional": true, "description": "Pseudo element type for this node." },
{ "name": "shadowRootType", "$ref": "ShadowRootType", "optional": true, "description": "Shadow root type." },
{ "name": "customElementState", "$ref": "CustomElementState", "optional": true, "description": "Custom element state." },
{ "name": "frameId", "$ref": "Network.FrameId", "optional": true, "description": "Frame ID for frame owner elements." },
{ "name": "contentDocument", "$ref": "Node", "optional": true, "description": "Content document for frame owner elements." },
{ "name": "shadowRoots", "type": "array", "optional": true, "items": { "$ref": "Node" }, "description": "Shadow root list for given element host." },
{ "name": "templateContent", "$ref": "Node", "optional": true, "description": "Content document fragment for template elements" },
{ "name": "pseudoElements", "type": "array", "items": { "$ref": "Node" }, "optional": true, "description": "Pseudo elements associated with this node." },
{ "name": "role", "type": "string", "optional": true, "description": "Computed value for first recognized role token, default role per element, or overridden role." },
{ "name": "contentSecurityPolicyHash", "type": "string", "optional": true, "description": "Computed SHA-256 Content Security Policy hash source for given element." }
]
},
{
"id": "EventListener",
"type": "object",
"description": "A structure holding event listener properties.",
"properties": [
{ "name": "type", "type": "string", "description": "<code>EventListener</code>'s type." },
{ "name": "useCapture", "type": "boolean", "description": "<code>EventListener</code>'s useCapture." },
{ "name": "isAttribute", "type": "boolean", "description": "<code>EventListener</code>'s isAttribute." },
{ "name": "nodeId", "$ref": "NodeId", "description": "Target <code>DOMNode</code> id." },
{ "name": "handlerBody", "type": "string", "description": "Event handler function body." },
{ "name": "location", "$ref": "Debugger.Location", "optional": true, "description": "Handler code location." },
{ "name": "sourceName", "type": "string", "optional": true, "description": "Source script URL." },
{ "name": "handler", "$ref": "Runtime.RemoteObject", "optional": true, "description": "Event handler function value." },
{ "name": "passive", "type": "boolean", "optional": true, "description": "<code>EventListener</code>'s passive." },
{ "name": "once", "type": "boolean", "optional": true, "description": "<code>EventListener</code>'s once." }
]
},
{
"id": "AccessibilityProperties",
"description": "A structure holding accessibility properties.",
"type": "object",
"properties": [
{ "name": "activeDescendantNodeId", "$ref": "NodeId", "optional": true, "description": "<code>DOMNode</code> id of the accessibility object referenced by aria-activedescendant." },
{ "name": "busy", "type": "boolean", "optional": true, "description": "Value of @aria-busy on current or ancestor node." },
{ "name": "checked", "type": "string", "optional": true, "enum": ["true", "false", "mixed"], "description": "Checked state of certain form controls." },
{ "name": "childNodeIds", "type": "array", "items": { "$ref": "NodeId" }, "optional": true, "description": "Array of <code>DOMNode</code> ids of the accessibility tree children if available." },
{ "name": "controlledNodeIds", "type": "array", "items": { "$ref": "NodeId" }, "optional": true, "description": "Array of <code>DOMNode</code> ids of any nodes referenced via @aria-controls." },
{ "name": "current", "type": "string", "optional": true, "enum": ["true", "false", "page", "step", "location", "date", "time"], "description": "Current item within a container or set of related elements." },
{ "name": "disabled", "type": "boolean", "optional": true, "description": "Disabled state of form controls." },
{ "name": "headingLevel", "type": "number", "optional": true, "description": "Heading level of a heading element." },
{ "name": "hierarchyLevel", "type": "number", "optional": true, "description": "The hierarchical level of an element." },
{ "name": "isPopUpButton", "type": "boolean", "optional": true, "description": "Whether an element is a popup button." },
{ "name": "exists", "type": "boolean", "description": "Indicates whether there is an existing AX object for the DOM node. If this is false, all the other properties will be default values." },
{ "name": "expanded", "type": "boolean", "optional": true, "description": "Expanded state." },
{ "name": "flowedNodeIds", "type": "array", "items": { "$ref": "NodeId" }, "optional": true, "description": "Array of <code>DOMNode</code> ids of any nodes referenced via @aria-flowto." },
{ "name": "focused", "type": "boolean", "optional": true, "description": "Focused state. Only defined on focusable elements." },
{ "name": "ignored", "type": "boolean", "optional": true, "description": "Indicates whether the accessibility of the associated AX object node is ignored, whether heuristically or explicitly." },
{ "name": "ignoredByDefault", "type": "boolean", "optional": true, "description": "State indicating whether the accessibility of the associated AX object node is ignored by default for node type." },
{ "name": "invalid", "type": "string", "optional": true, "enum": ["true", "false", "grammar", "spelling"], "description": "Invalid status of form controls." },
{ "name": "hidden", "type": "boolean", "optional": true, "description": "Hidden state. True if node or an ancestor is hidden via CSS or explicit @aria-hidden, to clarify why the element is ignored." },
{ "name": "label", "type": "string", "description": "Computed label value for the node, sometimes calculated by referencing other nodes." },
{ "name": "liveRegionAtomic", "type": "boolean", "optional": true, "description": "Value of @aria-atomic." },
{ "name": "liveRegionRelevant", "type": "array", "items": { "type": "string" }, "optional": true, "description": "Token value(s) of element's @aria-relevant attribute. Array of string values matching $ref LiveRegionRelevant. FIXME: Enum values blocked by http://webkit.org/b/133711" },
{ "name": "liveRegionStatus", "type": "string", "optional": true, "enum": ["assertive", "polite", "off"], "description": "Value of element's @aria-live attribute." },
{ "name": "mouseEventNodeId", "$ref": "NodeId", "optional": true, "description": "<code>DOMNode</code> id of node or closest ancestor node that has a mousedown, mouseup, or click event handler." },
{ "name": "nodeId", "$ref": "NodeId", "description": "Target <code>DOMNode</code> id." },
{ "name": "ownedNodeIds", "type": "array", "items": { "$ref": "NodeId" }, "optional": true, "description": "Array of <code>DOMNode</code> ids of any nodes referenced via @aria-owns." },
{ "name": "parentNodeId", "$ref": "NodeId", "optional": true, "description": "<code>DOMNode</code> id of the accessibility tree parent object if available." },
{ "name": "pressed", "type": "boolean", "optional": true, "description": "Pressed state for toggle buttons." },
{ "name": "readonly", "type": "boolean", "optional": true, "description": "Readonly state of text controls." },
{ "name": "required", "type": "boolean", "optional": true, "description": "Required state of form controls." },
{ "name": "role", "type": "string", "description": "Computed value for first recognized role token, default role per element, or overridden role." },
{ "name": "selected", "type": "boolean", "optional": true, "description": "Selected state of certain form controls." },
{ "name": "selectedChildNodeIds", "type": "array", "items": { "$ref": "NodeId" }, "optional": true, "description": "Array of <code>DOMNode</code> ids of any children marked as selected." }
]
},
{
"id": "RGBAColor",
"type": "object",
"description": "A structure holding an RGBA color.",
"properties": [
{ "name": "r", "type": "integer", "description": "The red component, in the [0-255] range." },
{ "name": "g", "type": "integer", "description": "The green component, in the [0-255] range." },
{ "name": "b", "type": "integer", "description": "The blue component, in the [0-255] range." },
{ "name": "a", "type": "number", "optional": true, "description": "The alpha component, in the [0-1] range (default: 1)." }
]
},
{
"id": "Quad",
"type": "array",
"items": { "type": "number" },
"minItems": 8,
"maxItems": 8,
"description": "An array of quad vertices, x immediately followed by y for each point, points clock-wise."
},
{
"id": "HighlightConfig",
"type": "object",
"description": "Configuration data for the highlighting of page elements.",
"properties": [
{ "name": "showInfo", "type": "boolean", "optional": true, "description": "Whether the node info tooltip should be shown (default: false)." },
{ "name": "contentColor", "$ref": "RGBAColor", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
{ "name": "paddingColor", "$ref": "RGBAColor", "optional": true, "description": "The padding highlight fill color (default: transparent)." },
{ "name": "borderColor", "$ref": "RGBAColor", "optional": true, "description": "The border highlight fill color (default: transparent)." },
{ "name": "marginColor", "$ref": "RGBAColor", "optional": true, "description": "The margin highlight fill color (default: transparent)." }
]
}
],
"commands": [
{
"name": "getDocument",
"description": "Returns the root DOM node to the caller.",
"returns": [
{ "name": "root", "$ref": "Node", "description": "Resulting node." }
]
},
{
"name": "requestChildNodes",
"description": "Requests that children of the node with given id are returned to the caller in form of <code>setChildNodes</code> events where not only immediate children are retrieved, but all children down to the specified depth.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get children for." },
{ "name": "depth", "type": "integer", "optional": true, "description": "The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0." }
]
},
{
"name": "querySelector",
"description": "Executes <code>querySelector</code> on a given node.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to query upon." },
{ "name": "selector", "type": "string", "description": "Selector string." }
],
"returns": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Query selector result." }
]
},
{
"name": "querySelectorAll",
"description": "Executes <code>querySelectorAll</code> on a given node.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to query upon." },
{ "name": "selector", "type": "string", "description": "Selector string." }
],
"returns": [
{ "name": "nodeIds", "type": "array", "items": { "$ref": "NodeId" }, "description": "Query selector result." }
]
},
{
"name": "setNodeName",
"description": "Sets node name for a node with given id.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to set name for." },
{ "name": "name", "type": "string", "description": "New node's name." }
],
"returns": [
{ "name": "nodeId", "$ref": "NodeId", "description": "New node's id." }
]
},
{
"name": "setNodeValue",
"description": "Sets node value for a node with given id.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to set value for." },
{ "name": "value", "type": "string", "description": "New node's value." }
]
},
{
"name": "removeNode",
"description": "Removes node with given id.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to remove." }
]
},
{
"name": "setAttributeValue",
"description": "Sets attribute for an element with given id.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the element to set attribute for." },
{ "name": "name", "type": "string", "description": "Attribute name." },
{ "name": "value", "type": "string", "description": "Attribute value." }
]
},
{
"name": "setAttributesAsText",
"description": "Sets attributes on element with given id. This method is useful when user edits some existing attribute value and types in several attribute name/value pairs.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the element to set attributes for." },
{ "name": "text", "type": "string", "description": "Text with a number of attributes. Will parse this text using HTML parser." },
{ "name": "name", "type": "string", "optional": true, "description": "Attribute name to replace with new attributes derived from text in case text parsed successfully." }
]
},
{
"name": "removeAttribute",
"description": "Removes attribute with given name from an element with given id.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the element to remove attribute from." },
{ "name": "name", "type": "string", "description": "Name of the attribute to remove." }
]
},
{
"name": "getEventListenersForNode",
"description": "Returns event listeners relevant to the node.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get listeners for." },
{ "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name for handler value. Handler value is not returned without this parameter specified." }
],
"returns": [
{ "name": "listeners", "type": "array", "items": { "$ref": "EventListener"}, "description": "Array of relevant listeners." }
]
},
{
"name": "getAccessibilityPropertiesForNode",
"description": "Returns a dictionary of accessibility properties for the node.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node for which to get accessibility properties." }
],
"returns": [
{ "name": "properties", "$ref": "AccessibilityProperties", "description": "Dictionary of relevant accessibility properties." }
]
},
{
"name": "getOuterHTML",
"description": "Returns node's HTML markup.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get markup for." }
],
"returns": [
{ "name": "outerHTML", "type": "string", "description": "Outer HTML markup." }
]
},
{
"name": "setOuterHTML",
"description": "Sets node HTML markup, returns new node id.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to set markup for." },
{ "name": "outerHTML", "type": "string", "description": "Outer HTML markup to set." }
]
},
{
"name": "performSearch",
"description": "Searches for a given string in the DOM tree. Use <code>getSearchResults</code> to access search results or <code>cancelSearch</code> to end this search session.",
"parameters": [
{ "name": "query", "type": "string", "description": "Plain text or query selector or XPath search query." },
{ "name": "nodeIds", "type": "array", "items": { "$ref": "NodeId" }, "optional": true, "description": "Ids of nodes to use as starting points for the search." }
],
"returns": [
{ "name": "searchId", "type": "string", "description": "Unique search session identifier." },
{ "name": "resultCount", "type": "integer", "description": "Number of search results." }
]
},
{
"name": "getSearchResults",
"description": "Returns search results from given <code>fromIndex</code> to given <code>toIndex</code> from the sarch with the given identifier.",
"parameters": [
{ "name": "searchId", "type": "string", "description": "Unique search session identifier." },
{ "name": "fromIndex", "type": "integer", "description": "Start index of the search result to be returned." },
{ "name": "toIndex", "type": "integer", "description": "End index of the search result to be returned." }
],
"returns": [
{ "name": "nodeIds", "type": "array", "items": { "$ref": "NodeId" }, "description": "Ids of the search result nodes." }
]
},
{
"name": "discardSearchResults",
"description": "Discards search results from the session with the given id. <code>getSearchResults</code> should no longer be called for that search.",
"parameters": [
{ "name": "searchId", "type": "string", "description": "Unique search session identifier." }
]
},
{
"name": "requestNode",
"description": "Requests that the node is sent to the caller given the JavaScript node object reference. All nodes that form the path from the node to the root are also sent to the client as a series of <code>setChildNodes</code> notifications.",
"parameters": [
{ "name": "objectId", "$ref": "Runtime.RemoteObjectId", "description": "JavaScript object id to convert into node." }
],
"returns": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Node id for given object." }
]
},
{
"name": "setInspectModeEnabled",
"description": "Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspect' command upon element selection.",
"parameters": [
{ "name": "enabled", "type": "boolean", "description": "True to enable inspection mode, false to disable it." },
{ "name": "highlightConfig", "$ref": "HighlightConfig", "optional": true, "description": "A descriptor for the highlight appearance of hovered-over nodes. May be omitted if <code>enabled == false</code>." }
]
},
{
"name": "highlightRect",
"description": "Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.",
"parameters": [
{ "name": "x", "type": "integer", "description": "X coordinate" },
{ "name": "y", "type": "integer", "description": "Y coordinate" },
{ "name": "width", "type": "integer", "description": "Rectangle width" },
{ "name": "height", "type": "integer", "description": "Rectangle height" },
{ "name": "color", "$ref": "RGBAColor", "optional": true, "description": "The highlight fill color (default: transparent)." },
{ "name": "outlineColor", "$ref": "RGBAColor", "optional": true, "description": "The highlight outline color (default: transparent)." },
{ "name": "usePageCoordinates", "type": "boolean", "optional": true, "description": "Indicates whether the provided parameters are in page coordinates or in viewport coordinates (the default)." }
]
},
{
"name": "highlightQuad",
"description": "Highlights given quad. Coordinates are absolute with respect to the main frame viewport.",
"parameters": [
{ "name": "quad", "$ref": "Quad", "description": "Quad to highlight" },
{ "name": "color", "$ref": "RGBAColor", "optional": true, "description": "The highlight fill color (default: transparent)." },
{ "name": "outlineColor", "$ref": "RGBAColor", "optional": true, "description": "The highlight outline color (default: transparent)." },
{ "name": "usePageCoordinates", "type": "boolean", "optional": true, "description": "Indicates whether the provided parameters are in page coordinates or in viewport coordinates (the default)." }
]
},
{
"name": "highlightSelector",
"description": "Highlights all DOM nodes that match a given selector. A string containing a CSS selector must be specified.",
"parameters": [
{ "name": "highlightConfig", "$ref": "HighlightConfig", "description": "A descriptor for the highlight appearance." },
{ "name": "selectorString", "type": "string", "description": "A CSS selector for finding matching nodes to highlight." },
{ "name": "frameId", "type": "string", "optional": true, "description": "Identifier of the frame which will be searched using the selector. If not provided, the main frame will be used." }
]
},
{
"name": "highlightNode",
"description": "Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.",
"parameters": [
{ "name": "highlightConfig", "$ref": "HighlightConfig", "description": "A descriptor for the highlight appearance." },
{ "name": "nodeId", "$ref": "NodeId", "optional": true, "description": "Identifier of the node to highlight." },
{ "name": "objectId", "$ref": "Runtime.RemoteObjectId", "optional": true, "description": "JavaScript object id of the node to be highlighted." }
]
},
{
"name": "hideHighlight",
"description": "Hides DOM node highlight."
},
{
"name": "highlightFrame",
"parameters": [
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Identifier of the frame to highlight." },
{ "name": "contentColor", "$ref": "RGBAColor", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
{ "name": "contentOutlineColor", "$ref": "RGBAColor", "optional": true, "description": "The content box highlight outline color (default: transparent)." }
],
"description": "Highlights owner element of the frame with given id."
},
{
"name": "pushNodeByPathToFrontend",
"description": "Requests that the node is sent to the caller given its path.",
"parameters": [
{ "name": "path", "type": "string", "description": "Path to node in the proprietary format." }
],
"returns": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node for given path." }
]
},
{
"name": "pushNodeByBackendIdToFrontend",
"description": "Requests that the node is sent to the caller given its backend node id.",
"parameters": [
{ "name": "backendNodeId", "$ref": "BackendNodeId", "description": "The backend node id of the node." }
],
"returns": [
{ "name": "nodeId", "$ref": "NodeId", "description": "The pushed node's id." }
]
},
{
"name": "releaseBackendNodeIds",
"description": "Requests that group of <code>BackendNodeIds</code> is released.",
"parameters": [
{ "name": "nodeGroup", "type": "string", "description": "The backend node ids group name." }
]
},
{
"name": "resolveNode",
"description": "Resolves JavaScript node object for given node id.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to resolve." },
{ "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." }
],
"returns": [
{ "name": "object", "$ref": "Runtime.RemoteObject", "description": "JavaScript object wrapper for given node." }
]
},
{
"name": "getAttributes",
"description": "Returns attributes for the specified node.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to retrieve attributes for." }
],
"returns": [
{ "name": "attributes", "type": "array", "items": { "type": "string" }, "description": "An interleaved array of node attribute names and values." }
]
},
{
"name": "moveTo",
"description": "Moves node into the new container, places it before the given anchor.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to drop." },
{ "name": "targetNodeId", "$ref": "NodeId", "description": "Id of the element to drop into." },
{ "name": "insertBeforeNodeId", "$ref": "NodeId", "optional": true, "description": "Drop node before given one." }
],
"returns": [
{ "name": "nodeId", "$ref": "NodeId", "description": "New id of the moved node." }
]
},
{
"name": "undo",
"description": "Undoes the last performed action."
},
{
"name": "redo",
"description": "Re-does the last undone action."
},
{
"name": "markUndoableState",
"description": "Marks last undoable state."
},
{
"name": "focus",
"description": "Focuses the given element.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to focus." }
]
}
],
"events": [
{
"name": "documentUpdated",
"description": "Fired when <code>Document</code> has been totally updated. Node ids are no longer valid."
},
{
"name": "setChildNodes",
"description": "Fired when backend wants to provide client with the missing DOM structure. This happens upon most of the calls requesting node ids.",
"parameters": [
{ "name": "parentId", "$ref": "NodeId", "description": "Parent node id to populate with children." },
{ "name": "nodes", "type": "array", "items": { "$ref": "Node"}, "description": "Child nodes array." }
]
},
{
"name": "attributeModified",
"description": "Fired when <code>Element</code>'s attribute is modified.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
{ "name": "name", "type": "string", "description": "Attribute name." },
{ "name": "value", "type": "string", "description": "Attribute value." }
]
},
{
"name": "attributeRemoved",
"description": "Fired when <code>Element</code>'s attribute is removed.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
{ "name": "name", "type": "string", "description": "Attribute name." }
]
},
{
"name": "inlineStyleInvalidated",
"description": "Fired when <code>Element</code>'s inline style is modified via a CSS property modification.",
"parameters": [
{ "name": "nodeIds", "type": "array", "items": { "$ref": "NodeId" }, "description": "Ids of the nodes for which the inline styles have been invalidated." }
]
},
{
"name": "characterDataModified",
"description": "Mirrors <code>DOMCharacterDataModified</code> event.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
{ "name": "characterData", "type": "string", "description": "New text value." }
]
},
{
"name": "childNodeCountUpdated",
"description": "Fired when <code>Container</code>'s child node count has changed.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
{ "name": "childNodeCount", "type": "integer", "description": "New node count." }
]
},
{
"name": "childNodeInserted",
"description": "Mirrors <code>DOMNodeInserted</code> event.",
"parameters": [
{ "name": "parentNodeId", "$ref": "NodeId", "description": "Id of the node that has changed." },
{ "name": "previousNodeId", "$ref": "NodeId", "description": "Id of the previous sibling." },
{ "name": "node", "$ref": "Node", "description": "Inserted node data." }
]
},
{
"name": "childNodeRemoved",
"description": "Mirrors <code>DOMNodeRemoved</code> event.",
"parameters": [
{ "name": "parentNodeId", "$ref": "NodeId", "description": "Parent id." },
{ "name": "nodeId", "$ref": "NodeId", "description": "Id of the node that has been removed." }
]
},
{
"name": "shadowRootPushed",
"description": "Called when shadow root is pushed into the element.",
"parameters": [
{ "name": "hostId", "$ref": "NodeId", "description": "Host element id." },
{ "name": "root", "$ref": "Node", "description": "Shadow root." }
]
},
{
"name": "shadowRootPopped",
"description": "Called when shadow root is popped from the element.",
"parameters": [
{ "name": "hostId", "$ref": "NodeId", "description": "Host element id." },
{ "name": "rootId", "$ref": "NodeId", "description": "Shadow root id." }
]
},
{
"name": "customElementStateChanged",
"description": "Called when the custom element state is changed.",
"parameters": [
{ "name": "nodeId", "$ref": "NodeId", "description": "Element id." },
{ "name": "customElementState", "$ref": "CustomElementState", "description": "Custom element state." }
]
},
{
"name": "pseudoElementAdded",
"description": "Called when a pseudo element is added to an element.",
"parameters": [
{ "name": "parentId", "$ref": "NodeId", "description": "Pseudo element's parent element id." },
{ "name": "pseudoElement", "$ref": "Node", "description": "The added pseudo element." }
]
},
{
"name": "pseudoElementRemoved",
"description": "Called when a pseudo element is removed from an element.",
"parameters": [
{ "name": "parentId", "$ref": "NodeId", "description": "Pseudo element's parent element id." },
{ "name": "pseudoElementId", "$ref": "NodeId", "description": "The removed pseudo element id." }
]
}
]
}
,
{
"domain": "DOMDebugger",
"description": "DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript execution will stop on these operations as if there was a regular breakpoint set.",
"availability": ["web"],
"types": [
{
"id": "DOMBreakpointType",
"type": "string",
"enum": ["subtree-modified", "attribute-modified", "node-removed"],
"description": "DOM breakpoint type."
}
],
"commands": [
{
"name": "setDOMBreakpoint",
"description": "Sets breakpoint on particular operation with DOM.",
"parameters": [
{ "name": "nodeId", "$ref": "DOM.NodeId", "description": "Identifier of the node to set breakpoint on." },
{ "name": "type", "$ref": "DOMBreakpointType", "description": "Type of the operation to stop upon." }
]
},
{
"name": "removeDOMBreakpoint",
"description": "Removes DOM breakpoint that was set using <code>setDOMBreakpoint</code>.",
"parameters": [
{ "name": "nodeId", "$ref": "DOM.NodeId", "description": "Identifier of the node to remove breakpoint from." },
{ "name": "type", "$ref": "DOMBreakpointType", "description": "Type of the breakpoint to remove." }
]
},
{
"name": "setEventListenerBreakpoint",
"description": "Sets breakpoint on particular DOM event.",
"parameters": [
{ "name": "eventName", "type": "string", "description": "DOM Event name to stop on (any DOM event will do)." }
]
},
{
"name": "removeEventListenerBreakpoint",
"description": "Removes breakpoint on particular DOM event.",
"parameters": [
{ "name": "eventName", "type": "string", "description": "Event name." }
]
},
{
"name": "setInstrumentationBreakpoint",
"description": "Sets breakpoint on particular native event.",
"parameters": [
{ "name": "eventName", "type": "string", "description": "Instrumentation name to stop on." }
]
},
{
"name": "removeInstrumentationBreakpoint",
"description": "Sets breakpoint on particular native event.",
"parameters": [
{ "name": "eventName", "type": "string", "description": "Instrumentation name to stop on." }
]
},
{
"name": "setXHRBreakpoint",
"description": "Sets breakpoint on XMLHttpRequest.",
"parameters": [
{ "name": "url", "type": "string", "description": "Resource URL substring or regular expression. All XHRs having this substring in the URL will get stopped upon. An empty string will pause on all XHRs." },
{ "name": "isRegex", "type": "boolean", "optional": true, "description": "Whether the URL string is a regular expression." }
]
},
{
"name": "removeXHRBreakpoint",
"description": "Removes breakpoint from XMLHttpRequest.",
"parameters": [
{ "name": "url", "type": "string", "description": "Resource URL substring. An empty string will stop pausing on all XHRs." }
]
}
]
}
,
{
"domain": "DOMStorage",
"description": "Query and modify DOM storage.",
"availability": ["web"],
"types": [
{
"id": "StorageId",
"type": "object",
"description": "DOM Storage identifier.",
"properties": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin for the storage." },
{ "name": "isLocalStorage", "type": "boolean", "description": "Whether the storage is local storage (not session storage)." }
]
},
{
"id": "Item",
"type": "array",
"description": "DOM Storage item.",
"items": { "type": "string" }
}
],
"commands": [
{
"name": "enable",
"description": "Enables storage tracking, storage events will now be delivered to the client."
},
{
"name": "disable",
"description": "Disables storage tracking, prevents storage events from being sent to the client."
},
{
"name": "getDOMStorageItems",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" }
],
"returns": [
{ "name": "entries", "type": "array", "items": { "$ref": "Item" } }
]
},
{
"name": "setDOMStorageItem",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" },
{ "name": "key", "type": "string" },
{ "name": "value", "type": "string" }
]
},
{
"name": "removeDOMStorageItem",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" },
{ "name": "key", "type": "string" }
]
}
],
"events": [
{
"name": "domStorageItemsCleared",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" }
]
},
{
"name": "domStorageItemRemoved",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" },
{ "name": "key", "type": "string" }
]
},
{
"name": "domStorageItemAdded",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" },
{ "name": "key", "type": "string" },
{ "name": "newValue", "type": "string" }
]
},
{
"name": "domStorageItemUpdated",
"parameters": [
{ "name": "storageId", "$ref": "StorageId" },
{ "name": "key", "type": "string" },
{ "name": "oldValue", "type": "string" },
{ "name": "newValue", "type": "string" }
]
}
]
}
,
{
"domain": "Database",
"availability": ["web"],
"types": [
{
"id": "DatabaseId",
"type": "string",
"description": "Unique identifier of Database object."
},
{
"id": "Database",
"type": "object",
"description": "Database object.",
"properties": [
{ "name": "id", "$ref": "DatabaseId", "description": "Database ID." },
{ "name": "domain", "type": "string", "description": "Database domain." },
{ "name": "name", "type": "string", "description": "Database name." },
{ "name": "version", "type": "string", "description": "Database version." }
]
},
{
"id": "Error",
"type": "object",
"description": "Database error.",
"properties": [
{ "name": "message", "type": "string", "description": "Error message." },
{ "name": "code", "type": "integer", "description": "Error code." }
]
}
],
"commands": [
{
"name": "enable",
"description": "Enables database tracking, database events will now be delivered to the client."
},
{
"name": "disable",
"description": "Disables database tracking, prevents database events from being sent to the client."
},
{
"name": "getDatabaseTableNames",
"parameters": [
{ "name": "databaseId", "$ref": "DatabaseId" }
],
"returns": [
{ "name": "tableNames", "type": "array", "items": { "type": "string" } }
]
},
{
"name": "executeSQL",
"async": true,
"parameters": [
{ "name": "databaseId", "$ref": "DatabaseId" },
{ "name": "query", "type": "string" }
],
"returns": [
{ "name": "columnNames", "type": "array", "optional": true, "items": { "type": "string" } },
{ "name": "values", "type": "array", "optional": true, "items": { "type": "any" }},
{ "name": "sqlError", "$ref": "Error", "optional": true }
]
}
],
"events": [
{
"name": "addDatabase",
"parameters": [
{ "name": "database", "$ref": "Database" }
]
}
]
}
,
{
"domain": "Debugger",
"description": "Debugger domain exposes JavaScript debugging capabilities. It allows setting and removing breakpoints, stepping through execution, exploring stack traces, etc.",
"workerSupported": true,
"types": [
{
"id": "BreakpointId",
"type": "string",
"description": "Breakpoint identifier."
},
{
"id": "BreakpointActionIdentifier",
"type": "integer",
"description": "Breakpoint action identifier."
},
{
"id": "ScriptId",
"type": "string",
"description": "Unique script identifier."
},
{
"id": "CallFrameId",
"type": "string",
"description": "Call frame identifier."
},
{
"id": "Location",
"type": "object",
"description": "Location in the source code.",
"properties": [
{ "name": "scriptId", "$ref": "ScriptId", "description": "Script identifier as reported in the <code>Debugger.scriptParsed</code>." },
{ "name": "lineNumber", "type": "integer", "description": "Line number in the script." },
{ "name": "columnNumber", "type": "integer", "optional": true, "description": "Column number in the script." }
]
},
{
"id": "BreakpointAction",
"type": "object",
"description": "Action to perform when a breakpoint is triggered.",
"properties": [
{ "name": "type", "type": "string", "enum": ["log", "evaluate", "sound", "probe"], "description": "Different kinds of breakpoint actions." },
{ "name": "data", "type": "string", "optional": true, "description": "Data associated with this breakpoint type (e.g. for type \"eval\" this is the JavaScript string to evaluate)." },
{ "name": "id", "$ref": "BreakpointActionIdentifier", "optional": true, "description": "A frontend-assigned identifier for this breakpoint action." }
]
},
{
"id": "BreakpointOptions",
"type": "object",
"description": "Extra options that modify breakpoint behavior.",
"properties": [
{ "name": "condition", "type": "string", "optional": true, "description": "Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true." },
{ "name": "actions", "type": "array", "optional": true, "items": { "$ref": "BreakpointAction" }, "description": "Actions to perform automatically when the breakpoint is triggered." },
{ "name": "autoContinue", "type": "boolean", "optional": true, "description": "Automatically continue after hitting this breakpoint and running actions." },
{ "name": "ignoreCount", "type": "integer", "optional": true, "description": "Number of times to ignore this breakpoint, before stopping on the breakpoint and running actions." }
]
},
{
"id": "FunctionDetails",
"type": "object",
"description": "Information about the function.",
"properties": [
{ "name": "location", "$ref": "Location", "description": "Location of the function." },
{ "name": "name", "type": "string", "optional": true, "description": "Name of the function. Not present for anonymous functions." },
{ "name": "displayName", "type": "string", "optional": true, "description": "Display name of the function(specified in 'displayName' property on the function object)." },
{ "name": "scopeChain", "type": "array", "optional": true, "items": { "$ref": "Scope" }, "description": "Scope chain for this closure." }
]
},
{
"id": "CallFrame",
"type": "object",
"description": "JavaScript call frame. Array of call frames form the call stack.",
"properties": [
{ "name": "callFrameId", "$ref": "CallFrameId", "description": "Call frame identifier. This identifier is only valid while the virtual machine is paused." },
{ "name": "functionName", "type": "string", "description": "Name of the JavaScript function called on this call frame." },
{ "name": "location", "$ref": "Location", "description": "Location in the source code." },
{ "name": "scopeChain", "type": "array", "items": { "$ref": "Scope" }, "description": "Scope chain for this call frame." },
{ "name": "this", "$ref": "Runtime.RemoteObject", "description": "<code>this</code> object for this call frame." },
{ "name": "isTailDeleted", "type": "boolean", "description": "Is the current frame tail deleted from a tail call." }
]
},
{
"id": "Scope",
"type": "object",
"description": "Scope description.",
"properties": [
{ "name": "object", "$ref": "Runtime.RemoteObject", "description": "Object representing the scope. For <code>global</code> and <code>with</code> scopes it represents the actual object; for the rest of the scopes, it is artificial transient object enumerating scope variables as its properties." },
{ "name": "type", "type": "string", "enum": ["global", "with", "closure", "catch", "functionName", "globalLexicalEnvironment", "nestedLexical"], "description": "Scope type." },
{ "name": "name", "type": "string", "optional": true, "description": "Name associated with the scope." },
{ "name": "location", "$ref": "Location", "optional": true, "description": "Location if available of the scope definition." },
{ "name": "empty", "type": "boolean", "optional": true, "description": "Whether the scope has any variables." }
]
},
{
"id": "ProbeSample",
"description": "A sample collected by evaluating a probe breakpoint action.",
"type": "object",
"properties": [
{ "name": "probeId", "$ref": "BreakpointActionIdentifier", "description": "Identifier of the probe breakpoint action that created the sample." },
{ "name": "sampleId", "type": "integer", "description": "Unique identifier for this sample." },
{ "name": "batchId", "type": "integer", "description": "A batch identifier which is the same for all samples taken at the same breakpoint hit." },
{ "name": "timestamp", "type": "number", "description": "Timestamp of when the sample was taken." },
{ "name": "payload", "$ref": "Runtime.RemoteObject", "description": "Contents of the sample." }
]
},
{
"id": "AssertPauseReason",
"type": "object",
"description": "The pause reason auxiliary data when paused because of an assertion.",
"properties": [
{ "name": "message", "type": "string", "optional": true, "description": "The console.assert message string if provided." }
]
},
{
"id": "BreakpointPauseReason",
"type": "object",
"description": "The pause reason auxiliary data when paused because of hitting a breakpoint.",
"properties": [
{ "name": "breakpointId", "type": "string", "description": "The identifier of the breakpoint causing the pause." }
]
},
{
"id": "CSPViolationPauseReason",
"type": "object",
"description": "The pause reason auxiliary data when paused because of a Content Security Policy directive.",
"properties": [
{ "name": "directive", "type": "string", "description": "The CSP directive that blocked script execution." }
]
}
],
"commands": [
{
"name": "enable",
"description": "Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received."
},
{
"name": "disable",
"description": "Disables debugger for given page."
},
{
"name": "setAsyncStackTraceDepth",
"description": "Set the async stack trace depth for the page. A value of zero disables recording of async stack traces.",
"parameters": [
{ "name": "depth", "type": "integer", "description": "Async stack trace depth." }
]
},
{
"name": "setBreakpointsActive",
"description": "Activates / deactivates all breakpoints on the page.",
"parameters": [
{ "name": "active", "type": "boolean", "description": "New value for breakpoints active state." }
]
},
{
"name": "setBreakpointByUrl",
"description": "Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in <code>locations</code> property. Further matching script parsing will result in subsequent <code>breakpointResolved</code> events issued. This logical breakpoint will survive page reloads.",
"parameters": [
{ "name": "lineNumber", "type": "integer", "description": "Line number to set breakpoint at." },
{ "name": "url", "type": "string", "optional": true, "description": "URL of the resources to set breakpoint on." },
{ "name": "urlRegex", "type": "string", "optional": true, "description": "Regex pattern for the URLs of the resources to set breakpoints on. Either <code>url</code> or <code>urlRegex</code> must be specified." },
{ "name": "columnNumber", "type": "integer", "optional": true, "description": "Offset in the line to set breakpoint at." },
{ "name": "options", "$ref": "BreakpointOptions", "optional": true, "description": "Options to apply to this breakpoint to modify its behavior." }
],
"returns": [
{ "name": "breakpointId", "$ref": "BreakpointId", "description": "Id of the created breakpoint for further reference." },
{ "name": "locations", "type": "array", "items": { "$ref": "Location"}, "description": "List of the locations this breakpoint resolved into upon addition." }
]
},
{
"name": "setBreakpoint",
"description": "Sets JavaScript breakpoint at a given location.",
"parameters": [
{ "name": "location", "$ref": "Location", "description": "Location to set breakpoint in." },
{ "name": "options", "$ref": "BreakpointOptions", "optional": true, "description": "Options to apply to this breakpoint to modify its behavior." }
],
"returns": [
{ "name": "breakpointId", "$ref": "BreakpointId", "description": "Id of the created breakpoint for further reference." },
{ "name": "actualLocation", "$ref": "Location", "description": "Location this breakpoint resolved into." }
]
},
{
"name": "removeBreakpoint",
"description": "Removes JavaScript breakpoint.",
"parameters": [
{ "name": "breakpointId", "$ref": "BreakpointId" }
]
},
{
"name": "continueUntilNextRunLoop",
"description": "Continues execution until the current evaluation completes. This will trigger either a Debugger.paused or Debugger.resumed event."
},
{
"name": "continueToLocation",
"description": "Continues execution until specific location is reached. This will trigger either a Debugger.paused or Debugger.resumed event.",
"parameters": [
{ "name": "location", "$ref": "Location", "description": "Location to continue to." }
]
},
{
"name": "stepOver",
"description": "Steps over the statement. This will trigger either a Debugger.paused or Debugger.resumed event."
},
{
"name": "stepInto",
"description": "Steps into the function call. This will trigger either a Debugger.paused or Debugger.resumed event."
},
{
"name": "stepOut",
"description": "Steps out of the function call. This will trigger either a Debugger.paused or Debugger.resumed event."
},
{
"name": "pause",
"description": "Stops on the next JavaScript statement."
},
{
"name": "resume",
"description": "Resumes JavaScript execution. This will trigger a Debugger.resumed event."
},
{
"name": "searchInContent",
"description": "Searches for given string in script content.",
"parameters": [
{ "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to search in." },
{ "name": "query", "type": "string", "description": "String to search for." },
{ "name": "caseSensitive", "type": "boolean", "optional": true, "description": "If true, search is case sensitive." },
{ "name": "isRegex", "type": "boolean", "optional": true, "description": "If true, treats string parameter as regex." }
],
"returns": [
{ "name": "result", "type": "array", "items": { "$ref": "GenericTypes.SearchMatch" }, "description": "List of search matches." }
]
},
{
"name": "getScriptSource",
"description": "Returns source for the script with given id.",
"parameters": [
{ "name": "scriptId", "$ref": "ScriptId", "description": "Id of the script to get source for." }
],
"returns": [
{ "name": "scriptSource", "type": "string", "description": "Script source." }
]
},
{
"name": "getFunctionDetails",
"description": "Returns detailed information on given function.",
"parameters": [
{ "name": "functionId", "$ref": "Runtime.RemoteObjectId", "description": "Id of the function to get location for." }
],
"returns": [
{ "name": "details", "$ref": "FunctionDetails", "description": "Information about the function." }
]
},
{
"name": "setPauseOnExceptions",
"description": "Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions or no exceptions. Initial pause on exceptions state is <code>none</code>.",
"parameters": [
{ "name": "state", "type": "string", "enum": ["none", "uncaught", "all"], "description": "Pause on exceptions mode." }
]
},
{
"name": "setPauseOnAssertions",
"description": "Set pause on assertions state. Assertions are console.assert assertions.",
"parameters": [
{ "name": "enabled", "type": "boolean" }
]
},
{
"name": "evaluateOnCallFrame",
"description": "Evaluates expression on a given call frame.",
"parameters": [
{ "name": "callFrameId", "$ref": "CallFrameId", "description": "Call frame identifier to evaluate on." },
{ "name": "expression", "type": "string", "description": "Expression to evaluate." },
{ "name": "objectGroup", "type": "string", "optional": true, "description": "String object group name to put result into (allows rapid releasing resulting object handles using <code>releaseObjectGroup</code>)." },
{ "name": "includeCommandLineAPI", "type": "boolean", "optional": true, "description": "Specifies whether command line API should be available to the evaluated expression, defaults to false." },
{ "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "boolean", "optional": true, "description": "Specifies whether evaluation should stop on exceptions and mute console. Overrides setPauseOnException state." },
{ "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object that should be sent by value." },
{ "name": "generatePreview", "type": "boolean", "optional": true, "description": "Whether preview should be generated for the result." },
{ "name": "saveResult", "type": "boolean", "optional": true, "description": "Whether the resulting value should be considered for saving in the $n history." }
],
"returns": [
{ "name": "result", "$ref": "Runtime.RemoteObject", "description": "Object wrapper for the evaluation result." },
{ "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." },
{ "name": "savedResultIndex", "type": "integer", "optional": true, "description": "If the result was saved, this is the $n index that can be used to access the value." }
]
},
{
"name": "setOverlayMessage",
"description": "Sets overlay message.",
"parameters": [
{ "name": "message", "type": "string", "optional": true, "description": "Overlay message to display when paused in debugger." }
]
}
],
"events": [
{
"name": "globalObjectCleared",
"description": "Called when global has been cleared and debugger client should reset its state. Happens upon navigation or reload."
},
{
"name": "scriptParsed",
"description": "Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger.",
"parameters": [
{ "name": "scriptId", "$ref": "ScriptId", "description": "Identifier of the script parsed." },
{ "name": "url", "type": "string", "description": "URL of the script parsed (if any)." },
{ "name": "startLine", "type": "integer", "description": "Line offset of the script within the resource with given URL (for script tags)." },
{ "name": "startColumn", "type": "integer", "description": "Column offset of the script within the resource with given URL." },
{ "name": "endLine", "type": "integer", "description": "Last line of the script." },
{ "name": "endColumn", "type": "integer", "description": "Length of the last line of the script." },
{ "name": "isContentScript", "type": "boolean", "optional": true, "description": "Determines whether this script is a user extension script." },
{ "name": "sourceURL", "type": "string", "optional": true, "description": "sourceURL name of the script (if any)." },
{ "name": "sourceMapURL", "type": "string", "optional": true, "description": "URL of source map associated with script (if any)." },
{ "name": "module", "type": "boolean", "optional": true, "description": "True if this script was parsed as a module." }
]
},
{
"name": "scriptFailedToParse",
"description": "Fired when virtual machine fails to parse the script.",
"parameters": [
{ "name": "url", "type": "string", "description": "URL of the script that failed to parse." },
{ "name": "scriptSource", "type": "string", "description": "Source text of the script that failed to parse." },
{ "name": "startLine", "type": "integer", "description": "Line offset of the script within the resource." },
{ "name": "errorLine", "type": "integer", "description": "Line with error." },
{ "name": "errorMessage", "type": "string", "description": "Parse error message." }
]
},
{
"name": "breakpointResolved",
"description": "Fired when breakpoint is resolved to an actual script and location.",
"parameters": [
{ "name": "breakpointId", "$ref": "BreakpointId", "description": "Breakpoint unique identifier." },
{ "name": "location", "$ref": "Location", "description": "Actual breakpoint location." }
]
},
{
"name": "paused",
"description": "Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.",
"parameters": [
{ "name": "callFrames", "type": "array", "items": { "$ref": "CallFrame" }, "description": "Call stack the virtual machine stopped on." },
{ "name": "reason", "type": "string", "enum": ["XHR", "DOM", "EventListener", "exception", "assert", "CSPViolation", "DebuggerStatement", "Breakpoint", "PauseOnNextStatement", "other"], "description": "Pause reason." },
{ "name": "data", "type": "object", "optional": true, "description": "Object containing break-specific auxiliary properties." },
{ "name": "asyncStackTrace", "$ref": "Console.StackTrace", "optional": true, "description": "Linked list of asynchronous StackTraces." }
]
},
{
"name": "resumed",
"description": "Fired when the virtual machine resumed execution."
},
{
"name": "didSampleProbe",
"description": "Fires when a new probe sample is collected.",
"parameters": [
{ "name": "sample", "$ref": "ProbeSample", "description": "A collected probe sample." }
]
},
{
"name": "playBreakpointActionSound",
"description": "Fired when a \"sound\" breakpoint action is triggered on a breakpoint.",
"parameters": [
{ "name": "breakpointActionId", "$ref": "BreakpointActionIdentifier", "description": "Breakpoint action identifier." }
]
}
]
}
,
{
"domain": "GenericTypes",
"description": "Exposes generic types to be used by any domain.",
"types": [
{
"id": "SearchMatch",
"type": "object",
"description": "Search match in a resource.",
"properties": [
{ "name": "lineNumber", "type": "number", "description": "Line number in resource content." },
{ "name": "lineContent", "type": "string", "description": "Line with match content." }
]
}
]
}
,
{
"domain": "Heap",
"description": "Heap domain exposes JavaScript heap attributes and capabilities.",
"workerSupported": true,
"types": [
{
"id": "GarbageCollection",
"description": "Information about a garbage collection.",
"type": "object",
"properties": [
{ "name": "type", "type": "string", "enum": ["full", "partial"], "description": "The type of garbage collection." },
{ "name": "startTime", "type": "number" },
{ "name": "endTime", "type": "number" }
]
},
{
"id": "HeapSnapshotData",
"description": "JavaScriptCore HeapSnapshot JSON data.",
"type": "string"
}
],
"commands": [
{
"name": "enable",
"description": "Enables Heap domain events."
},
{
"name": "disable",
"description": "Disables Heap domain events."
},
{
"name": "gc",
"description": "Trigger a full garbage collection."
},
{
"name": "snapshot",
"description": "Take a heap snapshot.",
"returns": [
{ "name": "timestamp", "type": "number" },
{ "name": "snapshotData", "$ref": "HeapSnapshotData" }
]
},
{
"name": "startTracking",
"description": "Start tracking heap changes. This will produce a `trackingStart` event."
},
{
"name": "stopTracking",
"description": "Stop tracking heap changes. This will produce a `trackingComplete` event."
},
{
"name": "getPreview",
"description": "Returns a preview (string, Debugger.FunctionDetails, or Runtime.ObjectPreview) for a Heap.HeapObjectId.",
"parameters": [
{ "name": "heapObjectId", "type": "integer", "description": "Identifier of the heap object within the snapshot." }
],
"returns": [
{ "name": "string", "type": "string", "optional": true, "description": "String value." },
{ "name": "functionDetails", "$ref": "Debugger.FunctionDetails", "optional": true, "description": "Function details." },
{ "name": "preview", "$ref": "Runtime.ObjectPreview", "optional": true, "description": "Object preview." }
]
},
{
"name": "getRemoteObject",
"description": "Returns the strongly referenced Runtime.RemoteObject for a Heap.HeapObjectId.",
"parameters": [
{ "name": "heapObjectId", "type": "integer", "description": "Identifier of the heap object within the snapshot." },
{ "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." }
],
"returns": [
{ "name": "result", "$ref": "Runtime.RemoteObject", "description": "Resulting object." }
]
}
],
"events": [
{
"name": "garbageCollected",
"description": "Information about the garbage collection.",
"parameters": [
{ "name": "collection", "$ref": "GarbageCollection" }
]
},
{
"name": "trackingStart",
"description": "Tracking started.",
"parameters": [
{ "name": "timestamp", "type": "number" },
{ "name": "snapshotData", "$ref": "HeapSnapshotData", "description": "Snapshot at the start of tracking." }
]
},
{
"name": "trackingComplete",
"description": "Tracking stopped.",
"parameters": [
{ "name": "timestamp", "type": "number" },
{ "name": "snapshotData", "$ref": "HeapSnapshotData", "description": "Snapshot at the end of tracking." }
]
}
]
}
,
{
"domain": "IndexedDB",
"featureGuard": "ENABLE(INDEXED_DATABASE)",
"availability": ["web"],
"types": [
{
"id": "DatabaseWithObjectStores",
"type": "object",
"description": "Database with an array of object stores.",
"properties": [
{ "name": "name", "type": "string", "description": "Database name." },
{ "name": "version", "type": "number", "description": "Database version." },
{ "name": "objectStores", "type": "array", "items": { "$ref": "ObjectStore" }, "description": "Object stores in this database." }
]
},
{
"id": "ObjectStore",
"type": "object",
"description": "Object store.",
"properties": [
{ "name": "name", "type": "string", "description": "Object store name." },
{ "name": "keyPath", "$ref": "KeyPath", "description": "Object store key path." },
{ "name": "autoIncrement", "type": "boolean", "description": "If true, object store has auto increment flag set." },
{ "name": "indexes", "type": "array", "items": { "$ref": "ObjectStoreIndex" }, "description": "Indexes in this object store." }
]
},
{
"id": "ObjectStoreIndex",
"type": "object",
"description": "Object store index.",
"properties": [
{ "name": "name", "type": "string", "description": "Index name." },
{ "name": "keyPath", "$ref": "KeyPath", "description": "Index key path." },
{ "name": "unique", "type": "boolean", "description": "If true, index is unique." },
{ "name": "multiEntry", "type": "boolean", "description": "If true, index allows multiple entries for a key." }
]
},
{
"id": "Key",
"type": "object",
"description": "Key.",
"properties": [
{ "name": "type", "type": "string", "enum": ["number", "string", "date", "array"], "description": "Key type." },
{ "name": "number", "type": "number", "optional": true, "description": "Number value." },
{ "name": "string", "type": "string", "optional": true, "description": "String value." },
{ "name": "date", "type": "number", "optional": true, "description": "Date value." },
{ "name": "array", "type": "array", "optional": true, "items": { "$ref": "Key" }, "description": "Array value." }
]
},
{
"id": "KeyRange",
"type": "object",
"description": "Key range.",
"properties": [
{ "name": "lower", "$ref": "Key", "optional": true, "description": "Lower bound." },
{ "name": "upper", "$ref": "Key", "optional": true, "description": "Upper bound." },
{ "name": "lowerOpen", "type": "boolean", "description": "If true lower bound is open." },
{ "name": "upperOpen", "type": "boolean", "description": "If true upper bound is open." }
]
},
{
"id": "DataEntry",
"type": "object",
"description": "Data entry.",
"properties": [
{ "name": "key", "$ref": "Runtime.RemoteObject", "description": "Key." },
{ "name": "primaryKey", "$ref": "Runtime.RemoteObject", "description": "Primary key." },
{ "name": "value", "$ref": "Runtime.RemoteObject", "description": "Value." }
]
},
{
"id": "KeyPath",
"type": "object",
"description": "Key path.",
"properties": [
{ "name": "type", "type": "string", "enum": ["null", "string", "array"], "description": "Key path type." },
{ "name": "string", "type": "string", "optional": true, "description": "String value." },
{ "name": "array", "type": "array", "optional": true, "items": { "type": "string" }, "description": "Array value." }
]
}
],
"commands": [
{
"name": "enable",
"description": "Enables events from backend."
},
{
"name": "disable",
"description": "Disables events from backend."
},
{
"name": "requestDatabaseNames",
"description": "Requests database names for given security origin.",
"async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." }
],
"returns": [
{ "name": "databaseNames", "type": "array", "items": { "type": "string" }, "description": "Database names for origin." }
]
},
{
"name": "requestDatabase",
"description": "Requests database with given name in given frame.",
"async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." },
{ "name": "databaseName", "type": "string", "description": "Database name." }
],
"returns": [
{ "name": "databaseWithObjectStores", "$ref": "DatabaseWithObjectStores", "description": "Database with an array of object stores." }
]
},
{
"name": "requestData",
"description": "Requests data from object store or index.",
"async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." },
{ "name": "databaseName", "type": "string", "description": "Database name." },
{ "name": "objectStoreName", "type": "string", "description": "Object store name." },
{ "name": "indexName", "type": "string", "description": "Index name, empty string for object store data requests." },
{ "name": "skipCount", "type": "integer", "description": "Number of records to skip." },
{ "name": "pageSize", "type": "integer", "description": "Number of records to fetch." },
{ "name": "keyRange", "$ref": "KeyRange", "optional": true, "description": "Key range." }
],
"returns": [
{ "name": "objectStoreDataEntries", "type": "array", "items": { "$ref": "DataEntry" }, "description": "Array of object store data entries." },
{ "name": "hasMore", "type": "boolean", "description": "If true, there are more entries to fetch in the given range." }
]
},
{
"name": "clearObjectStore",
"description": "Clears all entries from an object store.",
"async": true,
"parameters": [
{ "name": "securityOrigin", "type": "string", "description": "Security origin." },
{ "name": "databaseName", "type": "string", "description": "Database name." },
{ "name": "objectStoreName", "type": "string", "description": "Object store name." }
]
}
]
}
,
{
"domain": "Inspector",
"types": [],
"commands": [
{
"name": "enable",
"description": "Enables inspector domain notifications."
},
{
"name": "disable",
"description": "Disables inspector domain notifications."
},
{
"name": "initialized",
"description": "Sent by the frontend after all initialization messages have been sent."
}
],
"events": [
{
"name": "evaluateForTestInFrontend",
"parameters": [
{ "name": "script", "type": "string" }
]
},
{
"name": "inspect",
"parameters": [
{ "name": "object", "$ref": "Runtime.RemoteObject" },
{ "name": "hints", "type": "object" }
]
},
{
"name": "activateExtraDomains",
"description": "Fired when the backend has alternate domains that need to be activated.",
"parameters": [
{ "name": "domains", "type": "array", "items": { "type": "string" }, "description": "Domain names that need activation" }
]
}
]
}
,
{
"domain": "LayerTree",
"availability": ["web"],
"types": [
{
"id": "LayerId",
"type": "string",
"description": "Unique RenderLayer identifier."
},
{
"id": "PseudoElementId",
"type": "string",
"description": "Unique PseudoElement identifier."
},
{
"id": "IntRect",
"type": "object",
"description": "A rectangle.",
"properties": [
{ "name": "x", "type": "integer", "description": "The x position." },
{ "name": "y", "type": "integer", "description": "The y position." },
{ "name": "width", "type": "integer", "description": "The width metric." },
{ "name": "height", "type": "integer", "description": "The height metric." }
]
},
{
"id": "Layer",
"type": "object",
"description": "Information about a compositing layer.",
"properties": [
{ "name": "layerId", "$ref": "LayerId", "description": "The unique id for this layer." },
{ "name": "nodeId", "$ref": "DOM.NodeId", "description": "The id for the node associated with this layer." },
{ "name": "bounds", "$ref": "IntRect", "description": "Bounds of the layer in absolute page coordinates." },
{ "name": "paintCount", "type": "integer", "description": "Indicates how many time this layer has painted." },
{ "name": "memory", "type": "integer", "description": "Estimated memory used by this layer." },
{ "name": "compositedBounds", "$ref": "IntRect", "description": "The bounds of the composited layer." },
{ "name": "isInShadowTree", "type": "boolean", "optional": true, "description": "Indicates whether this layer is associated with an element hosted in a shadow tree." },
{ "name": "isReflection", "type": "boolean", "optional": true, "description": "Indicates whether this layer was used to provide a reflection for the element." },
{ "name": "isGeneratedContent", "type": "boolean", "optional": true, "description": "Indicates whether the layer is attached to a pseudo element that is CSS generated content." },
{ "name": "isAnonymous", "type": "boolean", "optional": true, "description": "Indicates whether the layer was created for a CSS anonymous block or box." },
{ "name": "pseudoElementId", "$ref": "PseudoElementId", "optional": true, "description": "The id for the pseudo element associated with this layer." },
{ "name": "pseudoElement", "type": "string", "optional": true, "description": "The name of the CSS pseudo-element that prompted the layer to be generated." }
]
},
{
"id": "CompositingReasons",
"type": "object",
"description": "An object containing the reasons why the layer was composited as properties.",
"properties": [
{ "name": "transform3D", "type": "boolean", "optional": true, "description": "Composition due to association with an element with a CSS 3D transform." },
{ "name": "video", "type": "boolean", "optional": true, "description": "Composition due to association with a <video> element." },
{ "name": "canvas", "type": "boolean", "optional": true, "description": "Composition due to the element being a <canvas> element." },
{ "name": "plugin", "type": "boolean", "optional": true, "description": "Composition due to association with a plugin." },
{ "name": "iFrame", "type": "boolean", "optional": true, "description": "Composition due to association with an <iframe> element." },
{ "name": "backfaceVisibilityHidden", "type": "boolean", "optional": true, "description": "Composition due to association with an element with a \"backface-visibility: hidden\" style." },
{ "name": "clipsCompositingDescendants", "type": "boolean", "optional": true, "description": "Composition due to association with an element clipping compositing descendants." },
{ "name": "animation", "type": "boolean", "optional": true, "description": "Composition due to association with an animated element." },
{ "name": "filters", "type": "boolean", "optional": true, "description": "Composition due to association with an element with CSS filters applied." },
{ "name": "positionFixed", "type": "boolean", "optional": true, "description": "Composition due to association with an element with a \"position: fixed\" style." },
{ "name": "positionSticky", "type": "boolean", "optional": true, "description": "Composition due to association with an element with a \"position: sticky\" style." },
{ "name": "overflowScrollingTouch", "type": "boolean", "optional": true, "description": "Composition due to association with an element with a \"overflow-scrolling: touch\" style." },
{ "name": "stacking", "type": "boolean", "optional": true, "description": "Composition due to association with an element establishing a stacking context." },
{ "name": "overlap", "type": "boolean", "optional": true, "description": "Composition due to association with an element overlapping other composited elements." },
{ "name": "negativeZIndexChildren", "type": "boolean", "optional": true, "description": "Composition due to association with an element with descendants that have a negative z-index." },
{ "name": "transformWithCompositedDescendants", "type": "boolean", "optional": true, "description": "Composition due to association with an element with composited descendants." },
{ "name": "opacityWithCompositedDescendants", "type": "boolean", "optional": true, "description": "Composition due to association with an element with opacity applied and composited descendants." },
{ "name": "maskWithCompositedDescendants", "type": "boolean", "optional": true, "description": "Composition due to association with a masked element and composited descendants." },
{ "name": "reflectionWithCompositedDescendants", "type": "boolean", "optional": true, "description": "Composition due to association with an element with a reflection and composited descendants." },
{ "name": "filterWithCompositedDescendants", "type": "boolean", "optional": true, "description": "Composition due to association with an element with CSS filters applied and composited descendants." },
{ "name": "blendingWithCompositedDescendants", "type": "boolean", "optional": true, "description": "Composition due to association with an element with CSS blending applied and composited descendants." },
{ "name": "isolatesCompositedBlendingDescendants", "type": "boolean", "optional": true, "description": "Composition due to association with an element isolating compositing descendants having CSS blending applied." },
{ "name": "perspective", "type": "boolean", "optional": true, "description": "Composition due to association with an element with perspective applied." },
{ "name": "preserve3D", "type": "boolean", "optional": true, "description": "Composition due to association with an element with a \"transform-style: preserve-3d\" style." },
{ "name": "willChange", "type": "boolean", "optional": true, "description": "Composition due to association with an element with a \"will-change\" style." },
{ "name": "root", "type": "boolean", "optional": true, "description": "Composition due to association with the root element." },
{ "name": "blending", "type": "boolean", "optional": true, "description": "Composition due to association with an element with a \"blend-mode\" style." }
]
}
],
"commands": [
{
"name": "enable",
"description": "Enables compositing tree inspection."
},
{
"name": "disable",
"description": "Disables compositing tree inspection."
},
{
"name": "layersForNode",
"description": "Returns the layer tree structure of the current page.",
"parameters": [
{ "name": "nodeId", "$ref": "DOM.NodeId", "description": "Root of the subtree for which we want to gather layers." }
],
"returns": [
{ "name": "layers", "type": "array", "items": { "$ref": "Layer" }, "description": "Child layers." }
]
},
{
"name": "reasonsForCompositingLayer",
"description": "Provides the reasons why the given layer was composited.",
"parameters": [
{ "name": "layerId", "$ref": "LayerId", "description": "The id of the layer for which we want to get the reasons it was composited." }
],
"returns": [
{ "name": "compositingReasons", "$ref": "CompositingReasons", "description": "An object containing the reasons why the layer was composited as properties." }
]
}
],
"events": [
{
"name": "layerTreeDidChange"
}
]
}
,
{
"domain": "Memory",
"description": "Memory domain exposes page memory tracking.",
"featureGuard": "ENABLE(RESOURCE_USAGE)",
"availability": ["web"],
"types": [
{
"id": "Event",
"type": "object",
"properties": [
{ "name": "timestamp", "type": "number" },
{ "name": "categories", "type": "array", "items": { "$ref": "CategoryData" }, "description": "Breakdown of memory in categories." }
]
},
{
"id": "CategoryData",
"type": "object",
"properties": [
{ "name": "type", "type": "string", "enum": ["javascript", "jit", "images", "layers", "page", "other"], "description": "Category type." },
{ "name": "size", "type": "number", "description": "Category size in bytes." }
]
}
],
"commands": [
{
"name": "enable",
"description": "Enables Memory domain events."
},
{
"name": "disable",
"description": "Disables Memory domain events."
},
{
"name": "startTracking",
"description": "Start tracking memory. This will produce a `trackingStart` event."
},
{
"name": "stopTracking",
"description": "Stop tracking memory. This will produce a `trackingComplete` event."
}
],
"events": [
{
"name": "memoryPressure",
"description": "Memory pressure was encountered.",
"parameters": [
{ "name": "timestamp", "type": "number" },
{ "name": "severity", "type": "string", "enum": ["critical", "non-critical"], "description": "The severity of the memory pressure event." }
]
},
{
"name": "trackingStart",
"description": "Tracking started.",
"parameters": [
{ "name": "timestamp", "type": "number" }
]
},
{
"name": "trackingUpdate",
"description": "Periodic tracking updates with event data.",
"parameters": [
{ "name": "event", "$ref": "Event" }
]
},
{
"name": "trackingComplete",
"description": "Tracking stopped."
}
]
}
,
{
"domain": "Network",
"description": "Network domain allows tracking network activities of the page. It exposes information about http, file, data and other requests and responses, their headers, bodies, timing, etc.",
"availability": ["web"],
"types": [
{
"id": "LoaderId",
"type": "string",
"description": "Unique loader identifier."
},
{
"id": "FrameId",
"type": "string",
"description": "Unique frame identifier."
},
{
"id": "RequestId",
"type": "string",
"description": "Unique request identifier."
},
{
"id": "Timestamp",
"type": "number",
"description": "Elapsed seconds since frontend connected."
},
{
"id": "Walltime",
"type": "number",
"description": "Number of seconds since epoch."
},
{
"id": "Headers",
"type": "object",
"description": "Request / response headers as keys / values of JSON object."
},
{
"id": "ResourceTiming",
"type": "object",
"description": "Timing information for the request.",
"properties": [
{ "name": "startTime", "type": "number", "description": "Timing's startTime is a baseline in seconds, while the other numbers are ticks in milliseconds relatively to this." },
{ "name": "domainLookupStart", "type": "number", "description": "Started DNS address resolve." },
{ "name": "domainLookupEnd", "type": "number", "description": "Finished DNS address resolve." },
{ "name": "connectStart", "type": "number", "description": "Started connecting to the remote host." },
{ "name": "connectEnd", "type": "number", "description": "Connected to the remote host." },
{ "name": "secureConnectionStart", "type": "number", "description": "Started SSL handshake." },
{ "name": "requestStart", "type": "number", "description": "Started sending request." },
{ "name": "responseStart", "type": "number", "description": "Started receiving response headers." }
]
},
{
"id": "Request",
"type": "object",
"description": "HTTP request data.",
"properties": [
{ "name": "url", "type": "string", "description": "Request URL." },
{ "name": "method", "type": "string", "description": "HTTP request method." },
{ "name": "headers", "$ref": "Headers", "description": "HTTP request headers." },
{ "name": "postData", "type": "string", "optional": true, "description": "HTTP POST request data." }
]
},
{
"id": "Response",
"type": "object",
"description": "HTTP response data.",
"properties": [
{ "name": "url", "type": "string", "description": "Response URL. This URL can be different from CachedResource.url in case of redirect." },
{ "name": "status", "type": "number", "description": "HTTP response status code." },
{ "name": "statusText", "type": "string", "description": "HTTP response status text." },
{ "name": "headers", "$ref": "Headers", "description": "HTTP response headers." },
{ "name": "headersText", "type": "string", "optional": true, "description": "HTTP response headers text." },
{ "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." },
{ "name": "source", "type": "string", "enum": ["unknown", "network", "memory-cache", "disk-cache"], "description": "Specifies where the response came from." },
{ "name": "requestHeaders", "$ref": "Headers", "optional": true, "description": "Refined HTTP request headers that were actually transmitted over the network." },
{ "name": "requestHeadersText", "type": "string", "optional": true, "description": "HTTP request headers text." },
{ "name": "timing", "$ref": "ResourceTiming", "optional": true, "description": "Timing information for the given request." }
]
},
{
"id": "Metrics",
"type": "object",
"description": "Network load metrics.",
"properties": [
{ "name": "protocol", "type": "string", "optional": true, "description": "Network protocol. ALPN Protocol ID Identification Sequence, as per RFC 7301 (for example, http/2, http/1.1, spdy/3.1)" },
{ "name": "priority", "type": "string", "enum": ["low", "medium", "high"], "optional": true, "description": "Network priority." },
{ "name": "connectionIdentifier", "type": "string", "optional": true, "description": "Connection identifier." },
{ "name": "remoteAddress", "type": "string", "optional": true, "description": "Remote IP address." },
{ "name": "requestHeaders", "$ref": "Headers", "optional": true, "description": "Refined HTTP request headers that were actually transmitted over the network." },
{ "name": "requestHeaderBytesSent", "type": "number", "optional": true, "description": "Total HTTP request header bytes sent over the network." },
{ "name": "requestBodyBytesSent", "type": "number", "optional": true, "description": "Total HTTP request body bytes sent over the network." },
{ "name": "responseHeaderBytesReceived", "type": "number", "optional": true, "description": "Total HTTP response header bytes received over the network." },
{ "name": "responseBodyBytesReceived", "type": "number", "optional": true, "description": "Total HTTP response body bytes received over the network." },
{ "name": "responseBodyDecodedSize", "type": "number", "optional": true, "description": "Total decoded response body size in bytes." }
]
},
{
"id": "WebSocketRequest",
"type": "object",
"description": "WebSocket request data.",
"properties": [
{ "name": "headers", "$ref": "Headers", "description": "HTTP response headers." }
]
},
{
"id": "WebSocketResponse",
"type": "object",
"description": "WebSocket response data.",
"properties": [
{ "name": "status", "type": "number", "description": "HTTP response status code." },
{ "name": "statusText", "type": "string", "description": "HTTP response status text." },
{ "name": "headers", "$ref": "Headers", "description": "HTTP response headers." }
]
},
{
"id": "WebSocketFrame",
"type": "object",
"description": "WebSocket frame data.",
"properties": [
{ "name": "opcode", "type": "number", "description": "WebSocket frame opcode." },
{ "name": "mask", "type": "boolean", "description": "WebSocket frame mask." },
{ "name": "payloadData", "type": "string", "description": "WebSocket frame payload data." },
{ "name": "payloadLength", "type": "number", "description": "WebSocket frame payload length in bytes." }
]
},
{
"id": "CachedResource",
"type": "object",
"description": "Information about the cached resource.",
"properties": [
{ "name": "url", "type": "string", "description": "Resource URL. This is the url of the original network request." },
{ "name": "type", "$ref": "Page.ResourceType", "description": "Type of this resource." },
{ "name": "response", "$ref": "Response", "optional": true, "description": "Cached response data." },
{ "name": "bodySize", "type": "number", "description": "Cached response body size." },
{ "name": "sourceMapURL", "type": "string", "optional": true, "description": "URL of source map associated with this resource (if any)." }
]
},
{
"id": "Initiator",
"type": "object",
"description": "Information about the request initiator.",
"properties": [
{ "name": "type", "type": "string", "enum": ["parser", "script", "other"], "description": "Type of this initiator." },
{ "name": "stackTrace", "type": "array", "items": { "$ref": "Console.CallFrame" }, "optional": true, "description": "Initiator JavaScript stack trace, set for Script only." },
{ "name": "url", "type": "string", "optional": true, "description": "Initiator URL, set for Parser type only." },
{ "name": "lineNumber", "type": "number", "optional": true, "description": "Initiator line number, set for Parser type only." }
]
}
],
"commands": [
{
"name": "enable",
"description": "Enables network tracking, network events will now be delivered to the client."
},
{
"name": "disable",
"description": "Disables network tracking, prevents network events from being sent to the client."
},
{
"name": "setExtraHTTPHeaders",
"description": "Specifies whether to always send extra HTTP headers with the requests from this page.",
"parameters": [
{ "name": "headers", "$ref": "Headers", "description": "Map with extra HTTP headers." }
]
},
{
"name": "getResponseBody",
"description": "Returns content served for the given request.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Identifier of the network request to get content for." }
],
"returns": [
{ "name": "body", "type": "string", "description": "Response body." },
{ "name": "base64Encoded", "type": "boolean", "description": "True, if content was sent as base64." }
]
},
{
"name": "setResourceCachingDisabled",
"description": "Toggles whether the resource cache may be used when loading resources in the inspected page. If <code>true</code>, the resource cache will not be used when loading resources.",
"parameters": [
{ "name": "disabled", "type": "boolean", "description": "Whether to prevent usage of the resource cache." }
]
},
{
"name": "loadResource",
"description": "Loads a resource in the context of a frame on the inspected page without cross origin checks.",
"async": true,
"parameters": [
{ "name": "frameId", "$ref": "FrameId", "description": "Frame to load the resource from." },
{ "name": "url", "type": "string", "description": "URL of the resource to load." }
],
"returns": [
{ "name": "content", "type": "string", "description": "Resource content." },
{ "name": "mimeType", "type": "string", "description": "Resource mimeType." },
{ "name": "status", "type": "number", "description": "HTTP response status code." }
]
},
{
"name": "resolveWebSocket",
"description": "Resolves JavaScript WebSocket object for given request id.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Identifier of the WebSocket resource to resolve." },
{ "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." }
],
"returns": [
{ "name": "object", "$ref": "Runtime.RemoteObject", "description": "JavaScript object wrapper for given node." }
]
}
],
"events": [
{
"name": "requestWillBeSent",
"description": "Fired when page is about to send HTTP request.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "frameId", "$ref": "FrameId", "description": "Frame identifier." },
{ "name": "loaderId", "$ref": "LoaderId", "description": "Loader identifier." },
{ "name": "documentURL", "type": "string", "description": "URL of the document this request is loaded for." },
{ "name": "request", "$ref": "Request", "description": "Request data." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "initiator", "$ref": "Initiator", "description": "Request initiator." },
{ "name": "redirectResponse", "optional": true, "$ref": "Response", "description": "Redirect response data." },
{ "name": "type", "$ref": "Page.ResourceType", "optional": true, "description": "Resource type." },
{ "name": "targetId", "type": "string", "optional": true, "description": "Identifier for the context of where the load originated. In general this is the target identifier. For Workers this will be the workerId." }
]
},
{
"name": "responseReceived",
"description": "Fired when HTTP response is available.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "frameId", "$ref": "FrameId", "description": "Frame identifier." },
{ "name": "loaderId", "$ref": "LoaderId", "description": "Loader identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "type", "$ref": "Page.ResourceType", "description": "Resource type." },
{ "name": "response", "$ref": "Response", "description": "Response data." }
]
},
{
"name": "dataReceived",
"description": "Fired when data chunk was received over the network.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "dataLength", "type": "integer", "description": "Data chunk length." },
{ "name": "encodedDataLength", "type": "integer", "description": "Actual bytes received (might be less than dataLength for compressed encodings)." }
]
},
{
"name": "loadingFinished",
"description": "Fired when HTTP request has finished loading.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "sourceMapURL", "type": "string", "optional": true, "description": "URL of source map associated with this resource (if any)." },
{ "name": "metrics", "$ref": "Metrics", "optional": true, "description": "Network metrics." }
]
},
{
"name": "loadingFailed",
"description": "Fired when HTTP request has failed to load.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "errorText", "type": "string", "description": "User friendly error message." },
{ "name": "canceled", "type": "boolean", "optional": true, "description": "True if loading was canceled." }
]
},
{
"name": "requestServedFromMemoryCache",
"description": "Fired when HTTP request has been served from memory cache.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "frameId", "$ref": "FrameId", "description": "Frame identifier." },
{ "name": "loaderId", "$ref": "LoaderId", "description": "Loader identifier." },
{ "name": "documentURL", "type": "string", "description": "URL of the document this request is loaded for." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "initiator", "$ref": "Initiator", "description": "Request initiator." },
{ "name": "resource", "$ref": "CachedResource", "description": "Cached resource data." }
]
},
{
"name": "webSocketWillSendHandshakeRequest",
"description": "Fired when WebSocket is about to initiate handshake.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp" },
{ "name": "walltime", "$ref": "Walltime" },
{ "name": "request", "$ref": "WebSocketRequest", "description": "WebSocket request data." }
]
},
{
"name": "webSocketHandshakeResponseReceived",
"description": "Fired when WebSocket handshake response becomes available.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp" },
{ "name": "response", "$ref": "WebSocketResponse", "description": "WebSocket response data." }
]
},
{
"name": "webSocketCreated",
"description": "Fired upon WebSocket creation.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "url", "type": "string", "description": "WebSocket request URL." }
]
},
{
"name": "webSocketClosed",
"description": "Fired when WebSocket is closed.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." }
]
},
{
"name": "webSocketFrameReceived",
"description": "Fired when WebSocket frame is received.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "response", "$ref": "WebSocketFrame", "description": "WebSocket response data." }
]
},
{
"name": "webSocketFrameError",
"description": "Fired when WebSocket frame error occurs.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "errorMessage", "type": "string", "description": "WebSocket frame error message." }
]
},
{
"name": "webSocketFrameSent",
"description": "Fired when WebSocket frame is sent.",
"parameters": [
{ "name": "requestId", "$ref": "RequestId", "description": "Request identifier." },
{ "name": "timestamp", "$ref": "Timestamp", "description": "Timestamp." },
{ "name": "response", "$ref": "WebSocketFrame", "description": "WebSocket response data." }
]
}
]
}
,
{
"domain": "OverlayTypes",
"description": "Exposes types to be used by the inspector overlay.",
"types": [
{
"id": "Point",
"type": "object",
"properties": [
{ "name": "x", "type": "number" },
{ "name": "y", "type": "number" }
]
},
{
"id": "Size",
"type": "object",
"properties": [
{ "name": "width", "type": "integer" },
{ "name": "height", "type": "integer" }
]
},
{
"id": "Quad",
"description": "A quad is a collection of 4 points. When initialized from a rect, the points are in clockwise order from top left.",
"type": "array",
"items": { "$ref": "Point" }
},
{
"id": "Rect",
"description": "A rectangle specified by a reference coordinate and width/height offsets.",
"type": "object",
"properties": [
{ "name": "x", "type": "number" },
{ "name": "y", "type": "number" },
{ "name": "width", "type": "number" },
{ "name": "height", "type": "number" }
]
},
{
"id": "Region",
"description": "A single region in a flow thread.",
"type": "object",
"properties": [
{ "name": "borderQuad", "$ref": "Quad" },
{ "name": "incomingQuad", "$ref": "Quad" },
{ "name": "outgoingQuad", "$ref": "Quad" },
{ "name": "isHighlighted", "type": "boolean", "optional": true }
]
},
{
"id": "DisplayPath",
"description": "A vector path described using SVG path syntax.",
"type": "array",
"items": { "type": "any" }
},
{
"id": "RegionFlowData",
"type": "object",
"properties": [
{ "name": "regions", "type": "array", "items": { "$ref": "Region"} },
{ "name": "name", "type": "string" }
]
},
{
"id": "ContentFlowData",
"type": "object",
"properties": [
{ "name": "name", "type": "string" }
]
},
{
"id": "ShapeOutsideData",
"type": "object",
"properties": [
{ "name": "bounds", "$ref": "Quad", "description": "Bounds for the shape-outside paths." },
{ "name": "shape", "$ref": "DisplayPath", "description": "Path for the element's shape.", "optional": true },
{ "name": "marginShape", "$ref": "DisplayPath", "description": "Path for the element's margin shape.", "optional": true }
]
},
{
"id": "ElementData",
"description": "Data that describes an element to be highlighted.",
"type": "object",
"properties": [
{ "name": "tagName", "type": "string" },
{ "name": "idValue", "type": "string", "description": "The value of the element's 'id' attribute." },
{ "name": "classes", "type": "array", "items": { "type": "string" }, "optional": true },
{ "name": "size", "$ref": "Size", "optional": true },
{ "name": "role", "type": "string", "description": "Computed accessibility role for the element.", "optional": true },
{ "name": "pseudoElement", "type": "string", "optional": true },
{ "name": "regionFlowData", "$ref": "RegionFlowData", "optional": true },
{ "name": "contentFlowData", "$ref": "ContentFlowData", "optional": true },
{ "name": "shapeOutsideData", "$ref": "ShapeOutsideData", "optional": true }
]
},
{
"id": "FragmentHighlightData",
"description": "Data required to highlight multiple quads.",
"type": "object",
"properties": [
{ "name": "quads", "type": "array", "items": { "$ref": "Quad" }, "description": "Quads for which the highlight should be applied."},
{ "name": "contentColor", "type": "string" },
{ "name": "contentOutlineColor", "type": "string" },
{ "name": "paddingColor", "type": "string" },
{ "name": "borderColor", "type": "string" },
{ "name": "marginColor", "type": "string" },
{ "name": "regionClippingArea", "$ref": "Quad", "optional": true }
]
},
{
"id": "NodeHighlightData",
"description": "Data required to highlight a DOM node.",
"type": "object",
"properties": [
{ "name": "scrollOffset", "$ref": "Point", "description": "Scroll offset for the MainFrame's FrameView that is shared across all quads." },
{ "name": "fragments", "type": "array", "items": { "$ref": "FragmentHighlightData" } },
{ "name": "elementData", "$ref": "ElementData", "optional": true }
]
},
{
"id": "OverlayConfiguration",
"description": "Data required to configure the overlay's size and scaling behavior.",
"type": "object",
"properties": [
{ "name": "deviceScaleFactor", "type": "number" },
{ "name": "viewportSize", "$ref": "Size" },
{ "name": "frameViewFullSize", "$ref": "Size" }
]
}
]
}
,
{
"domain": "Page",
"description": "Actions and events related to the inspected page belong to the page domain.",
"availability": ["web"],
"types": [
{
"id": "ResourceType",
"type": "string",
"enum": ["Document", "Stylesheet", "Image", "Font", "Script", "XHR", "Fetch", "WebSocket", "Other"],
"description": "Resource type as it was perceived by the rendering engine."
},
{
"id": "CoordinateSystem",
"type": "string",
"enum": ["Viewport", "Page"],
"description": "Coordinate system used by supplied coordinates."
},
{
"id": "Frame",
"type": "object",
"description": "Information about the Frame on the page.",
"properties": [
{ "name": "id", "type": "string", "description": "Frame unique identifier." },
{ "name": "parentId", "type": "string", "optional": true, "description": "Parent frame identifier." },
{ "name": "loaderId", "$ref": "Network.LoaderId", "description": "Identifier of the loader associated with this frame." },
{ "name": "name", "type": "string", "optional": true, "description": "Frame's name as specified in the tag." },
{ "name": "url", "type": "string", "description": "Frame document's URL." },
{ "name": "securityOrigin", "type": "string", "description": "Frame document's security origin." },
{ "name": "mimeType", "type": "string", "description": "Frame document's mimeType as determined by the browser." }
]
},
{
"id": "FrameResource",
"type": "object",
"properties": [
{ "name": "url", "type": "string", "description": "Resource URL." },
{ "name": "type", "$ref": "ResourceType", "description": "Type of this resource." },
{ "name": "mimeType", "type": "string", "description": "Resource mimeType as determined by the browser." },
{ "name": "failed", "type": "boolean", "optional": true, "description": "True if the resource failed to load." },
{ "name": "canceled", "type": "boolean", "optional": true, "description": "True if the resource was canceled during loading." },
{ "name": "sourceMapURL", "type": "string", "optional": true, "description": "URL of source map associated with this resource (if any)." },
{ "name": "targetId", "type": "string", "optional": true, "description": "Identifier for the context of where the load originated. In general this is the target identifier. For Workers this will be the workerId." }
]
},
{
"id": "FrameResourceTree",
"type": "object",
"description": "Information about the Frame hierarchy along with their cached resources.",
"properties": [
{ "name": "frame", "$ref": "Frame", "description": "Frame information for this tree item." },
{ "name": "childFrames", "type": "array", "optional": true, "items": { "$ref": "FrameResourceTree" }, "description": "Child frames." },
{ "name": "resources", "type": "array", "items": { "$ref": "FrameResource" }, "description": "Information about frame resources." }
]
},
{
"id": "SearchResult",
"type": "object",
"description": "Search result for resource.",
"properties": [
{ "name": "url", "type": "string", "description": "Resource URL." },
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Resource frame id." },
{ "name": "matchesCount", "type": "number", "description": "Number of matches in the resource content." },
{ "name": "requestId", "$ref": "Network.RequestId", "optional": true, "description": "Network request id." }
]
},
{
"id": "Cookie",
"type": "object",
"description": "Cookie object",
"properties": [
{ "name": "name", "type": "string", "description": "Cookie name." },
{ "name": "value", "type": "string", "description": "Cookie value." },
{ "name": "domain", "type": "string", "description": "Cookie domain." },
{ "name": "path", "type": "string", "description": "Cookie path." },
{ "name": "expires", "type": "number", "description": "Cookie expires." },
{ "name": "size", "type": "integer", "description": "Cookie size." },
{ "name": "httpOnly", "type": "boolean", "description": "True if cookie is http-only." },
{ "name": "secure", "type": "boolean", "description": "True if cookie is secure." },
{ "name": "session", "type": "boolean", "description": "True in case of session cookie." }
]
}
],
"commands": [
{
"name": "enable",
"description": "Enables page domain notifications."
},
{
"name": "disable",
"description": "Disables page domain notifications."
},
{
"name": "reload",
"description": "Reloads the main frame of the inspected page.",
"parameters": [
{ "name": "ignoreCache", "type": "boolean", "optional": true, "description": "If true, browser cache is ignored (as if the user pressed Shift+refresh)." },
{ "name": "revalidateAllResources", "type": "boolean", "optional": true, "description": "If true, all cached subresources will be revalidated when the main resource loads. Otherwise, only expired cached subresources will be revalidated (the default behavior for most WebKit clients)." },
{ "name": "scriptToEvaluateOnLoad", "type": "string", "optional": true, "description": "If set, the script will be injected into all frames of the inspected page after reload." }
]
},
{
"name": "navigate",
"description": "Navigates current page to the given URL.",
"parameters": [
{ "name": "url", "type": "string", "description": "URL to navigate the page to." }
]
},
{
"name": "getCookies",
"description": "Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the <code>cookies</code> field.",
"returns": [
{ "name": "cookies", "type": "array", "items": { "$ref": "Cookie"}, "description": "Array of cookie objects." }
]
},
{
"name": "deleteCookie",
"description": "Deletes browser cookie with given name, domain and path.",
"parameters": [
{ "name": "cookieName", "type": "string", "description": "Name of the cookie to remove." },
{ "name": "url", "type": "string", "description": "URL to match cookie domain and path." }
]
},
{
"name": "getResourceTree",
"description": "Returns present frame / resource tree structure.",
"returns": [
{ "name": "frameTree", "$ref": "FrameResourceTree", "description": "Present frame / resource tree structure." }
]
},
{
"name": "getResourceContent",
"description": "Returns content of the given resource.",
"parameters": [
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Frame id to get resource for." },
{ "name": "url", "type": "string", "description": "URL of the resource to get content for." }
],
"returns": [
{ "name": "content", "type": "string", "description": "Resource content." },
{ "name": "base64Encoded", "type": "boolean", "description": "True, if content was served as base64." }
]
},
{
"name": "searchInResource",
"description": "Searches for given string in resource content.",
"parameters": [
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Frame id for resource to search in." },
{ "name": "url", "type": "string", "description": "URL of the resource to search in." },
{ "name": "query", "type": "string", "description": "String to search for." },
{ "name": "caseSensitive", "type": "boolean", "optional": true, "description": "If true, search is case sensitive." },
{ "name": "isRegex", "type": "boolean", "optional": true, "description": "If true, treats string parameter as regex." },
{ "name": "requestId", "$ref": "Network.RequestId", "optional": true, "description": "Request id for resource to search in." }
],
"returns": [
{ "name": "result", "type": "array", "items": { "$ref": "GenericTypes.SearchMatch" }, "description": "List of search matches." }
]
},
{
"name": "searchInResources",
"description": "Searches for given string in frame / resource tree structure.",
"parameters": [
{ "name": "text", "type": "string", "description": "String to search for." },
{ "name": "caseSensitive", "type": "boolean", "optional": true, "description": "If true, search is case sensitive." },
{ "name": "isRegex", "type": "boolean", "optional": true, "description": "If true, treats string parameter as regex." }
],
"returns": [
{ "name": "result", "type": "array", "items": { "$ref": "SearchResult" }, "description": "List of search results." }
]
},
{
"name": "setShowPaintRects",
"description": "Requests that backend shows paint rectangles",
"parameters": [
{ "name": "result", "type": "boolean", "description": "True for showing paint rectangles" }
]
},
{
"name": "setEmulatedMedia",
"description": "Emulates the given media for CSS media queries.",
"parameters": [
{ "name": "media", "type": "string", "description": "Media type to emulate. Empty string disables the override." }
]
},
{
"name": "getCompositingBordersVisible",
"description": "Indicates the visibility of compositing borders.",
"returns": [
{ "name": "result", "type": "boolean", "description": "If true, compositing borders are visible." }
]
},
{
"name": "setCompositingBordersVisible",
"description": "Controls the visibility of compositing borders.",
"parameters": [
{ "name": "visible", "type": "boolean", "description": "True for showing compositing borders." }
]
},
{
"name": "snapshotNode",
"description": "Capture a snapshot of the specified node that does not include unrelated layers.",
"parameters": [
{ "name": "nodeId", "$ref": "DOM.NodeId", "description": "Id of the node to snapshot." }
],
"returns": [
{ "name": "dataURL", "type": "string", "description": "Base64-encoded image data (PNG)." }
]
},
{
"name": "snapshotRect",
"description": "Capture a snapshot of the page within the specified rectangle and coordinate system.",
"parameters": [
{ "name": "x", "type": "integer", "description": "X coordinate" },
{ "name": "y", "type": "integer", "description": "Y coordinate" },
{ "name": "width", "type": "integer", "description": "Rectangle width" },
{ "name": "height", "type": "integer", "description": "Rectangle height" },
{ "name": "coordinateSystem", "$ref": "CoordinateSystem", "description": "Indicates the coordinate system of the supplied rectangle." }
],
"returns": [
{ "name": "dataURL", "type": "string", "description": "Base64-encoded image data (PNG)." }
]
},
{
"name": "archive",
"description": "Grab an archive of the page.",
"returns": [
{ "name": "data", "type": "string", "description": "Base64-encoded web archive." }
]
}
],
"events": [
{
"name": "domContentEventFired",
"parameters": [
{ "name": "timestamp", "type": "number" }
]
},
{
"name": "loadEventFired",
"parameters": [
{ "name": "timestamp", "type": "number" }
]
},
{
"name": "frameNavigated",
"description": "Fired once navigation of the frame has completed. Frame is now associated with the new loader.",
"parameters": [
{ "name": "frame", "$ref": "Frame", "description": "Frame object." }
]
},
{
"name": "frameDetached",
"description": "Fired when frame has been detached from its parent.",
"parameters": [
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Id of the frame that has been detached." }
]
},
{
"name": "frameStartedLoading",
"description": "Fired when frame has started loading.",
"parameters": [
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Id of the frame that has started loading." }
]
},
{
"name": "frameStoppedLoading",
"description": "Fired when frame has stopped loading.",
"parameters": [
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Id of the frame that has stopped loading." }
]
},
{
"name": "frameScheduledNavigation",
"description": "Fired when frame schedules a potential navigation.",
"parameters": [
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Id of the frame that has scheduled a navigation." },
{ "name": "delay", "type": "number", "description": "Delay (in seconds) until the navigation is scheduled to begin. The navigation is not guaranteed to start." }
]
},
{
"name": "frameClearedScheduledNavigation",
"description": "Fired when frame no longer has a scheduled navigation.",
"parameters": [
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Id of the frame that has cleared its scheduled navigation." }
]
}
]
}
,
{
"domain": "Runtime",
"description": "Runtime domain exposes JavaScript runtime by means of remote evaluation and mirror objects. Evaluation results are returned as mirror object that expose object type, string representation and unique identifier that can be used for further object reference. Original objects are maintained in memory unless they are either explicitly released or are released along with the other objects in their object group.",
"workerSupported": true,
"types": [
{
"id": "RemoteObjectId",
"type": "string",
"description": "Unique object identifier."
},
{
"id": "RemoteObject",
"type": "object",
"description": "Mirror object referencing original JavaScript object.",
"properties": [
{ "name": "type", "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean", "symbol"], "description": "Object type." },
{ "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date", "error", "map", "set", "weakmap", "weakset", "iterator", "class", "proxy"], "description": "Object subtype hint. Specified for <code>object</code> <code>function</code> (for class) type values only." },
{ "name": "className", "type": "string", "optional": true, "description": "Object class (constructor) name. Specified for <code>object</code> type values only." },
{ "name": "value", "type": "any", "optional": true, "description": "Remote object value (in case of primitive values or JSON values if it was requested)." },
{ "name": "description", "type": "string", "optional": true, "description": "String representation of the object." },
{ "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Unique object identifier (for non-primitive values)." },
{ "name": "size", "type": "integer", "optional": true, "description": "Size of the array/collection. Specified for array/map/set/weakmap/weakset object type values only." },
{ "name": "classPrototype", "$ref": "RemoteObject", "optional": true, "description": "Remote object for the class prototype. Specified for class object type values only." },
{ "name": "preview", "$ref": "ObjectPreview", "optional": true, "description": "Preview containing abbreviated property values. Specified for <code>object</code> type values only." }
]
},
{
"id": "ObjectPreview",
"type": "object",
"description": "Object containing abbreviated remote object value.",
"properties": [
{ "name": "type", "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean", "symbol"], "description": "Object type." },
{ "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date", "error", "map", "set", "weakmap", "weakset", "iterator", "class", "proxy"], "description": "Object subtype hint. Specified for <code>object</code> type values only." },
{ "name": "description", "type": "string", "optional": true, "description": "String representation of the object." },
{ "name": "lossless", "type": "boolean", "description": "Determines whether preview is lossless (contains all information of the original object)." },
{ "name": "overflow", "type": "boolean", "optional": true, "description": "True iff some of the properties of the original did not fit." },
{ "name": "properties", "type": "array", "items": { "$ref": "PropertyPreview" }, "optional": true, "description": "List of the properties." },
{ "name": "entries", "type": "array", "items": { "$ref": "EntryPreview" }, "optional": true, "description": "List of the entries. Specified for <code>map</code> and <code>set</code> subtype values only." },
{ "name": "size", "type": "integer", "optional": true, "description": "Size of the array/collection. Specified for array/map/set/weakmap/weakset object type values only." }
]
},
{
"id": "PropertyPreview",
"type": "object",
"properties": [
{ "name": "name", "type": "string", "description": "Property name." },
{ "name": "type", "type": "string", "enum": ["object", "function", "undefined", "string", "number", "boolean", "symbol", "accessor"], "description": "Object type." },
{ "name": "subtype", "type": "string", "optional": true, "enum": ["array", "null", "node", "regexp", "date", "error", "map", "set", "weakmap", "weakset", "iterator", "class", "proxy"], "description": "Object subtype hint. Specified for <code>object</code> type values only." },
{ "name": "value", "type": "string", "optional": true, "description": "User-friendly property value string." },
{ "name": "valuePreview", "$ref": "ObjectPreview", "optional": true, "description": "Nested value preview." },
{ "name": "internal", "type": "boolean", "optional": true, "description": "True if this is an internal property." }
]
},
{
"id": "EntryPreview",
"type": "object",
"properties": [
{ "name": "key", "$ref": "ObjectPreview", "optional": true, "description": "Entry key. Specified for map-like collection entries." },
{ "name": "value", "$ref": "ObjectPreview", "description": "Entry value." }
]
},
{
"id": "CollectionEntry",
"type": "object",
"properties": [
{ "name": "key", "$ref": "Runtime.RemoteObject", "optional": true, "description": "Entry key of a map-like collection, otherwise not provided." },
{ "name": "value", "$ref": "Runtime.RemoteObject", "description": "Entry value." }
]
},
{
"id": "PropertyDescriptor",
"type": "object",
"description": "Object property descriptor.",
"properties": [
{ "name": "name", "type": "string", "description": "Property name or symbol description." },
{ "name": "value", "$ref": "RemoteObject", "optional": true, "description": "The value associated with the property." },
{ "name": "writable", "type": "boolean", "optional": true, "description": "True if the value associated with the property may be changed (data descriptors only)." },
{ "name": "get", "$ref": "RemoteObject", "optional": true, "description": "A function which serves as a getter for the property, or <code>undefined</code> if there is no getter (accessor descriptors only)." },
{ "name": "set", "$ref": "RemoteObject", "optional": true, "description": "A function which serves as a setter for the property, or <code>undefined</code> if there is no setter (accessor descriptors only)." },
{ "name": "configurable", "type": "boolean", "description": "True if the type of this property descriptor may be changed and if the property may be deleted from the corresponding object." },
{ "name": "enumerable", "type": "boolean", "description": "True if this property shows up during enumeration of the properties on the corresponding object." },
{ "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." },
{ "name": "isOwn", "optional": true, "type": "boolean", "description": "True if the property is owned for the object." },
{ "name": "symbol", "optional": true, "$ref": "Runtime.RemoteObject", "description": "Property symbol object, if the property is a symbol." },
{ "name": "nativeGetter", "optional": true, "type": "boolean", "description": "True if the property value came from a native getter." }
]
},
{
"id": "InternalPropertyDescriptor",
"type": "object",
"description": "Object internal property descriptor. This property isn't normally visible in JavaScript code.",
"properties": [
{ "name": "name", "type": "string", "description": "Conventional property name." },
{ "name": "value", "$ref": "RemoteObject", "optional": true, "description": "The value associated with the property." }
]
},
{
"id": "CallArgument",
"type": "object",
"description": "Represents function call argument. Either remote object id <code>objectId</code> or primitive <code>value</code> or neither of (for undefined) them should be specified.",
"properties": [
{ "name": "value", "type": "any", "optional": true, "description": "Primitive value." },
{ "name": "objectId", "$ref": "RemoteObjectId", "optional": true, "description": "Remote object handle." }
]
},
{
"id": "ExecutionContextId",
"type": "integer",
"description": "Id of an execution context."
},
{
"id": "ExecutionContextDescription",
"type": "object",
"description": "Description of an isolated world.",
"properties": [
{ "name": "id", "$ref": "ExecutionContextId", "description": "Unique id of the execution context. It can be used to specify in which execution context script evaluation should be performed." },
{ "name": "isPageContext", "type": "boolean", "description": "True if this is a context where inpspected web page scripts run. False if it is a content script isolated context." },
{ "name": "name", "type": "string", "description": "Human readable name describing given context."},
{ "name": "frameId", "$ref": "Network.FrameId", "description": "Id of the owning frame." }
]
},
{
"id": "SyntaxErrorType",
"type": "string",
"enum": ["none", "irrecoverable", "unterminated-literal", "recoverable"],
"description": "Syntax error type: \"none\" for no error, \"irrecoverable\" for unrecoverable errors, \"unterminated-literal\" for when there is an unterminated literal, \"recoverable\" for when the expression is unfinished but valid so far."
},
{
"id": "ErrorRange",
"type": "object",
"description": "Range of an error in source code.",
"properties": [
{ "name": "startOffset", "type": "integer", "description": "Start offset of range (inclusive)." },
{ "name": "endOffset", "type": "integer", "description": "End offset of range (exclusive)." }
]
},
{
"id": "StructureDescription",
"type": "object",
"properties": [
{ "name": "fields", "type": "array", "items": { "type": "string" }, "optional": true, "description": "Array of strings, where the strings represent object properties." },
{ "name": "optionalFields", "type": "array", "items": { "type": "string" }, "optional": true, "description": "Array of strings, where the strings represent optional object properties." },
{ "name": "constructorName", "type": "string", "optional": true, "description": "Name of the constructor." },
{ "name": "prototypeStructure", "$ref": "StructureDescription", "optional": true, "description": "Pointer to the StructureRepresentation of the protoype if one exists." },
{ "name": "isImprecise", "type": "boolean", "optional": true, "description": "If true, it indicates that the fields in this StructureDescription may be inaccurate. I.e, there might have been fields that have been deleted before it was profiled or it has fields we haven't profiled." }
]
},
{
"id": "TypeSet",
"type": "object",
"properties": [
{ "name": "isFunction", "type": "boolean", "description": "Indicates if this type description has been type Function." },
{ "name": "isUndefined", "type": "boolean", "description": "Indicates if this type description has been type Undefined." },
{ "name": "isNull", "type": "boolean", "description": "Indicates if this type description has been type Null." },
{ "name": "isBoolean", "type": "boolean", "description": "Indicates if this type description has been type Boolean." },
{ "name": "isInteger", "type": "boolean", "description": "Indicates if this type description has been type Integer." },
{ "name": "isNumber", "type": "boolean", "description": "Indicates if this type description has been type Number." },
{ "name": "isString", "type": "boolean", "description": "Indicates if this type description has been type String." },
{ "name": "isObject", "type": "boolean", "description": "Indicates if this type description has been type Object." },
{ "name": "isSymbol", "type": "boolean", "description": "Indicates if this type description has been type Symbol." }
]
},
{
"id": "TypeDescription",
"type": "object",
"description": "Container for type information that has been gathered.",
"properties": [
{ "name": "isValid", "type": "boolean", "description": "If true, we were able to correlate the offset successfuly with a program location. If false, the offset may be bogus or the offset may be from a CodeBlock that hasn't executed." },
{ "name": "leastCommonAncestor", "type": "string", "optional": true, "description": "Least common ancestor of all Constructors if the TypeDescription has seen any structures. This string is the display name of the shared constructor function." },
{ "name": "typeSet", "$ref": "TypeSet", "optional": true, "description": "Set of booleans for determining the aggregate type of this type description." },
{ "name": "structures", "type": "array", "items": { "$ref": "StructureDescription" }, "optional": true, "description": "Array of descriptions for all structures seen for this variable." },
{ "name": "isTruncated", "type": "boolean", "optional": true, "description": "If true, this indicates that no more structures are being profiled because some maximum threshold has been reached and profiling has stopped because of memory pressure." }
]
},
{
"id": "TypeLocation",
"type": "object",
"description": "Describes the location of an expression we want type information for.",
"properties": [
{ "name": "typeInformationDescriptor", "type": "integer", "description": "What kind of type information do we want (normal, function return values, 'this' statement)." },
{ "name": "sourceID", "type": "string", "description": "sourceID uniquely identifying a script" },
{ "name": "divot", "type": "integer", "description": "character offset for assignment range" }
]
},
{
"id": "BasicBlock",
"type": "object",
"description": "From Wikipedia: a basic block is a portion of the code within a program with only one entry point and only one exit point. This type gives the location of a basic block and if that basic block has executed.",
"properties": [
{ "name": "startOffset", "type": "integer", "description": "Start offset of the basic block." },
{ "name": "endOffset", "type": "integer", "description": "End offset of the basic block." },
{ "name": "hasExecuted", "type": "boolean", "description": "Indicates if the basic block has executed before." },
{ "name": "executionCount", "type": "integer", "description": "Indicates how many times the basic block has executed." }
]
}
],
"commands": [
{
"name": "parse",
"description": "Parses JavaScript source code for errors.",
"parameters": [
{ "name": "source", "type": "string", "description": "Source code to parse." }
],
"returns": [
{ "name": "result", "$ref": "SyntaxErrorType", "description": "Parse result." },
{ "name": "message", "type": "string", "optional": true, "description": "Parse error message." },
{ "name": "range", "$ref": "ErrorRange", "optional": true, "description": "Range in the source where the error occurred." }
]
},
{
"name": "evaluate",
"description": "Evaluates expression on global object.",
"parameters": [
{ "name": "expression", "type": "string", "description": "Expression to evaluate." },
{ "name": "objectGroup", "type": "string", "optional": true, "description": "Symbolic group name that can be used to release multiple objects." },
{ "name": "includeCommandLineAPI", "type": "boolean", "optional": true, "description": "Determines whether Command Line API should be available during the evaluation." },
{ "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "boolean", "optional": true, "description": "Specifies whether evaluation should stop on exceptions and mute console. Overrides setPauseOnException state." },
{ "name": "contextId", "$ref": "Runtime.ExecutionContextId", "optional": true, "description": "Specifies in which isolated context to perform evaluation. Each content script lives in an isolated context and this parameter may be used to specify one of those contexts. If the parameter is omitted or 0 the evaluation will be performed in the context of the inspected page." },
{ "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object that should be sent by value." },
{ "name": "generatePreview", "type": "boolean", "optional": true, "description": "Whether preview should be generated for the result." },
{ "name": "saveResult", "type": "boolean", "optional": true, "description": "Whether the resulting value should be considered for saving in the $n history." }
],
"returns": [
{ "name": "result", "$ref": "RemoteObject", "description": "Evaluation result." },
{ "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." },
{ "name": "savedResultIndex", "type": "integer", "optional": true, "description": "If the result was saved, this is the $n index that can be used to access the value." }
]
},
{
"name": "callFunctionOn",
"description": "Calls function with given declaration on the given object. Object group of the result is inherited from the target object.",
"parameters": [
{ "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to call function on." },
{ "name": "functionDeclaration", "type": "string", "description": "Declaration of the function to call." },
{ "name": "arguments", "type": "array", "items": { "$ref": "CallArgument", "description": "Call argument." }, "optional": true, "description": "Call arguments. All call arguments must belong to the same JavaScript world as the target object." },
{ "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "boolean", "optional": true, "description": "Specifies whether function call should stop on exceptions and mute console. Overrides setPauseOnException state." },
{ "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object which should be sent by value." },
{ "name": "generatePreview", "type": "boolean", "optional": true, "description": "Whether preview should be generated for the result." }
],
"returns": [
{ "name": "result", "$ref": "RemoteObject", "description": "Call result." },
{ "name": "wasThrown", "type": "boolean", "optional": true, "description": "True if the result was thrown during the evaluation." }
]
},
{
"name": "getPreview",
"description": "Returns a preview for the given object.",
"parameters": [
{ "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to return a preview for." }
],
"returns": [
{ "name": "preview", "$ref": "ObjectPreview" }
]
},
{
"name": "getProperties",
"description": "Returns properties of a given object. Object group of the result is inherited from the target object.",
"parameters": [
{ "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to return properties for." },
{ "name": "ownProperties", "optional": true, "type": "boolean", "description": "If true, returns properties belonging only to the object itself, not to its prototype chain." },
{ "name": "generatePreview", "type": "boolean", "optional": true, "description": "Whether preview should be generated for property values." }
],
"returns": [
{ "name": "result", "type": "array", "items": { "$ref": "PropertyDescriptor"}, "description": "Object properties." },
{ "name": "internalProperties", "optional": true, "type": "array", "items": { "$ref": "InternalPropertyDescriptor"}, "description": "Internal object properties." }
]
},
{
"name": "getDisplayableProperties",
"description": "Returns displayable properties of a given object. Object group of the result is inherited from the target object. Displayable properties are own properties, internal properties, and native getters in the prototype chain (assumed to be bindings and treated like own properties for the frontend).",
"parameters": [
{ "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to return properties for." },
{ "name": "generatePreview", "type": "boolean", "optional": true, "description": "Whether preview should be generated for property values." }
],
"returns": [
{ "name": "properties", "type": "array", "items": { "$ref": "PropertyDescriptor"}, "description": "Object properties." },
{ "name": "internalProperties", "optional": true, "type": "array", "items": { "$ref": "InternalPropertyDescriptor"}, "description": "Internal object properties." }
]
},
{
"name": "getCollectionEntries",
"description": "Returns entries of given Map / Set collection.",
"parameters": [
{ "name": "objectId", "$ref": "Runtime.RemoteObjectId", "description": "Id of the collection to get entries for." },
{ "name": "objectGroup", "optional": true, "type": "string", "description": "Symbolic group name that can be used to release multiple. If not provided, it will be the same objectGroup as the RemoteObject determined from <code>objectId</code>. This is useful for WeakMap to release the collection entries." },
{ "name": "startIndex", "optional": true, "type": "integer", "description": "If provided skip to this index before collecting values. Otherwise, 0." },
{ "name": "numberToFetch", "optional": true, "type": "integer", "description": "If provided only return <code>numberToFetch</code> values. Otherwise, return values all the way to the end." }
],
"returns": [
{ "name": "entries", "type": "array", "items": { "$ref": "CollectionEntry" }, "description": "Array of collection entries." }
]
},
{
"name": "saveResult",
"description": "Assign a saved result index to this value.",
"parameters": [
{ "name": "value", "$ref": "CallArgument", "description": "Id or value of the object to save." },
{ "name": "contextId", "optional": true, "$ref": "ExecutionContextId", "description": "Unique id of the execution context. To specify in which execution context script evaluation should be performed. If not provided, determine from the CallArgument's objectId." }
],
"returns": [
{ "name": "savedResultIndex", "type": "integer", "optional": true, "description": "If the value was saved, this is the $n index that can be used to access the value." }
]
},
{
"name": "releaseObject",
"description": "Releases remote object with given id.",
"parameters": [
{ "name": "objectId", "$ref": "RemoteObjectId", "description": "Identifier of the object to release." }
]
},
{
"name": "releaseObjectGroup",
"description": "Releases all remote objects that belong to a given group.",
"parameters": [
{ "name": "objectGroup", "type": "string", "description": "Symbolic object group name." }
]
},
{
"name": "enable",
"description": "Enables reporting of execution contexts creation by means of <code>executionContextCreated</code> event. When the reporting gets enabled the event will be sent immediately for each existing execution context."
},
{
"name": "disable",
"description": "Disables reporting of execution contexts creation."
},
{
"name": "getRuntimeTypesForVariablesAtOffsets",
"description": "Returns detailed information on the given function.",
"parameters": [
{ "name": "locations", "type": "array", "items": { "$ref": "TypeLocation" }, "description": "An array of type locations we're requesting information for. Results are expected in the same order they're sent in."}
],
"returns": [
{ "name": "types", "type": "array", "items": { "$ref": "TypeDescription", "description": "Types for requested variable." } }
]
},
{
"name": "enableTypeProfiler",
"description": "Enables type profiling on the VM."
},
{
"name": "disableTypeProfiler",
"description": "Disables type profiling on the VM."
},
{
"name": "enableControlFlowProfiler",
"description": "Enables control flow profiling on the VM."
},
{
"name": "disableControlFlowProfiler",
"description": "Disables control flow profiling on the VM."
},
{
"name": "getBasicBlocks",
"description": "Returns a list of basic blocks for the given sourceID with information about their text ranges and whether or not they have executed.",
"parameters": [
{ "name": "sourceID", "type": "string", "description": "Indicates which sourceID information is requested for." }
],
"returns": [
{ "name": "basicBlocks", "type": "array", "items": { "$ref": "BasicBlock", "description": "Array of basic blocks." } }
]
}
],
"events": [
{
"name": "executionContextCreated",
"description": "Issued when new execution context is created.",
"parameters": [
{ "name": "context", "$ref": "ExecutionContextDescription", "description": "A newly created execution context." }
]
}
]
}
,
{
"domain": "ScriptProfiler",
"description": "Profiler domain exposes JavaScript evaluation timing and profiling.",
"types": [
{
"id": "EventType",
"type": "string",
"enum": ["API", "Microtask", "Other"]
},
{
"id": "Event",
"type": "object",
"properties": [
{ "name": "startTime", "type": "number" },
{ "name": "endTime", "type": "number" },
{ "name": "type", "$ref": "EventType" }
]
},
{
"id": "ExpressionLocation",
"type": "object",
"properties": [
{ "name": "line", "type": "integer", "description": "1-based." },
{ "name": "column", "type": "integer", "description": "1-based." }
]
},
{
"id": "StackFrame",
"type": "object",
"properties": [
{ "name": "sourceID", "$ref": "Debugger.ScriptId", "description": "Unique script identifier." },
{ "name": "name", "type": "string", "description": "A displayable name for the stack frame. i.e function name, (program), etc." },
{ "name": "line", "type": "integer", "description": "-1 if unavailable. 1-based if available." },
{ "name": "column", "type": "integer", "description": "-1 if unavailable. 1-based if available." },
{ "name": "url", "type": "string" },
{ "name": "expressionLocation", "$ref": "ExpressionLocation", "optional": true }
]
},
{
"id": "StackTrace",
"type": "object",
"properties": [
{ "name": "timestamp", "type": "number" },
{ "name": "stackFrames", "type": "array", "items": { "$ref": "StackFrame" }, "description": "First array item is the bottom of the call stack and last array item is the top of the call stack." }
]
},
{
"id": "Samples",
"type": "object",
"properties": [
{ "name": "stackTraces", "type": "array", "items": { "$ref": "StackTrace" } }
]
}
],
"commands": [
{
"name": "startTracking",
"description": "Start tracking script evaluations.",
"parameters": [
{ "name": "includeSamples", "type": "boolean", "optional": true, "description": "Start the sampling profiler, defaults to false." }
]
},
{
"name": "stopTracking",
"description": "Stop tracking script evaluations. This will produce a `trackingComplete` event."
}
],
"events": [
{
"name": "trackingStart",
"description": "Tracking started.",
"parameters": [
{ "name": "timestamp", "type": "number" }
]
},
{
"name": "trackingUpdate",
"description": "Periodic tracking updates with event data.",
"parameters": [
{ "name": "event", "$ref": "Event" }
]
},
{
"name": "trackingComplete",
"description": "Tracking stopped. Includes any buffered data during tracking, such as profiling information.",
"parameters": [
{ "name": "samples", "$ref": "Samples", "optional": true, "description": "Stack traces." }
]
},
{
"name": "programmaticCaptureStarted",
"description": "Fired when programmatic capture starts (console.profile). JSContext inspection only."
},
{
"name": "programmaticCaptureStopped",
"description": "Fired when programmatic capture stops (console.profileEnd). JSContext inspection only."
}
]
}
,
{
"domain": "Timeline",
"description": "Timeline provides its clients with instrumentation records that are generated during the page runtime. Timeline instrumentation can be started and stopped using corresponding commands. While timeline is started, it is generating timeline event records.",
"availability": ["web"],
"types": [
{
"id": "EventType",
"type": "string",
"description": "Timeline record type.",
"enum": [
"EventDispatch",
"ScheduleStyleRecalculation",
"RecalculateStyles",
"InvalidateLayout",
"Layout",
"Paint",
"Composite",
"RenderingFrame",
"TimerInstall",
"TimerRemove",
"TimerFire",
"EvaluateScript",
"TimeStamp",
"Time",
"TimeEnd",
"FunctionCall",
"ProbeSample",
"ConsoleProfile",
"RequestAnimationFrame",
"CancelAnimationFrame",
"FireAnimationFrame"
]
},
{
"id": "Instrument",
"type": "string",
"description": "Instrument types.",
"enum": [
"ScriptProfiler",
"Timeline",
"Memory",
"Heap"
]
},
{
"id": "TimelineEvent",
"type": "object",
"description": "Timeline record contains information about the recorded activity.",
"properties": [
{ "name": "type", "$ref": "EventType", "description": "Event type." },
{ "name": "data", "type": "object", "description": "Event data." },
{ "name": "children", "type": "array", "optional": true, "items": { "$ref": "TimelineEvent" }, "description": "Nested records." }
]
}
],
"commands": [
{
"name": "start",
"description": "Starts capturing instrumentation events.",
"parameters": [
{ "name": "maxCallStackDepth", "optional": true, "type": "integer", "description": "Samples JavaScript stack traces up to <code>maxCallStackDepth</code>, defaults to 5." }
]
},
{
"name": "stop",
"description": "Stops capturing instrumentation events."
},
{
"name": "setAutoCaptureEnabled",
"description": "Toggle auto capture state. If <code>true</code> the backend will disable breakpoints and start capturing on navigation. The backend will fire the <code>autoCaptureStarted</code> event when an auto capture starts. The frontend should stop the auto capture when appropriate and re-enable breakpoints.",
"parameters": [
{ "name": "enabled", "type": "boolean", "description": "New auto capture state." }
]
},
{
"name": "setInstruments",
"description": "Instruments to enable when capture starts on the backend (e.g. auto capture or programmatic capture).",
"parameters": [
{ "name": "instruments", "type": "array", "items": { "$ref": "Instrument" }, "description": "Instruments to enable." }
]
}
],
"events": [
{
"name": "eventRecorded",
"description": "Fired for every instrumentation event while timeline is started.",
"parameters": [
{ "name": "record", "$ref": "TimelineEvent", "description": "Timeline event record data." }
]
},
{
"name": "recordingStarted",
"description": "Fired when recording has started.",
"parameters": [
{ "name": "startTime", "type": "number", "description": "Start time of this new recording." }
]
},
{
"name": "recordingStopped",
"description": "Fired when recording has stopped.",
"parameters": [
{ "name": "endTime", "type": "number", "description": "End time of this recording." }
]
},
{
"name": "autoCaptureStarted",
"description": "Fired when auto capture started."
},
{
"name": "programmaticCaptureStarted",
"description": "Fired when programmatic capture starts (console.profile)."
},
{
"name": "programmaticCaptureStopped",
"description": "Fired when programmatic capture stops (console.profileEnd)."
}
]
}
,
{
"domain": "Worker",
"availability": ["web"],
"types": [],
"commands": [
{
"name": "enable",
"description": "Enable Worker domain events."
},
{
"name": "disable",
"description": "Disable Worker domain events."
},
{
"name": "initialized",
"description": "Sent after the frontend has sent all initialization messages and can resume this worker. This command is required to allow execution in the worker.",
"parameters": [
{ "name": "workerId", "type": "string" }
]
},
{
"name": "sendMessageToWorker",
"description": "Send an Inspector Protocol message to be dispatched to a Worker's agents.",
"parameters": [
{ "name": "workerId", "type": "string" },
{ "name": "message", "type": "string", "description": "JSON Inspector Protocol message (command) to be dispatched on the backend." }
]
}
],
"events": [
{
"name": "workerCreated",
"parameters": [
{ "name": "workerId", "type": "string" },
{ "name": "url", "type": "string" }
]
},
{
"name": "workerTerminated",
"parameters": [
{ "name": "workerId", "type": "string" }
]
},
{
"name": "dispatchMessageFromWorker",
"parameters": [
{ "name": "workerId", "type": "string" },
{ "name": "message", "type": "string", "description": "JSON Inspector Protocol message (response or event) to be dispatched on the frontend." }
]
}
]
}
]}