package performancetimeline

Import Path
	github.com/chromedp/cdproto/performancetimeline (on go.dev)

Dependency Relation
	imports 7 packages, and imported by one package

Involved Source Files

	    easyjson.go
	    events.go
	  d performancetimeline.go
		Package performancetimeline provides the Chrome DevTools Protocol
		commands, types, and events for the PerformanceTimeline domain.
		
		Reporting of performance timeline events, as specified in
		https://w3c.github.io/performance-timeline/#dom-performanceobserver.
		
		Generated by the cdproto-gen command.

	    types.go
Package-Level Type Names (total 6)

	/* sort by: alphabet | popularity */
	 type EnableParams (struct)
		EnableParams previously buffered events would be reported before method
		returns. See also: timelineEventAdded.

		Fields (only one)
			EventTypes []string
				// The types of event to report, as specified in https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype The specified filter overrides any previous filters, passing empty filter disables recording. Note that not all types exposed to the web platform are currently supported.

		Methods (total 5)
			(*EnableParams) Do(ctx context.Context) (err error)
				Do executes PerformanceTimeline.enable against the provided context.

			( EnableParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( EnableParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*EnableParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*EnableParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*EnableParams : github.com/chromedp/chromedp.Action
			*EnableParams : github.com/chromedp/chromedp.CallAction
			*EnableParams : github.com/chromedp/chromedp.EmulateAction
			*EnableParams : github.com/chromedp/chromedp.EvaluateAction
			*EnableParams : github.com/chromedp/chromedp.KeyAction
			*EnableParams : github.com/chromedp/chromedp.MouseAction
			*EnableParams : github.com/chromedp/chromedp.NavigateAction
			*EnableParams : github.com/chromedp/chromedp.PollAction
			*EnableParams : github.com/chromedp/chromedp.QueryAction
			 EnableParams : github.com/goccy/go-json.Marshaler
			*EnableParams : github.com/goccy/go-json.Unmarshaler
			 EnableParams : github.com/mailru/easyjson.Marshaler
			*EnableParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*EnableParams : github.com/mailru/easyjson.Unmarshaler
			 EnableParams : encoding/json.Marshaler
			*EnableParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func Enable(eventTypes []string) *EnableParams

	 type EventTimelineEventAdded (struct)
		EventTimelineEventAdded sent when a performance timeline event is added.
		See reportPerformanceTimeline method.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/PerformanceTimeline#event-timelineEventAdded

		Fields (only one)
			Event *TimelineEvent
		Methods (total 4)
			( EventTimelineEventAdded) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( EventTimelineEventAdded) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*EventTimelineEventAdded) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*EventTimelineEventAdded) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 EventTimelineEventAdded : github.com/goccy/go-json.Marshaler
			*EventTimelineEventAdded : github.com/goccy/go-json.Unmarshaler
			 EventTimelineEventAdded : github.com/mailru/easyjson.Marshaler
			*EventTimelineEventAdded : github.com/mailru/easyjson.MarshalerUnmarshaler
			*EventTimelineEventAdded : github.com/mailru/easyjson.Unmarshaler
			 EventTimelineEventAdded : encoding/json.Marshaler
			*EventTimelineEventAdded : encoding/json.Unmarshaler

	 type LargestContentfulPaint (struct)
		LargestContentfulPaint see https://github.com/WICG/LargestContentfulPaint
		and largest_contentful_paint.idl.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/PerformanceTimeline#type-LargestContentfulPaint

		Fields (total 6)
			ElementID string
				// The id attribute of the element, if available.

			LoadTime *cdp.TimeSinceEpoch
			NodeID cdp.BackendNodeID
			RenderTime *cdp.TimeSinceEpoch
			Size float64
				// The number of pixels being painted.

			URL string
				// The URL of the image (may be trimmed).

		Methods (total 4)
			( LargestContentfulPaint) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( LargestContentfulPaint) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*LargestContentfulPaint) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*LargestContentfulPaint) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 LargestContentfulPaint : github.com/goccy/go-json.Marshaler
			*LargestContentfulPaint : github.com/goccy/go-json.Unmarshaler
			 LargestContentfulPaint : github.com/mailru/easyjson.Marshaler
			*LargestContentfulPaint : github.com/mailru/easyjson.MarshalerUnmarshaler
			*LargestContentfulPaint : github.com/mailru/easyjson.Unmarshaler
			 LargestContentfulPaint : encoding/json.Marshaler
			*LargestContentfulPaint : encoding/json.Unmarshaler

	 type LayoutShift (struct)
		LayoutShift see
		https://wicg.github.io/layout-instability/#sec-layout-shift and
		layout_shift.idl.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/PerformanceTimeline#type-LayoutShift

		Fields (total 4)
			HadRecentInput bool
			LastInputTime *cdp.TimeSinceEpoch
			Sources []*LayoutShiftAttribution
			Value float64
				// Score increment produced by this event.

		Methods (total 4)
			( LayoutShift) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( LayoutShift) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*LayoutShift) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*LayoutShift) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 LayoutShift : github.com/goccy/go-json.Marshaler
			*LayoutShift : github.com/goccy/go-json.Unmarshaler
			 LayoutShift : github.com/mailru/easyjson.Marshaler
			*LayoutShift : github.com/mailru/easyjson.MarshalerUnmarshaler
			*LayoutShift : github.com/mailru/easyjson.Unmarshaler
			 LayoutShift : encoding/json.Marshaler
			*LayoutShift : encoding/json.Unmarshaler

	 type LayoutShiftAttribution (struct)
		LayoutShiftAttribution [no description].
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/PerformanceTimeline#type-LayoutShiftAttribution

		Fields (total 3)
			CurrentRect *dom.Rect
			NodeID cdp.BackendNodeID
			PreviousRect *dom.Rect
		Methods (total 4)
			( LayoutShiftAttribution) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( LayoutShiftAttribution) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*LayoutShiftAttribution) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*LayoutShiftAttribution) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 LayoutShiftAttribution : github.com/goccy/go-json.Marshaler
			*LayoutShiftAttribution : github.com/goccy/go-json.Unmarshaler
			 LayoutShiftAttribution : github.com/mailru/easyjson.Marshaler
			*LayoutShiftAttribution : github.com/mailru/easyjson.MarshalerUnmarshaler
			*LayoutShiftAttribution : github.com/mailru/easyjson.Unmarshaler
			 LayoutShiftAttribution : encoding/json.Marshaler
			*LayoutShiftAttribution : encoding/json.Unmarshaler

	 type TimelineEvent (struct)
		TimelineEvent [no description].
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/PerformanceTimeline#type-TimelineEvent

		Fields (total 7)
			Duration float64
				// Event duration, if applicable.

			FrameID cdp.FrameID
				// Identifies the frame that this event is related to. Empty for non-frame targets.

			LayoutShiftDetails *LayoutShift
			LcpDetails *LargestContentfulPaint
			Name string
				// Name may be empty depending on the type.

			Time *cdp.TimeSinceEpoch
				// Time in seconds since Epoch, monotonically increasing within document lifetime.

			Type string
				// The event type, as specified in https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype This determines which of the optional "details" fiedls is present.

		Methods (total 4)
			( TimelineEvent) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( TimelineEvent) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*TimelineEvent) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*TimelineEvent) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 TimelineEvent : github.com/goccy/go-json.Marshaler
			*TimelineEvent : github.com/goccy/go-json.Unmarshaler
			 TimelineEvent : github.com/mailru/easyjson.Marshaler
			*TimelineEvent : github.com/mailru/easyjson.MarshalerUnmarshaler
			*TimelineEvent : github.com/mailru/easyjson.Unmarshaler
			 TimelineEvent : encoding/json.Marshaler
			*TimelineEvent : encoding/json.Unmarshaler


Package-Level Functions (only one)

	 func Enable(eventTypes []string) *EnableParams
		Enable previously buffered events would be reported before method returns.
		See also: timelineEventAdded.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/PerformanceTimeline#method-enable
		
		parameters:
		
			eventTypes - The types of event to report, as specified in https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype The specified filter overrides any previous filters, passing empty filter disables recording. Note that not all types exposed to the web platform are currently supported.


Package-Level Constants (only one)

	const CommandEnable = "PerformanceTimeline.enable"
		Command names.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.