RTCError and RTCErrorEvent docs#44047
Open
hamishwillee wants to merge 1 commit intomdn:mainfrom
Open
Conversation
github-actions
Bot
added
Content:WebAPI
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ## 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")}}_ |
Contributor
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Also inherits properties from ..."]
Collaborator
Author
There was a problem hiding this comment.
@chrisdavidmills I plan to ignore these reviewdoc notes.
| ## 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")}}_ |
Contributor
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Also inherits properties from ..."]
| ## 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")}}_ |
Contributor
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
error MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Only inherits properties from ..."]
Contributor
chrisdavidmills
requested changes
May 11, 2026
Contributor
chrisdavidmills
left a comment
chrisdavidmills
left a comment
There was a problem hiding this comment.
@hamishwillee, more lovely comments for you. This is looking much better than it did before.
|
|
||
| {{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. |
Contributor
There was a problem hiding this comment.
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.
| ### Parameters | ||
|
|
||
| - `options` | ||
| - : An object that can be provided to set the details of the specific error in an RTCErrorEvent. |
Contributor
There was a problem hiding this comment.
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`. |
| 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). |
Contributor
There was a problem hiding this comment.
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). |
| 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. |
Contributor
There was a problem hiding this comment.
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. |
|
|
||
| ### Return value | ||
|
|
||
| A newly-created {{domxref("RTCError")}} object. |
Contributor
There was a problem hiding this comment.
Suggested change
| A newly-created {{domxref("RTCError")}} object. | |
| A newly-created {{domxref("RTCError")}} object instance. |
| - : 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. |
Contributor
There was a problem hiding this comment.
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. |
| 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. |
Contributor
There was a problem hiding this comment.
Is "DTLSL" supposed to be "DTLS"? I think there might have been another instance of this somewhere else.
| 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. |
Contributor
There was a problem hiding this comment.
Link "SDP" to glossary entry?
| 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")}}. |
Contributor
There was a problem hiding this comment.
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. |
|
|
||
| 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. |
Contributor
There was a problem hiding this comment.
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. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
FF150 adds support for
RTCErrorEventandRTCError.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