Skip to content

Commit 4ce8b93

Browse files
committed
doc: add missing PerformanceResourceTiming properties
these 5 properties were implemented but never got documented: initiatorType, nextHopProtocol, responseStart, deliveryType, responseStatus Fixes: #55793
1 parent a57893b commit 4ce8b93

File tree

1 file changed

+84
-0
lines changed

1 file changed

+84
-0
lines changed

doc/api/perf_hooks.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -906,6 +906,25 @@ resources.
906906

907907
The constructor of this class is not exposed to users directly.
908908

909+
### `performanceResourceTiming.initiatorType`
910+
911+
<!-- YAML
912+
added:
913+
- v18.8.0
914+
- v16.17.0
915+
changes:
916+
- version: v19.0.0
917+
pr-url: https://github.com/nodejs/node/pull/44483
918+
description: This property getter must be called with the
919+
`PerformanceResourceTiming` object as the receiver.
920+
-->
921+
922+
* Type: {string}
923+
924+
A string representing the type of resource that initiated the performance
925+
entry. The value depends on the context in which the resource was fetched
926+
(e.g. `'fetch'`).
927+
909928
### `performanceResourceTiming.workerStart`
910929

911930
<!-- YAML
@@ -1071,6 +1090,27 @@ changes:
10711090
The high resolution millisecond timestamp representing the time immediately
10721091
before Node.js starts the handshake process to secure the current connection.
10731092

1093+
### `performanceResourceTiming.nextHopProtocol`
1094+
1095+
<!-- YAML
1096+
added:
1097+
- v18.2.0
1098+
- v16.17.0
1099+
changes:
1100+
- version: v19.0.0
1101+
pr-url: https://github.com/nodejs/node/pull/44483
1102+
description: This property getter must be called with the
1103+
`PerformanceResourceTiming` object as the receiver.
1104+
-->
1105+
1106+
* Type: {string}
1107+
1108+
A string representing the network protocol used to fetch the resource, as
1109+
identified by the [ALPN protocol ID (RFC 7301)][]. When a proxy is used, if
1110+
a tunnel connection is established, this property returns the ALPN protocol
1111+
ID of the tunneled protocol. Otherwise, this property returns the ALPN
1112+
protocol ID of the first hop to the proxy.
1113+
10741114
### `performanceResourceTiming.requestStart`
10751115

10761116
<!-- YAML
@@ -1089,6 +1129,24 @@ changes:
10891129
The high resolution millisecond timestamp representing the time immediately
10901130
before Node.js receives the first byte of the response from the server.
10911131

1132+
### `performanceResourceTiming.responseStart`
1133+
1134+
<!-- YAML
1135+
added:
1136+
- v18.2.0
1137+
- v16.17.0
1138+
changes:
1139+
- version: v19.0.0
1140+
pr-url: https://github.com/nodejs/node/pull/44483
1141+
description: This property getter must be called with the
1142+
`PerformanceResourceTiming` object as the receiver.
1143+
-->
1144+
1145+
* Type: {number}
1146+
1147+
The high resolution millisecond timestamp representing the time immediately
1148+
after Node.js receives the first byte of the response from the server.
1149+
10921150
### `performanceResourceTiming.responseEnd`
10931151

10941152
<!-- YAML
@@ -1164,6 +1222,31 @@ A number representing the size (in octets) received from the fetch
11641222
(HTTP or cache), of the message body, after removing any applied
11651223
content-codings.
11661224

1225+
### `performanceResourceTiming.deliveryType`
1226+
1227+
<!-- YAML
1228+
added: v22.2.0
1229+
-->
1230+
1231+
* Type: {string}
1232+
1233+
A string representing how the resource was delivered. The value is one of the
1234+
following:
1235+
1236+
* `'cache'` if the resource was retrieved from the cache.
1237+
* `''` (empty string) otherwise.
1238+
1239+
### `performanceResourceTiming.responseStatus`
1240+
1241+
<!-- YAML
1242+
added: v22.2.0
1243+
-->
1244+
1245+
* Type: {number}
1246+
1247+
A number representing the HTTP response status code returned when fetching
1248+
the resource.
1249+
11671250
### `performanceResourceTiming.toJSON()`
11681251

11691252
<!-- YAML
@@ -2346,6 +2429,7 @@ dns.lookup('localhost', () => {});
23462429
dns.promises.resolve('localhost');
23472430
```
23482431

2432+
[ALPN protocol ID (RFC 7301)]: https://www.rfc-editor.org/rfc/rfc7301
23492433
[Async Hooks]: async_hooks.md
23502434
[Fetch Response Body Info]: https://fetch.spec.whatwg.org/#response-body-info
23512435
[Fetch Timing Info]: https://fetch.spec.whatwg.org/#fetch-timing-info

0 commit comments

Comments
 (0)