Skip to content

Commit 4be3c4c

Browse files
Enhance WebSocket connector documentation and improve code structure
- Updated comments and documentation for BrowserWebSocketConnector, MockWebSocketConnector, NodeWebSocketConnector, and WebSocketConnectorBase to provide clearer usage examples and detailed descriptions of methods and properties. - Improved the WebSocket connection lifecycle state enumeration for better clarity on state transitions. - Added comprehensive remarks for configuration options in WebSocketOptions interface. - Enhanced the WebSocketConnection interface with detailed descriptions for message handling and sending methods. - Improved overall code readability and maintainability by restructuring comments and examples.
1 parent e8609d4 commit 4be3c4c

16 files changed

+1099
-193
lines changed

docs/assets/highlight.css

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,92 @@
11
:root {
2+
--light-hl-0: #0000FF;
3+
--dark-hl-0: #569CD6;
4+
--light-hl-1: #000000;
5+
--dark-hl-1: #D4D4D4;
6+
--light-hl-2: #0070C1;
7+
--dark-hl-2: #4FC1FF;
8+
--light-hl-3: #795E26;
9+
--dark-hl-3: #DCDCAA;
10+
--light-hl-4: #A31515;
11+
--dark-hl-4: #CE9178;
12+
--light-hl-5: #001080;
13+
--dark-hl-5: #9CDCFE;
14+
--light-hl-6: #098658;
15+
--dark-hl-6: #B5CEA8;
16+
--light-hl-7: #AF00DB;
17+
--dark-hl-7: #C586C0;
18+
--light-hl-8: #267F99;
19+
--dark-hl-8: #4EC9B0;
20+
--light-hl-9: #008000;
21+
--dark-hl-9: #6A9955;
222
--light-code-background: #FFFFFF;
323
--dark-code-background: #1E1E1E;
424
}
525

626
@media (prefers-color-scheme: light) { :root {
27+
--hl-0: var(--light-hl-0);
28+
--hl-1: var(--light-hl-1);
29+
--hl-2: var(--light-hl-2);
30+
--hl-3: var(--light-hl-3);
31+
--hl-4: var(--light-hl-4);
32+
--hl-5: var(--light-hl-5);
33+
--hl-6: var(--light-hl-6);
34+
--hl-7: var(--light-hl-7);
35+
--hl-8: var(--light-hl-8);
36+
--hl-9: var(--light-hl-9);
737
--code-background: var(--light-code-background);
838
} }
939

1040
@media (prefers-color-scheme: dark) { :root {
41+
--hl-0: var(--dark-hl-0);
42+
--hl-1: var(--dark-hl-1);
43+
--hl-2: var(--dark-hl-2);
44+
--hl-3: var(--dark-hl-3);
45+
--hl-4: var(--dark-hl-4);
46+
--hl-5: var(--dark-hl-5);
47+
--hl-6: var(--dark-hl-6);
48+
--hl-7: var(--dark-hl-7);
49+
--hl-8: var(--dark-hl-8);
50+
--hl-9: var(--dark-hl-9);
1151
--code-background: var(--dark-code-background);
1252
} }
1353

1454
:root[data-theme='light'] {
55+
--hl-0: var(--light-hl-0);
56+
--hl-1: var(--light-hl-1);
57+
--hl-2: var(--light-hl-2);
58+
--hl-3: var(--light-hl-3);
59+
--hl-4: var(--light-hl-4);
60+
--hl-5: var(--light-hl-5);
61+
--hl-6: var(--light-hl-6);
62+
--hl-7: var(--light-hl-7);
63+
--hl-8: var(--light-hl-8);
64+
--hl-9: var(--light-hl-9);
1565
--code-background: var(--light-code-background);
1666
}
1767

1868
:root[data-theme='dark'] {
69+
--hl-0: var(--dark-hl-0);
70+
--hl-1: var(--dark-hl-1);
71+
--hl-2: var(--dark-hl-2);
72+
--hl-3: var(--dark-hl-3);
73+
--hl-4: var(--dark-hl-4);
74+
--hl-5: var(--dark-hl-5);
75+
--hl-6: var(--dark-hl-6);
76+
--hl-7: var(--dark-hl-7);
77+
--hl-8: var(--dark-hl-8);
78+
--hl-9: var(--dark-hl-9);
1979
--code-background: var(--dark-code-background);
2080
}
2181

82+
.hl-0 { color: var(--hl-0); }
83+
.hl-1 { color: var(--hl-1); }
84+
.hl-2 { color: var(--hl-2); }
85+
.hl-3 { color: var(--hl-3); }
86+
.hl-4 { color: var(--hl-4); }
87+
.hl-5 { color: var(--hl-5); }
88+
.hl-6 { color: var(--hl-6); }
89+
.hl-7 { color: var(--hl-7); }
90+
.hl-8 { color: var(--hl-8); }
91+
.hl-9 { color: var(--hl-9); }
2292
pre, code { background: var(--code-background); }

docs/classes/browser.BrowserWebSocketConnector.html

Lines changed: 23 additions & 14 deletions
Large diffs are not rendered by default.

docs/classes/index.WebSocketConnectorBase.html

Lines changed: 30 additions & 15 deletions
Large diffs are not rendered by default.

docs/classes/mock.MockWebSocket.html

Lines changed: 58 additions & 14 deletions
Large diffs are not rendered by default.

docs/classes/mock.MockWebSocketConnector.html

Lines changed: 96 additions & 22 deletions
Large diffs are not rendered by default.

docs/classes/node.NodeWebSocketConnector.html

Lines changed: 58 additions & 14 deletions
Large diffs are not rendered by default.

docs/enums/index.WebSocketState.html

Lines changed: 11 additions & 3 deletions
Large diffs are not rendered by default.

docs/interfaces/index.WebSocketConnection.html

Lines changed: 32 additions & 6 deletions
Large diffs are not rendered by default.

docs/interfaces/index.WebSocketConnector.html

Lines changed: 32 additions & 8 deletions
Large diffs are not rendered by default.

docs/interfaces/index.WebSocketOptions.html

Lines changed: 23 additions & 7 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)