RTCError and RTCErrorEvent docs by hamishwillee · Pull Request #44047 · mdn/content

hamishwillee · 2026-05-08T07:08:52Z

FF150 adds support for RTCErrorEvent and RTCError.

This updates the docs for those interfaces to match the current API templates, fixes weird layout, adds missing constructors.

This should all be at least as correct as it was before I started.

Related docs work can be tracked in #43970

github-actions · 2026-05-08T07:10:05Z

 ## Instance properties

-_In addition to the properties defined by the parent interface, {{domxref("DOMException")}}, `RTCError` includes the following properties:_
+_Also inherits properties from its parent interface, {{DOMxRef("DOMException")}}_


[markdownlint] _{reported by reviewdog 🐶}
error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Also inherits properties from ..."]

@chrisdavidmills I plan to ignore these reviewdoc notes.

github-actions · 2026-05-08T07:10:05Z

 ## Instance properties

-_In addition to the standard properties available on the {{domxref("Event")}} interface, `RTCErrorEvent` also includes the following:_
+_Also inherits properties from its parent interface, {{domxref("Event")}}_


[markdownlint] _{reported by reviewdog 🐶}
error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Also inherits properties from ..."]

github-actions · 2026-05-08T07:10:05Z

 ## Instance methods

-_No additional methods are provided beyond any found on the parent interface, {{domxref("Event")}}._
+_Only inherits properties from its parent interface, {{domxref("Event")}}_


[markdownlint] _{reported by reviewdog 🐶}
error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Only inherits properties from ..."]

github-actions · 2026-05-08T07:10:56Z

Preview URLs (10 pages)

chrisdavidmills

@hamishwillee, more lovely comments for you. This is looking much better than it did before.

chrisdavidmills · 2026-05-11T12:38:50Z

+
+{{APIRef("WebRTC")}}
+
+The **`RTCError()`** constructor creates and returns a new {{domxref("RTCError")}} object initialized with the different parameters and, optionally, a string to use as the value of the error's message property.


Suggested change

The **`RTCError()`** constructor creates and returns a new {{domxref("RTCError")}} object initialized with the different parameters and, optionally, a string to use as the value of the error's message property.

The **`RTCError()`** constructor creates and returns a new {{domxref("RTCError")}} object instance.

The rest of the description seemed a bit unnecessary.

chrisdavidmills · 2026-05-11T12:39:54Z

+### Parameters
+
+- `options`
+  - : An object that can be provided to set the details of the specific error in an RTCErrorEvent.


Suggested change

- : An object that can be provided to set the details of the specific error in an RTCErrorEvent.

- : An object providing the details of the specific error in an `RTCErrorEvent`.

chrisdavidmills · 2026-05-11T12:55:35Z

+            SCTP error cause codes 1-13 are defined in the SCTP specification: {{RFC(4960, "", "3.3.10")}}.
+        - `sdp-syntax-error`
+          - : The SDP syntax is invalid.
+            The line number within the SDP at which the error was detected should be set in [`sdpLineNumber`](#sdplinenumber).


Suggested change

The line number within the SDP at which the error was detected should be set in [`sdpLineNumber`](#sdplinenumber).

The SDP message line number at which the error was detected should be set in [`sdpLineNumber`](#sdplinenumber).

chrisdavidmills · 2026-05-11T12:56:25Z

+        This should only be set if `errorDetail` is `sctp-failure`.
+
+    - `sdpLineNumber` {{optional_inline}}
+      - : An integer identifying the line number of the {{Glossary("SDP")}} on which a syntax error occurred.


Suggested change

- : An integer identifying the line number of the {{Glossary("SDP")}} on which a syntax error occurred.

- : An integer identifying the {{Glossary("SDP")}} message line number at which a syntax error occurred.

chrisdavidmills · 2026-05-11T12:57:18Z

+
+### Return value
+
+A newly-created {{domxref("RTCError")}} object.


Suggested change

A newly-created {{domxref("RTCError")}} object.

A newly-created {{domxref("RTCError")}} object instance.

chrisdavidmills · 2026-05-11T13:38:11Z

+  - : The negotiation of the {{Glossary("DTLS")}} connection failed, or the connection was terminated with a fatal error.
+    The error's {{domxref("DOMException.message", "message")}} contains details about the nature of the error.
+    If a fatal error is _received_, the error object's {{domxref("RTCError.receivedAlert", "receivedAlert")}} property is set to the value of the DTLSL alert received.
+    If, on the other hand, a fatal error was _sent_, the {{domxref("RTCError.sentAlert", "sentAlert")}} is set to the alert's value.


Suggested change

If, on the other hand, a fatal error was _sent_, the {{domxref("RTCError.sentAlert", "sentAlert")}} is set to the alert's value.

If, on the other hand, a fatal error was _sent_, the {{domxref("RTCError.sentAlert", "sentAlert")}} property is set to the alert's value.

chrisdavidmills · 2026-05-11T13:39:05Z

-    alert's value.
+  - : The negotiation of the {{Glossary("DTLS")}} connection failed, or the connection was terminated with a fatal error.
+    The error's {{domxref("DOMException.message", "message")}} contains details about the nature of the error.
+    If a fatal error is _received_, the error object's {{domxref("RTCError.receivedAlert", "receivedAlert")}} property is set to the value of the DTLSL alert received.


Is "DTLSL" supposed to be "DTLS"? I think there might have been another instance of this somewhere else.

chrisdavidmills · 2026-05-11T13:40:21Z

-    the fingerprints listed in the SDP. If the remote peer can't match the local
-    certificate against the provided fingerprints, this error doesn't occur, though this
-    situation may result instead in a `dtls-failure` error.
+  - : The remote certificate for the {{domxref("RTCDtlsTransport")}} didn't match any of the fingerprints listed in the SDP.


Link "SDP" to glossary entry?

chrisdavidmills · 2026-05-11T13:41:52Z

-    object's {{domxref("RTCError.sctpCauseCode", "sctpCauseCode")}}. SCTP error cause
-    codes 1-13 are defined in the SCTP specification: {{RFC(4960, "", "3.3.10")}}.
+  - : The {{Glossary("SCTP")}} negotiation has failed, or the connection has terminated with a fatal error.
+    The SCTP cause code can be found in the `RTCError` object's {{domxref("RTCError.sctpCauseCode", "sctpCauseCode")}}.


Suggested change

The SCTP cause code can be found in the `RTCError` object's {{domxref("RTCError.sctpCauseCode", "sctpCauseCode")}}.

The SCTP cause code can be found in the `RTCError` object's {{domxref("RTCError.sctpCauseCode", "sctpCauseCode")}} property.

chrisdavidmills · 2026-05-11T13:43:04Z

-
-tbd
+  - : The SDP syntax is invalid.
+    The error's {{domxref("RTCError.sdpLineNumber", "sdpLineNumber")}} property indicates the line number within the SDP at which the error was detected.


Suggested change

The error's {{domxref("RTCError.sdpLineNumber", "sdpLineNumber")}} property indicates the line number within the SDP at which the error was detected.

The error's {{domxref("RTCError.sdpLineNumber", "sdpLineNumber")}} property indicates the SDP message line number where the error was detected.

RTCError and RTCErrorEvent docs

ade0e11

hamishwillee requested a review from a team as a code owner May 8, 2026 07:08

hamishwillee requested review from chrisdavidmills and removed request for a team May 8, 2026 07:08

github-actions Bot added Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed labels May 8, 2026

hamishwillee mentioned this pull request May 8, 2026

[WebAPI] RTC updates #43970

Open

8 tasks

github-actions Bot reviewed May 8, 2026

View reviewed changes

chrisdavidmills requested changes May 11, 2026

View reviewed changes


		{{APIRef("WebRTC")}}

		The `RTCError()` constructor creates and returns a new {{domxref("RTCError")}} object initialized with the different parameters and, optionally, a string to use as the value of the error's message property.

	- : An object that can be provided to set the details of the specific error in an RTCErrorEvent.
	- : An object providing the details of the specific error in an `RTCErrorEvent`.

	The line number within the SDP at which the error was detected should be set in [`sdpLineNumber`](#sdplinenumber).
	The SDP message line number at which the error was detected should be set in [`sdpLineNumber`](#sdplinenumber).

	- : An integer identifying the line number of the {{Glossary("SDP")}} on which a syntax error occurred.
	- : An integer identifying the {{Glossary("SDP")}} message line number at which a syntax error occurred.


		### Return value

		A newly-created {{domxref("RTCError")}} object.

	If, on the other hand, a fatal error was _sent_, the {{domxref("RTCError.sentAlert", "sentAlert")}} is set to the alert's value.
	If, on the other hand, a fatal error was _sent_, the {{domxref("RTCError.sentAlert", "sentAlert")}} property is set to the alert's value.

	The SCTP cause code can be found in the `RTCError` object's {{domxref("RTCError.sctpCauseCode", "sctpCauseCode")}}.
	The SCTP cause code can be found in the `RTCError` object's {{domxref("RTCError.sctpCauseCode", "sctpCauseCode")}} property.

	The error's {{domxref("RTCError.sdpLineNumber", "sdpLineNumber")}} property indicates the line number within the SDP at which the error was detected.
	The error's {{domxref("RTCError.sdpLineNumber", "sdpLineNumber")}} property indicates the SDP message line number where the error was detected.

Conversation

hamishwillee commented May 8, 2026

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented May 8, 2026

Uh oh!

chrisdavidmills left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants