Skip to content

Commit

Permalink
Reduce Performance APIs to a single group (#22031)
Browse files Browse the repository at this point in the history
* Reduce Performance APIs to a single group

* Add deprecated interfaces
  • Loading branch information
Elchi3 committed Nov 5, 2022
1 parent eff08df commit 66c9543
Show file tree
Hide file tree
Showing 152 changed files with 167 additions and 245 deletions.
2 changes: 1 addition & 1 deletion files/en-us/web/api/domhighrestimestamp/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ tags:
browser-compat: api.DOMHighResTimestamp
---

{{APIRef("High Resolution Time")}}
{{APIRef("Performance API")}}

The **`DOMHighResTimeStamp`** type is a `double` and is used to store a time value in milliseconds.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/element_timing_api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.PerformanceElementTiming
---

{{DefaultAPISidebar("Element Timing")}}{{SeeCompatTable}}
{{DefaultAPISidebar("Performance API")}}{{SeeCompatTable}}

The **Element Timing API** provides features for monitoring the loading performance of large image elements and text nodes as they appear on screen.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/eventcounts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:
browser-compat: api.EventCounts
---

{{APIRef("Event Timing")}}
{{APIRef("Performance API")}}

The **`EventCounts`** interface is a read-only map where the keys are event types and the values are the number of events that have been dispatched for that event type.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/largest_contentful_paint_api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ tags:
browser-compat: api.LargestContentfulPaint
---

{{DefaultAPISidebar("Largest Contentful Paint API")}}{{SeeCompatTable}}
{{DefaultAPISidebar("Performance API")}}{{SeeCompatTable}}

The **Largest Contentful Paint API** provides [perceived performance](/en-US/docs/Learn/Performance/Perceived_performance) data that allows you to know exactly how long a user waits, after navigating to your page, before seeing the main content of the page in their browser viewport — in contrast to just knowing when the user can first see a loading indicator or background image or other such initial/early-loading content (which is what the related [Paint Timing API](/en-US/docs/Web/API/Paint_Timing_API) provides).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.LargestContentfulPaint.element
---

{{APIRef("Largest Contentful Paint API")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The **`element`** read-only property of the {{domxref("LargestContentfulPaint")}} interface returns an object representing the {{domxref("Element")}} that is the largest contentful paint.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/largestcontentfulpaint/id/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.LargestContentfulPaint.id
---

{{APIRef("Largest Contentful Paint API")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The **`id`** read-only property of the {{domxref("LargestContentfulPaint")}} interface returns the ID of the element that is the largest contentful paint.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/largestcontentfulpaint/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ tags:
browser-compat: api.LargestContentfulPaint
---

{{APIRef("Largest Contentful Paint API")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The `LargestContentfulPaint` interface of the {{domxref("Largest Contentful Paint API")}} provides details about the largest image or text paint before user input on a web page. The timing of this paint is a good heuristic for when the main page content is available during load.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.LargestContentfulPaint.loadTime
---

{{APIRef("Largest Contentful Paint API")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The **`loadTime`** read-only property of the {{domxref("LargestContentfulPaint")}} interface returns the time that the element was loaded.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.LargestContentfulPaint.renderTime
---

{{APIRef("Largest Contentful Paint API")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The **`renderTime`** read-only property of the {{domxref("LargestContentfulPaint")}} interface represents the time that the element was rendered to the screen.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/largestcontentfulpaint/size/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.LargestContentfulPaint.size
---

{{APIRef("Largest Contentful Paint API")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The **`size`** read-only property of the {{domxref("LargestContentfulPaint")}} interface returns the intrinsic size of the element that is the largest contentful paint.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/largestcontentfulpaint/tojson/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.LargestContentfulPaint.toJSON
---

{{APIRef("Largest Contentful Paint API")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The **`toJSON()`** method of the {{domxref("LargestContentfulPaint")}} interface is a _serializer_, and returns a JSON representation of the `LargestContentfulPaint` object.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/largestcontentfulpaint/url/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.LargestContentfulPaint.url
---

{{APIRef("Largest Contentful Paint API")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The **`url`** read-only property of the {{domxref("LargestContentfulPaint")}} interface returns the request URL of the element, if the element is an image.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/long_tasks_api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ browser-compat:
- api.TaskAttributionTiming
---

{{DefaultAPISidebar("Long Tasks")}}
{{DefaultAPISidebar("Performance API")}}

## Motivation

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/navigation_timing_api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ browser-compat:
- api.PerformanceNavigationTiming
---

{{DefaultAPISidebar("Navigation Timing")}}
{{DefaultAPISidebar("Performance API")}}

The **Navigation Timing API** provides data that can be used to measure the performance of a web site. Unlike JavaScript-based libraries that have historically been used to collect similar information, the Navigation Timing API can be much more accurate and reliable.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:
- Performance
---

{{DefaultAPISidebar("Navigation Timing")}}
{{DefaultAPISidebar("Performance API")}}

The Navigation Timing API lets you easily obtain detailed and highly accurate timing information to help isolate performance problems with your site's code or resources.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/paint_timing_api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ tags:
browser-compat: api.PerformancePaintTiming
---

{{DefaultAPISidebar("Paint Timing API")}}
{{DefaultAPISidebar("Performance API")}}

The **Paint Timing API** provides [perceived performance](/en-US/docs/Learn/Performance/Perceived_performance) data that allows you to know exactly how long a user waits, after navigating to your page, before seeing any of the page content at all (which may not yet be the main content) first starting to appear. More specifically, it allows you to know exactly when, during page load, {{Glossary("first paint")}} and {{Glossary("first contentful paint")}} occur.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/clearmarks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:
browser-compat: api.Performance.clearMarks
---

{{APIRef("User Timing API")}}
{{APIRef("Performance API")}}

The **`clearMarks()`** method removes the _named mark_
from the browser's performance entry buffer. If the method is called with no arguments,
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/clearmeasures/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:
browser-compat: api.Performance.clearMeasures
---

{{APIRef("User Timing API")}}
{{APIRef("Performance API")}}

The **`clearMeasures()`** method removes the _named
measure_ from the browser's performance entry buffer. If the method is called with
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:
browser-compat: api.Performance.clearResourceTimings
---

{{APIRef("Resource Timing API")}}
{{APIRef("Performance API")}}

The **`clearResourceTimings()`** method removes all
{{domxref("PerformanceEntry","performance entries")}} with an
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/eventcounts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
- Property
---

{{APIRef("Event Timing")}}
{{APIRef("Performance API")}}

The read-only `performance.eventCounts` property is an {{domxref("EventCounts")}} map containing the number of events which have been dispatched per event type.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/getentries/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:
browser-compat: api.Performance.getEntries
---

{{APIRef("Performance Timeline API")}}
{{APIRef("Performance API")}}

The **`getEntries()`** method returns a list of all
{{domxref("PerformanceEntry")}} objects for the page. The list's members
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/getentriesbyname/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:
browser-compat: api.Performance.getEntriesByName
---

{{APIRef("Performance Timeline API")}}
{{APIRef("Performance API")}}

The **`getEntriesByName()`** method returns a list of
{{domxref("PerformanceEntry")}} objects for the given _name_ and _type_.
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/getentriesbytype/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:
browser-compat: api.Performance.getEntriesByType
---

{{APIRef("Performance Timeline API")}}
{{APIRef("Performance API")}}

The **`getEntriesByType()`** method returns a list of
{{domxref("PerformanceEntry")}} objects for a given _type_. The list's members
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.Performance
---

{{APIRef("High Resolution Time")}}
{{APIRef("Performance API")}}

The **`Performance`** interface provides access to performance-related information for the current page. It's part of the High Resolution Time API, but is enhanced by the [Performance Timeline API](/en-US/docs/Web/API/Performance_Timeline), the [Navigation Timing API](/en-US/docs/Web/API/Navigation_timing_API), the [User Timing API](/en-US/docs/Web/API/User_Timing_API), and the [Resource Timing API](/en-US/docs/Web/API/Resource_Timing_API).

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/mark/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:
browser-compat: api.Performance.mark
---

{{APIRef("User Timing API")}}
{{APIRef("Performance API")}}

The **`mark()`** method creates a
{{domxref("DOMHighResTimeStamp","timestamp")}} in the browser's _performance entry
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/measure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ tags:
browser-compat: api.Performance.measure
---

{{APIRef("User Timing API")}}
{{APIRef("Performance API")}}

The **`measure()`** method creates a named {{domxref("DOMHighResTimeStamp","timestamp")}} in the browser's _performance entry buffer_ between marks, the navigation start time, or the current time.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/memory/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ page-type: web-api-instance-property
browser-compat: api.Performance.memory
---

{{APIRef}}
{{APIRef("Performance API")}}

## Syntax

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/navigation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ tags:
browser-compat: api.Performance.navigation
---

{{APIRef("Navigation Timing")}}{{Deprecated_Header}}
{{APIRef("Performance API")}}{{Deprecated_Header}}

The legacy
**`Performance.navigation`**
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/now/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ tags:
browser-compat: api.Performance.now
---

{{APIRef("High Resolution Timing")}}
{{APIRef("Performance API")}}

The **`performance.now()`** method
returns a {{domxref("DOMHighResTimeStamp")}}, measured in milliseconds.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ tags:
browser-compat: api.Performance.resourcetimingbufferfull_event
---

{{APIRef}}
{{APIRef("Performance API")}}

The `resourcetimingbufferfull` event is fired when the browser's [resource timing buffer](/en-US/docs/Web/API/Performance/setResourceTimingBufferSize) is full.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:
browser-compat: api.Performance.setResourceTimingBufferSize
---

{{APIRef("Resource Timing API")}}
{{APIRef("Performance API")}}

The **`setResourceTimingBufferSize()`** method sets the
browser's _resource timing buffer_ size to the specified number of
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/timeorigin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.Performance.timeOrigin
---

{{APIRef("High Resolution Time")}}
{{APIRef("Performance API")}}

The **`timeOrigin`** read-only property of the
{{domxref("Performance")}} interface returns the high resolution timestamp of the
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/timing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ tags:
browser-compat: api.Performance.timing
---

{{APIRef("Navigation Timing")}}{{deprecated_header}}
{{APIRef("Performance API")}}{{deprecated_header}}

The legacy
**`Performance.timing`** read-only
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance/tojson/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:
browser-compat: api.Performance.toJSON
---

{{APIRef("High Resolution Timing")}}
{{APIRef("Performance API")}}

The **`toJSON()`** method of the {{domxref("Performance")}}
interface is a standard serializer: it returns a JSON representation of the performance
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:
- Web Performance
---

{{DefaultAPISidebar("High Resolution Time")}}
{{DefaultAPISidebar("Performance API")}}

A fundamental requirement of web performance is a precise and consistent definition of _time._ The {{domxref("DOMHighResTimeStamp")}} type (a `double`) is used by all performance interfaces to hold such time values. Additionally, there must be a way to create a _timestamp_ for a specific point in time; this is done with the {{domxref("Performance.now","now()")}} method.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance_property/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ tags:
browser-compat: api.performance
---

{{APIRef("High Resolution Time")}}
{{APIRef("Performance API")}}

The global **`performance`** property returns a {{domxref("Performance")}} object, which can be used to gather performance information about the current document. It serves as the point of exposure for the Performance Timeline API, the High Resolution Time API, the [Navigation Timing API](/en-US/docs/Web/API/Navigation_timing_API), the [User Timing API](/en-US/docs/Web/API/User_Timing_API), and the [Resource Timing API](/en-US/docs/Web/API/Resource_Timing_API).

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performance_timeline/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tags:
spec-urls: https://w3c.github.io/performance-timeline/
---

{{DefaultAPISidebar("Performance Timeline API")}}
{{DefaultAPISidebar("Performance API")}}

The **Performance Timeline** API defines extensions to the {{domxref("Performance")}} interface to support client-side latency measurements within applications. The extensions provide interfaces to retrieve {{domxref("PerformanceEntry","performance entry metrics", '', 'true')}} based on specific filter criteria. The standard also includes interfaces that allow an application to define _[performance observer](#performance_observers)_ callbacks that are notified when specific performance events are added to the browser's _performance timeline_.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
- Web Performance
---

{{DefaultAPISidebar("Performance Timeline API")}}
{{DefaultAPISidebar("Performance API")}}

The **[Performance Timeline](https://w3c.github.io/performance-timeline/)** standard defines extensions to the {{domxref("Performance")}} interface to support client-side latency measurements within applications. The standard also includes interfaces that allow an application to be notified when specific performance events occur. Together, these interfaces can be used to help identify an application's performance bottlenecks.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.PerformanceElementTiming.element
---

{{APIRef("Element Timing")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The **`element`** read-only property of the {{domxref("PerformanceElementTiming")}} interface returns an {{domxref("Element")}} which is a literal representation of the associated element.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performanceelementtiming/id/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.PerformanceElementTiming.id
---

{{APIRef("Element Timing")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The **`id`** read-only property of the {{domxref("PerformanceElementTiming")}} interface returns the {{htmlattrxref("id")}} of the associated element.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.PerformanceElementTiming.identifier
---

{{APIRef("Element Timing")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The **`identifier`** read-only property of the {{domxref("PerformanceElementTiming")}} interface returns the value of the [`elementtiming`](/en-US/docs/Web/HTML/Attributes/elementtiming) attribute on the element.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/performanceelementtiming/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ tags:
browser-compat: api.PerformanceElementTiming
---

{{APIRef("Element Timing")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The **`PerformanceElementTiming`** interface of the {{domxref('Element Timing API','','',' ')}} reports timing information on a specific element identified by the page author. For example it could report timing information about the main image in an article.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.PerformanceElementTiming.intersectionRect
---

{{APIRef("Element Timing")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The **`intersectionRect`** read-only property of the {{domxref("PerformanceElementTiming")}} interface returns the rectangle of the element within the viewport.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:
browser-compat: api.PerformanceElementTiming.loadTime
---

{{APIRef("Element Timing")}}{{SeeCompatTable}}
{{APIRef("Performance API")}}{{SeeCompatTable}}

The **`loadTime`** read-only property of the {{domxref("PerformanceElementTiming")}} interface always returns 0 for text. For images it returns the time which is the latest between the time the image resource is loaded and the time it is attached to the element.

Expand Down

0 comments on commit 66c9543

Please sign in to comment.