Confusing wording around return value of RTCPeerConnection.createOffer

[srujzs]

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createOffer

What specific section or headline is this issue about?

Return value

What information was incorrect, unhelpful, or incomplete?

In the main section, the return value is described as:

The return value is a Promise which, when the offer has been created, is resolved with a RTCSessionDescription object containing the newly-created offer.

But then in the "Return value" section, it states:

A Promise whose fulfillment handler will receive an object conforming to the RTCSessionDescriptionInit dictionary which contains the SDP describing the generated offer. That received offer should be delivered through the signaling server to a remote peer.

which seems incompatible, or at the very least, confusing.

What did you expect to see?

The sections describing the return value should be the same.

Do you have any supporting links, references, or citations?

No response

Do you have anything more you want to share?

No response

[Josh-Cena]

Do you mean that RTCSessionDescriptionInit and RTCSessionDescription are incompatible? The correct one should be RTCSessionDescriptionInit per spec. Technically, the two objects have the same properties so it shouldn't be too jarring_, but it's not an RTCSessionDescription instance.

[srujzs]

RTCSessionDescription seems to have an extra toJSON method which RTCSessionDescriptionInit does not. For the most part, they're similar enough, but having inconsistent wording is a little bit confusing.