|
1 | 1 | ---
|
2 |
| -title: WebSocket Plugin - ElysiaJS |
| 2 | +title: WebSocket - ElysiaJS |
3 | 3 | head:
|
4 | 4 | - - meta
|
5 | 5 | - property: 'title'
|
6 |
| - content: WebSocket Plugin - ElysiaJS |
| 6 | + content: WebSocket - ElysiaJS |
7 | 7 |
|
8 | 8 | - - meta
|
9 | 9 | - name: 'description'
|
10 |
| - content: Plugin for Elysia that add support for using WebSocket. Start by registering the plugin and declare WebSocket route with "ws". |
| 10 | + content: Elysia's WebSocket implementation. Start by declaring WebSocket route with "ws". |
11 | 11 |
|
12 | 12 | - - meta
|
13 | 13 | - name: 'og:description'
|
14 |
| - content: Plugin for Elysia that add support for using WebSocket. Start by registering the plugin and declare WebSocket route with "ws". |
| 14 | + content: Elysia's WebSocket implementation. Start by declaring WebSocket route with "ws". |
15 | 15 | ---
|
16 | 16 |
|
17 | 17 | # WebSocket
|
@@ -43,7 +43,7 @@ new Elysia({
|
43 | 43 | })
|
44 | 44 | ```
|
45 | 45 |
|
46 |
| -Elysia's WebSocket plugin extends Bun's WebSocket configuration so if you wish to configure the websocket you can refer to [Bun's WebSocket documentation](https://bun.sh/docs/api/websockets) to learn more about this. |
| 46 | +Elysia's WebSocket implementation extends Bun's WebSocket configuration so if you wish to configure the websocket you can refer to [Bun's WebSocket documentation](https://bun.sh/docs/api/websockets) to learn more about this. |
47 | 47 |
|
48 | 48 | Below is a config that extends from [Bun WebSocket](https://bun.sh/docs/api/websockets#create-a-websocket-server)
|
49 | 49 |
|
@@ -79,7 +79,7 @@ Close the connection if the backpressure limit is reached.
|
79 | 79 |
|
80 | 80 | ## Methods
|
81 | 81 |
|
82 |
| -Below are the new methods that are available to the WebSocket plugin |
| 82 | +Below are the new methods that are available to the WebSocket route |
83 | 83 |
|
84 | 84 | ## ws
|
85 | 85 |
|
@@ -215,10 +215,6 @@ Like `transform`, but execute before validation of WebSocket message
|
215 | 215 |
|
216 | 216 | Additional headers to add before upgrade connection to WebSocket.
|
217 | 217 |
|
218 |
| -## Pattern |
219 |
| - |
220 |
| -Below you can find the common patterns to use the plugin. |
221 |
| - |
222 | 218 | ## WebSocket message validation:
|
223 | 219 |
|
224 | 220 | Validate incoming WebSocket message.
|
|
0 commit comments