RTCDataChannelStats - add docs #32498
Conversation
github-actions
bot
added
Content:WebAPI
| - {{domxref("RTCDataChannelStats.state", "state")}} | ||
| - : The {{domxref("RTCDataChannel.readyState", "readyState")}} of the associated `RTCDataChannel`. |
There was a problem hiding this comment.
FYI This is marked as required in the IDL, as are the common properties below. The rest are not, and are therefore optional. I've marked those as optional inline here for the other ones, but how should I mark up the detailed property docs as there is no "Optional header" macro?
The whole thing is a bit odd because this isn't like a dictionary passed as an argument - the required is more an instruction to the browser vendor that they are expected to provide the information rather than to users.
There was a problem hiding this comment.
how should I mark up the detailed property docs as there is no "Optional header" macro?
I would just leave this. As you say it is a weird case.
hamishwillee
requested review from
sideshowbarker,
pepelsbey and
wbamberg
and removed request for
a team
|
This pull request has merge conflicts that must be resolved before it can be merged. |
|
This pull request has merge conflicts that must be resolved before it can be merged. |
github-actions
bot
added
merge conflicts 🚧
hamishwillee
force-pushed
the
RTCDataChannelStats
branch
from
d648ac0
to
d52bb13
Compare
Co-authored-by: wbamberg <will@bootbonnet.ca>
|
Thanks very much for merging (and also for reviewing). I thought there would be more to it than this so had been waiting to find a spare few hours. |
This adds docs for
RTCDataChannelStats, a "codec statistics" object/dictionary you can get by iterating aRTCStatsReport.It is not very exciting. Largely following the same patterns as the other docs.
This is part of the ongoing work to finished RTC stats, which was started in #27028