Skip to content

Commit 0c83e54

Browse files
authored
Merge pull request #117 from FedFer98123/main
Fix WebSocket plugin references
2 parents f0e2196 + 1382648 commit 0c83e54

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

docs/patterns/websocket.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
title: WebSocket Plugin - ElysiaJS
2+
title: WebSocket - ElysiaJS
33
head:
44
- - meta
55
- property: 'title'
6-
content: WebSocket Plugin - ElysiaJS
6+
content: WebSocket - ElysiaJS
77

88
- - meta
99
- 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".
1111

1212
- - meta
1313
- 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".
1515
---
1616

1717
# WebSocket
@@ -43,7 +43,7 @@ new Elysia({
4343
})
4444
```
4545

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.
4747

4848
Below is a config that extends from [Bun WebSocket](https://bun.sh/docs/api/websockets#create-a-websocket-server)
4949

@@ -79,7 +79,7 @@ Close the connection if the backpressure limit is reached.
7979

8080
## Methods
8181

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
8383

8484
## ws
8585

@@ -215,10 +215,6 @@ Like `transform`, but execute before validation of WebSocket message
215215

216216
Additional headers to add before upgrade connection to WebSocket.
217217

218-
## Pattern
219-
220-
Below you can find the common patterns to use the plugin.
221-
222218
## WebSocket message validation:
223219

224220
Validate incoming WebSocket message.

0 commit comments

Comments
 (0)