Documentation
¶
Overview ¶
Package domdebugger provides the Chrome DevTools Protocol commands, types, and events for the DOMDebugger domain.
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.
Generated by the cdproto-gen command.
Index ¶
- Constants
- type CSPViolationType
- type DOMBreakpointType
- type EventListener
- type GetEventListenersParams
- type GetEventListenersReturns
- type RemoveDOMBreakpointParams
- type RemoveEventListenerBreakpointParams
- type RemoveXHRBreakpointParams
- type SetBreakOnCSPViolationParams
- type SetDOMBreakpointParams
- type SetEventListenerBreakpointParams
- type SetXHRBreakpointParams
Constants ¶
const ( CommandGetEventListeners = "DOMDebugger.getEventListeners" CommandRemoveDOMBreakpoint = "DOMDebugger.removeDOMBreakpoint" CommandRemoveEventListenerBreakpoint = "DOMDebugger.removeEventListenerBreakpoint" CommandRemoveXHRBreakpoint = "DOMDebugger.removeXHRBreakpoint" CommandSetBreakOnCSPViolation = "DOMDebugger.setBreakOnCSPViolation" CommandSetDOMBreakpoint = "DOMDebugger.setDOMBreakpoint" CommandSetEventListenerBreakpoint = "DOMDebugger.setEventListenerBreakpoint" CommandSetXHRBreakpoint = "DOMDebugger.setXHRBreakpoint" )
Command names.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CSPViolationType ¶
type CSPViolationType string
CSPViolationType cSP Violation type.
See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#type-CSPViolationType
const ( CSPViolationTypeTrustedtypeSinkViolation CSPViolationType = "trustedtype-sink-violation" CSPViolationTypeTrustedtypePolicyViolation CSPViolationType = "trustedtype-policy-violation" )
CSPViolationType values.
func (CSPViolationType) MarshalJSON ¶
func (t CSPViolationType) MarshalJSON() ([]byte, error)
MarshalJSON satisfies json.Marshaler.
func (CSPViolationType) String ¶
func (t CSPViolationType) String() string
String returns the CSPViolationType as string value.
func (*CSPViolationType) UnmarshalJSON ¶
func (t *CSPViolationType) UnmarshalJSON(buf []byte) error
UnmarshalJSON satisfies json.Unmarshaler.
type DOMBreakpointType ¶
type DOMBreakpointType string
DOMBreakpointType DOM breakpoint type.
See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#type-DOMBreakpointType
const ( DOMBreakpointTypeSubtreeModified DOMBreakpointType = "subtree-modified" DOMBreakpointTypeAttributeModified DOMBreakpointType = "attribute-modified" DOMBreakpointTypeNodeRemoved DOMBreakpointType = "node-removed" )
DOMBreakpointType values.
func (DOMBreakpointType) MarshalJSON ¶
func (t DOMBreakpointType) MarshalJSON() ([]byte, error)
MarshalJSON satisfies json.Marshaler.
func (DOMBreakpointType) String ¶
func (t DOMBreakpointType) String() string
String returns the DOMBreakpointType as string value.
func (*DOMBreakpointType) UnmarshalJSON ¶
func (t *DOMBreakpointType) UnmarshalJSON(buf []byte) error
UnmarshalJSON satisfies json.Unmarshaler.
type EventListener ¶
type EventListener struct {
Type string `json:"type"` // EventListener's type.
UseCapture bool `json:"useCapture"` // EventListener's useCapture.
Passive bool `json:"passive"` // EventListener's passive flag.
Once bool `json:"once"` // EventListener's once flag.
ScriptID runtime.ScriptID `json:"scriptId"` // Script id of the handler code.
LineNumber int64 `json:"lineNumber"` // Line number in the script (0-based).
ColumnNumber int64 `json:"columnNumber"` // Column number in the script (0-based).
Handler *runtime.RemoteObject `json:"handler,omitempty"` // Event handler function value.
OriginalHandler *runtime.RemoteObject `json:"originalHandler,omitempty"` // Event original handler function value.
BackendNodeID cdp.BackendNodeID `json:"backendNodeId,omitempty"` // Node the listener is added to (if any).
}
EventListener object event listener.
See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#type-EventListener
type GetEventListenersParams ¶
type GetEventListenersParams struct {
ObjectID runtime.RemoteObjectID `json:"objectId"` // Identifier of the object to return listeners for.
Depth int64 `json:"depth,omitempty"` // The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0.
Pierce bool `json:"pierce,omitempty"` // Whether or not iframes and shadow roots should be traversed when returning the subtree (default is false). Reports listeners for all contexts if pierce is enabled.
}
GetEventListenersParams returns event listeners of the given object.
func GetEventListeners ¶
func GetEventListeners(objectID runtime.RemoteObjectID) *GetEventListenersParams
GetEventListeners returns event listeners of the given object.
See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-getEventListeners
parameters:
objectID - Identifier of the object to return listeners for.
func (*GetEventListenersParams) Do ¶
func (p *GetEventListenersParams) Do(ctx context.Context) (listeners []*EventListener, err error)
Do executes DOMDebugger.getEventListeners against the provided context.
returns:
listeners - Array of relevant listeners.
func (GetEventListenersParams) WithDepth ¶
func (p GetEventListenersParams) WithDepth(depth int64) *GetEventListenersParams
WithDepth the maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0.
func (GetEventListenersParams) WithPierce ¶
func (p GetEventListenersParams) WithPierce(pierce bool) *GetEventListenersParams
WithPierce whether or not iframes and shadow roots should be traversed when returning the subtree (default is false). Reports listeners for all contexts if pierce is enabled.
type GetEventListenersReturns ¶
type GetEventListenersReturns struct {
Listeners []*EventListener `json:"listeners,omitempty"` // Array of relevant listeners.
}
GetEventListenersReturns return values.
type RemoveDOMBreakpointParams ¶
type RemoveDOMBreakpointParams struct {
NodeID cdp.NodeID `json:"nodeId"` // Identifier of the node to remove breakpoint from.
Type DOMBreakpointType `json:"type"` // Type of the breakpoint to remove.
}
RemoveDOMBreakpointParams removes DOM breakpoint that was set using setDOMBreakpoint.
func RemoveDOMBreakpoint ¶
func RemoveDOMBreakpoint(nodeID cdp.NodeID, typeVal DOMBreakpointType) *RemoveDOMBreakpointParams
RemoveDOMBreakpoint removes DOM breakpoint that was set using setDOMBreakpoint.
See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-removeDOMBreakpoint
parameters:
nodeID - Identifier of the node to remove breakpoint from. type - Type of the breakpoint to remove.
type RemoveEventListenerBreakpointParams ¶
type RemoveEventListenerBreakpointParams struct {
EventName string `json:"eventName"` // Event name.
TargetName string `json:"targetName,omitempty"` // EventTarget interface name.
}
RemoveEventListenerBreakpointParams removes breakpoint on particular DOM event.
func RemoveEventListenerBreakpoint ¶
func RemoveEventListenerBreakpoint(eventName string) *RemoveEventListenerBreakpointParams
RemoveEventListenerBreakpoint removes breakpoint on particular DOM event.
parameters:
eventName - Event name.
func (*RemoveEventListenerBreakpointParams) Do ¶
func (p *RemoveEventListenerBreakpointParams) Do(ctx context.Context) (err error)
Do executes DOMDebugger.removeEventListenerBreakpoint against the provided context.
func (RemoveEventListenerBreakpointParams) WithTargetName ¶
func (p RemoveEventListenerBreakpointParams) WithTargetName(targetName string) *RemoveEventListenerBreakpointParams
WithTargetName eventTarget interface name.
type RemoveXHRBreakpointParams ¶
type RemoveXHRBreakpointParams struct {
URL string `json:"url"` // Resource URL substring.
}
RemoveXHRBreakpointParams removes breakpoint from XMLHttpRequest.
func RemoveXHRBreakpoint ¶
func RemoveXHRBreakpoint(url string) *RemoveXHRBreakpointParams
RemoveXHRBreakpoint removes breakpoint from XMLHttpRequest.
See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-removeXHRBreakpoint
parameters:
url - Resource URL substring.
type SetBreakOnCSPViolationParams ¶
type SetBreakOnCSPViolationParams struct {
ViolationTypes []CSPViolationType `json:"violationTypes"` // CSP Violations to stop upon.
}
SetBreakOnCSPViolationParams sets breakpoint on particular CSP violations.
func SetBreakOnCSPViolation ¶
func SetBreakOnCSPViolation(violationTypes []CSPViolationType) *SetBreakOnCSPViolationParams
SetBreakOnCSPViolation sets breakpoint on particular CSP violations.
See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-setBreakOnCSPViolation
parameters:
violationTypes - CSP Violations to stop upon.
type SetDOMBreakpointParams ¶
type SetDOMBreakpointParams struct {
NodeID cdp.NodeID `json:"nodeId"` // Identifier of the node to set breakpoint on.
Type DOMBreakpointType `json:"type"` // Type of the operation to stop upon.
}
SetDOMBreakpointParams sets breakpoint on particular operation with DOM.
func SetDOMBreakpoint ¶
func SetDOMBreakpoint(nodeID cdp.NodeID, typeVal DOMBreakpointType) *SetDOMBreakpointParams
SetDOMBreakpoint sets breakpoint on particular operation with DOM.
See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-setDOMBreakpoint
parameters:
nodeID - Identifier of the node to set breakpoint on. type - Type of the operation to stop upon.
type SetEventListenerBreakpointParams ¶
type SetEventListenerBreakpointParams struct {
EventName string `json:"eventName"` // DOM Event name to stop on (any DOM event will do).
TargetName string `json:"targetName,omitempty"` // EventTarget interface name to stop on. If equal to "*" or not provided, will stop on any EventTarget.
}
SetEventListenerBreakpointParams sets breakpoint on particular DOM event.
func SetEventListenerBreakpoint ¶
func SetEventListenerBreakpoint(eventName string) *SetEventListenerBreakpointParams
SetEventListenerBreakpoint sets breakpoint on particular DOM event.
See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-setEventListenerBreakpoint
parameters:
eventName - DOM Event name to stop on (any DOM event will do).
func (*SetEventListenerBreakpointParams) Do ¶
func (p *SetEventListenerBreakpointParams) Do(ctx context.Context) (err error)
Do executes DOMDebugger.setEventListenerBreakpoint against the provided context.
func (SetEventListenerBreakpointParams) WithTargetName ¶
func (p SetEventListenerBreakpointParams) WithTargetName(targetName string) *SetEventListenerBreakpointParams
WithTargetName eventTarget interface name to stop on. If equal to "*" or not provided, will stop on any EventTarget.
type SetXHRBreakpointParams ¶
type SetXHRBreakpointParams struct {
URL string `json:"url"` // Resource URL substring. All XHRs having this substring in the URL will get stopped upon.
}
SetXHRBreakpointParams sets breakpoint on XMLHttpRequest.
func SetXHRBreakpoint ¶
func SetXHRBreakpoint(url string) *SetXHRBreakpointParams
SetXHRBreakpoint sets breakpoint on XMLHttpRequest.
See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-setXHRBreakpoint
parameters:
url - Resource URL substring. All XHRs having this substring in the URL will get stopped upon.