domdebugger

package
v0.0.0-...-8ed5860 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 8, 2022 License: MIT Imports: 8 Imported by: 0

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

View Source 
const (
	CommandGetEventListeners               = "DOMDebugger.getEventListeners"
	CommandRemoveDOMBreakpoint             = "DOMDebugger.removeDOMBreakpoint"
	CommandRemoveEventListenerBreakpoint   = "DOMDebugger.removeEventListenerBreakpoint"
	CommandRemoveInstrumentationBreakpoint = "DOMDebugger.removeInstrumentationBreakpoint"
	CommandRemoveXHRBreakpoint             = "DOMDebugger.removeXHRBreakpoint"
	CommandSetDOMBreakpoint                = "DOMDebugger.setDOMBreakpoint"
	CommandSetEventListenerBreakpoint      = "DOMDebugger.setEventListenerBreakpoint"
	CommandSetInstrumentationBreakpoint    = "DOMDebugger.setInstrumentationBreakpoint"
	CommandSetXHRBreakpoint                = "DOMDebugger.setXHRBreakpoint"
)

Command names.

Variables

This section is empty.

Functions

This section is empty.

Types

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) MarshalEasyJSON 

func (t DOMBreakpointType) MarshalEasyJSON(out *jwriter.Writer)

MarshalEasyJSON satisfies easyjson.Marshaler.

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) UnmarshalEasyJSON 

func (t *DOMBreakpointType) UnmarshalEasyJSON(in *jlexer.Lexer)

UnmarshalEasyJSON satisfies easyjson.Unmarshaler.

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

func (EventListener) MarshalEasyJSON 

func (v EventListener) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (EventListener) MarshalJSON 

func (v EventListener) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*EventListener) UnmarshalEasyJSON 

func (v *EventListener) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*EventListener) UnmarshalJSON 

func (v *EventListener) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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) MarshalEasyJSON 

func (v GetEventListenersParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetEventListenersParams) MarshalJSON 

func (v GetEventListenersParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetEventListenersParams) UnmarshalEasyJSON 

func (v *GetEventListenersParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetEventListenersParams) UnmarshalJSON 

func (v *GetEventListenersParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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.

func (GetEventListenersReturns) MarshalEasyJSON 

func (v GetEventListenersReturns) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetEventListenersReturns) MarshalJSON 

func (v GetEventListenersReturns) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetEventListenersReturns) UnmarshalEasyJSON 

func (v *GetEventListenersReturns) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetEventListenersReturns) UnmarshalJSON 

func (v *GetEventListenersReturns) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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.

func (*RemoveDOMBreakpointParams) Do 

func (p *RemoveDOMBreakpointParams) Do(ctx context.Context) (err error)

Do executes DOMDebugger.removeDOMBreakpoint against the provided context.

func (RemoveDOMBreakpointParams) MarshalEasyJSON 

func (v RemoveDOMBreakpointParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (RemoveDOMBreakpointParams) MarshalJSON 

func (v RemoveDOMBreakpointParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*RemoveDOMBreakpointParams) UnmarshalEasyJSON 

func (v *RemoveDOMBreakpointParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*RemoveDOMBreakpointParams) UnmarshalJSON 

func (v *RemoveDOMBreakpointParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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.

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-removeEventListenerBreakpoint

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) MarshalEasyJSON 

func (v RemoveEventListenerBreakpointParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (RemoveEventListenerBreakpointParams) MarshalJSON 

func (v RemoveEventListenerBreakpointParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*RemoveEventListenerBreakpointParams) UnmarshalEasyJSON 

func (v *RemoveEventListenerBreakpointParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*RemoveEventListenerBreakpointParams) UnmarshalJSON 

func (v *RemoveEventListenerBreakpointParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

func (RemoveEventListenerBreakpointParams) WithTargetName 

func (p RemoveEventListenerBreakpointParams) WithTargetName(targetName string) *RemoveEventListenerBreakpointParams

WithTargetName eventTarget interface name.

type RemoveInstrumentationBreakpointParams 

type RemoveInstrumentationBreakpointParams struct {
	EventName string `json:"eventName"` // Instrumentation name to stop on.
}

RemoveInstrumentationBreakpointParams removes breakpoint on particular native event.

func RemoveInstrumentationBreakpoint 

func RemoveInstrumentationBreakpoint(eventName string) *RemoveInstrumentationBreakpointParams

RemoveInstrumentationBreakpoint removes breakpoint on particular native event.

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-removeInstrumentationBreakpoint

parameters: 

eventName - Instrumentation name to stop on.

func (*RemoveInstrumentationBreakpointParams) Do 

func (p *RemoveInstrumentationBreakpointParams) Do(ctx context.Context) (err error)

Do executes DOMDebugger.removeInstrumentationBreakpoint against the provided context.

func (RemoveInstrumentationBreakpointParams) MarshalEasyJSON 

func (v RemoveInstrumentationBreakpointParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (RemoveInstrumentationBreakpointParams) MarshalJSON 

func (v RemoveInstrumentationBreakpointParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*RemoveInstrumentationBreakpointParams) UnmarshalEasyJSON 

func (v *RemoveInstrumentationBreakpointParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*RemoveInstrumentationBreakpointParams) UnmarshalJSON 

func (v *RemoveInstrumentationBreakpointParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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.

func (*RemoveXHRBreakpointParams) Do 

func (p *RemoveXHRBreakpointParams) Do(ctx context.Context) (err error)

Do executes DOMDebugger.removeXHRBreakpoint against the provided context.

func (RemoveXHRBreakpointParams) MarshalEasyJSON 

func (v RemoveXHRBreakpointParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (RemoveXHRBreakpointParams) MarshalJSON 

func (v RemoveXHRBreakpointParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*RemoveXHRBreakpointParams) UnmarshalEasyJSON 

func (v *RemoveXHRBreakpointParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*RemoveXHRBreakpointParams) UnmarshalJSON 

func (v *RemoveXHRBreakpointParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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.

func (*SetDOMBreakpointParams) Do 

func (p *SetDOMBreakpointParams) Do(ctx context.Context) (err error)

Do executes DOMDebugger.setDOMBreakpoint against the provided context.

func (SetDOMBreakpointParams) MarshalEasyJSON 

func (v SetDOMBreakpointParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetDOMBreakpointParams) MarshalJSON 

func (v SetDOMBreakpointParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetDOMBreakpointParams) UnmarshalEasyJSON 

func (v *SetDOMBreakpointParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetDOMBreakpointParams) UnmarshalJSON 

func (v *SetDOMBreakpointParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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) MarshalEasyJSON 

func (v SetEventListenerBreakpointParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetEventListenerBreakpointParams) MarshalJSON 

func (v SetEventListenerBreakpointParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetEventListenerBreakpointParams) UnmarshalEasyJSON 

func (v *SetEventListenerBreakpointParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetEventListenerBreakpointParams) UnmarshalJSON 

func (v *SetEventListenerBreakpointParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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 SetInstrumentationBreakpointParams 

type SetInstrumentationBreakpointParams struct {
	EventName string `json:"eventName"` // Instrumentation name to stop on.
}

SetInstrumentationBreakpointParams sets breakpoint on particular native event.

func SetInstrumentationBreakpoint 

func SetInstrumentationBreakpoint(eventName string) *SetInstrumentationBreakpointParams

SetInstrumentationBreakpoint sets breakpoint on particular native event.

See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-setInstrumentationBreakpoint

parameters: 

eventName - Instrumentation name to stop on.

func (*SetInstrumentationBreakpointParams) Do 

func (p *SetInstrumentationBreakpointParams) Do(ctx context.Context) (err error)

Do executes DOMDebugger.setInstrumentationBreakpoint against the provided context.

func (SetInstrumentationBreakpointParams) MarshalEasyJSON 

func (v SetInstrumentationBreakpointParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetInstrumentationBreakpointParams) MarshalJSON 

func (v SetInstrumentationBreakpointParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetInstrumentationBreakpointParams) UnmarshalEasyJSON 

func (v *SetInstrumentationBreakpointParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetInstrumentationBreakpointParams) UnmarshalJSON 

func (v *SetInstrumentationBreakpointParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

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.

func (*SetXHRBreakpointParams) Do 

func (p *SetXHRBreakpointParams) Do(ctx context.Context) (err error)

Do executes DOMDebugger.setXHRBreakpoint against the provided context.

func (SetXHRBreakpointParams) MarshalEasyJSON 

func (v SetXHRBreakpointParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetXHRBreakpointParams) MarshalJSON 

func (v SetXHRBreakpointParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetXHRBreakpointParams) UnmarshalEasyJSON 

func (v *SetXHRBreakpointParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetXHRBreakpointParams) UnmarshalJSON 

func (v *SetXHRBreakpointParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.