Skip to content

Commit bb5d44b

Browse files
committed
[doc] Sort error codes alphabetically
1 parent c6e3080 commit bb5d44b

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

doc/ws.md

+27-27
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,17 @@
4545
- [websocket.url](#websocketurl)
4646
- [WebSocket.createWebSocketStream(websocket[, options])](#websocketcreatewebsocketstreamwebsocket-options)
4747
- [WS Error Codes](#ws-error-codes)
48-
- [WS_ERR_UNSUPPORTED_MESSAGE_LENGTH](#wserrunsupporteddatapayloadlength)
49-
- [WS_ERR_UNSUPPORTED_DATA_PAYLOAD_LENGTH](#wserrunsupporteddatapayloadlength)
48+
- [WS_ERR_EXPECTED_FIN](#wserrexpectedfin)
49+
- [WS_ERR_EXPECTED_MASK](#wserrexpectedmask)
50+
- [WS_ERR_INVALID_CLOSE_CODE](#wserrinvalidclosecode)
5051
- [WS_ERR_INVALID_CONTROL_PAYLOAD_LENGTH](#wserrinvalidcontrolpayloadlength)
51-
- [WS_ERR_INVALID_UTF8](#wserrinvalidutf8)
5252
- [WS_ERR_INVALID_OPCODE](#wserrinvalidopcode)
53-
- [WS_ERR_INVALID_CLOSE_CODE](#wserrinvalidclosecode)
53+
- [WS_ERR_INVALID_UTF8](#wserrinvalidutf8)
54+
- [WS_ERR_UNEXPECTED_MASK](#wserrunexpectedmask)
5455
- [WS_ERR_UNEXPECTED_RSV_1](#wserrunexpectedrsv1)
5556
- [WS_ERR_UNEXPECTED_RSV_2_3](#wserrunexpectedrsv23)
56-
- [WS_ERR_EXPECTED_FIN](#wserrexpectedfin)
57-
- [WS_ERR_EXPECTED_MASK](#wserrexpectedmask)
58-
- [WS_ERR_UNEXPECTED_MASK](#wserrunexpectedmask)
57+
- [WS_ERR_UNSUPPORTED_DATA_PAYLOAD_LENGTH](#wserrunsupporteddatapayloadlength)
58+
- [WS_ERR_UNSUPPORTED_MESSAGE_LENGTH](#wserrunsupporteddatapayloadlength)
5959

6060
## Class: WebSocket.Server
6161

@@ -511,31 +511,33 @@ given `WebSocket`.
511511
Errors emitted by the websocket may have a `.code` property, describing the
512512
specific type of error that has occurred:
513513

514-
### WS_ERR_UNSUPPORTED_MESSAGE_LENGTH
514+
### WS_ERR_EXPECTED_FIN
515515

516-
A message was received with a length longer than the maximum supported length,
517-
as configured by the `maxPayload` option.
516+
A WebSocket frame was received with the FIN bit not set when it was expected.
518517

519-
### WS_ERR_UNSUPPORTED_DATA_PAYLOAD_LENGTH
518+
### WS_ERR_EXPECTED_MASK
520519

521-
A data frame was received with a length longer the max supported length (2^53-1,
522-
due to JavaScript language limitations).
520+
An unmasked WebSocket frame was received by a WebSocket server.
523521

524-
### WS_ERR_INVALID_CONTROL_PAYLOAD_LENGTH
522+
### WS_ERR_INVALID_CLOSE_CODE
525523

526-
A control frame with an invalid payload length was received.
524+
A WebSocket close frame was received with an invalid close code.
527525

528-
### WS_ERR_INVALID_UTF8
526+
### WS_ERR_INVALID_CONTROL_PAYLOAD_LENGTH
529527

530-
A text or close frame was received containing invalid UTF-8 data.
528+
A control frame with an invalid payload length was received.
531529

532530
### WS_ERR_INVALID_OPCODE
533531

534532
A WebSocket frame was received with an invalid opcode.
535533

536-
### WS_ERR_INVALID_CLOSE_CODE
534+
### WS_ERR_INVALID_UTF8
537535

538-
A WebSocket close frame was received with an invalid close code.
536+
A text or close frame was received containing invalid UTF-8 data.
537+
538+
### WS_ERR_UNEXPECTED_MASK
539+
540+
A masked WebSocket frame was received by a WebSocket client.
539541

540542
### WS_ERR_UNEXPECTED_RSV_1
541543

@@ -545,17 +547,15 @@ A WebSocket frame was received with the RSV1 bit set unexpectedly.
545547

546548
A WebSocket frame was received with the RSV2 or RSV3 bit set unexpectedly.
547549

548-
### WS_ERR_EXPECTED_FIN
549-
550-
A WebSocket frame was received with the FIN bit not set when it was expected.
551-
552-
### WS_ERR_EXPECTED_MASK
550+
### WS_ERR_UNSUPPORTED_DATA_PAYLOAD_LENGTH
553551

554-
An unmasked WebSocket frame was received by a WebSocket server.
552+
A data frame was received with a length longer the max supported length (2^53-1,
553+
due to JavaScript language limitations).
555554

556-
### WS_ERR_UNEXPECTED_MASK
555+
### WS_ERR_UNSUPPORTED_MESSAGE_LENGTH
557556

558-
A masked WebSocket frame was received by a WebSocket client.
557+
A message was received with a length longer than the maximum supported length,
558+
as configured by the `maxPayload` option.
559559

560560
[concurrency-limit]: https://github.com/websockets/ws/issues/1202
561561
[duplex-options]:

0 commit comments

Comments
 (0)