-
Notifications
You must be signed in to change notification settings - Fork 22.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document PerformanceResourceTiming.responseStatus (#22584)
- Loading branch information
Showing
3 changed files
with
86 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
83 changes: 83 additions & 0 deletions
83
files/en-us/web/api/performanceresourcetiming/responsestatus/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
--- | ||
title: PerformanceResourceTiming.responseStatus | ||
slug: Web/API/PerformanceResourceTiming/responseStatus | ||
page-type: web-api-instance-property | ||
tags: | ||
- API | ||
- Property | ||
- Reference | ||
- Web Performance | ||
- Experimental | ||
browser-compat: api.PerformanceResourceTiming.responseStatus | ||
--- | ||
|
||
{{APIRef("Performance API")}} {{SeeCompatTable}} | ||
|
||
The **`responseStatus`** read-only property represents the HTTP response status code returned when fetching the resource. | ||
|
||
This property maps to {{domxref("Response.status")}} from the [Fetch API](/en-US/docs/Web/API/Fetch_API). | ||
|
||
## Value | ||
|
||
The `responseStatus` property can have the following values: | ||
|
||
- A number indicating the [HTTP response status code](/en-US/docs/Web/HTTP/Status) returned when fetching the resource. | ||
- `0` if the [CORS](/en-US/docs/Web/HTTP/CORS) check fails. | ||
- `0` for cross-origin {{HTMLElement("iframe")}} objects. | ||
|
||
## Examples | ||
|
||
### Checking if a cache was hit | ||
|
||
The `responseStatus` property can be used to check for cached resources with a {{HTTPStatus("304")}} `Not Modified` response status code. | ||
|
||
Using a {{domxref("PerformanceObserver")}}: | ||
|
||
```js | ||
const observer = new PerformanceObserver((list) => { | ||
list.getEntries().forEach((entry) => { | ||
if (entry.responseStatus === 304) { | ||
console.log(`${entry.name} was loaded from cache`); | ||
} | ||
}); | ||
}); | ||
|
||
observer.observe({ type: "resource", buffered: true }); | ||
``` | ||
|
||
Or using {{domxref("Performance.getEntriesByType()")}}, which only shows `resource` performance entries present in the browser's performance timeline at the time you call this method: | ||
|
||
```js | ||
const resources = performance.getEntriesByType("resource"); | ||
resources.forEach((entry) => { | ||
if (entry.responseStatus === 304) { | ||
console.log(`${entry.name} was loaded from cache`); | ||
} | ||
}); | ||
``` | ||
|
||
Alternatively, if `responseStatus` is not available, you can check if the {{domxref("PerformanceResourceTiming.transferSize", "transferSize")}} property returned `0`. | ||
|
||
### Cross-origin response status codes | ||
|
||
If the value of the `responseStatus` property is `0`, the resource might be a cross-origin request. To allow seeing cross-origin response status codes, the [CORS](/en-US/docs/Web/HTTP/CORS) {{HTTPHeader("Access-Control-Allow-Origin")}} HTTP response header needs to be set. | ||
|
||
For example, to allow `https://developer.mozilla.org` to see response status codes, the cross-origin resource should send: | ||
|
||
```http | ||
Access-Control-Allow-Origin: https://developer.mozilla.org | ||
``` | ||
|
||
## Specifications | ||
|
||
{{Specifications}} | ||
|
||
## Browser compatibility | ||
|
||
{{Compat}} | ||
|
||
## See also | ||
|
||
- [HTTP response status code](/en-US/docs/Web/HTTP/Status) | ||
- {{domxref("Response.status")}} | ||
- [CORS](/en-US/docs/Web/HTTP/CORS) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters