1409752 - The documentation for WebSocket.send() omits ArrayBufferView type

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: API: Web Sockets, enhancement, P5)

Description

[guest271314]

:: Developer Documentation Request

      Request Type: Correction
     Gecko Version: unspecified
 Technical Contact: 

:: Details

The documentation for WebSocket.send() omits ArrayBufferView type at https://developer.mozilla.org/en-US/docs/Web/API/WebSocket#send(), see https://html.spec.whatwg.org/multipage/web-sockets.html#network

Comment 1

[Saurabh Nair [:jsx] (not reading bugmail. ni? if you need me)]

Hello,

"ArrayBufferView [1] - This is a helper type to simplify the specification, it isn't an interface and there are no objects implementing it".

So it probably doesn't make sense mentioning it there.

[1] - https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView

Comment 2

[guest271314]

(In reply to Saurabh Nair [:jsx] (not reading bugmail. ni? if you need me) from comment #1)
> Hello,
> 
> "ArrayBufferView [1] - This is a helper type to simplify the specification,
> it isn't an interface and there are no objects implementing it".
> 
> So it probably doesn't make sense mentioning it there.
> 
> [1] - https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView

There is no need to "simplify the specification" by omitting expected arguments to a method. That type of omission only leads to confusion https://stackoverflow.com/questions/46718355/sending-a-sub-segment-of-an-arraybuffer-over-a-websocket-without-copying/, not simplification.

Comment 3

[Saurabh Nair [:jsx] (not reading bugmail. ni? if you need me)]

Sorry, that was from my lack of understanding of ArrayBuffers. I'll leave it for someone else to update.

Comment 4

[Eric Shepherd [:sheppy]]

Added.