@vercel/functions 3.6.3 → 3.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/docs/index/README.md +4 -0
  3. package/docs/index/functions/experimental_upgradeWebSocket.md +19 -0
  4. package/docs/index/interfaces/WebSocket.md +2187 -0
  5. package/docs/index/type-aliases/WebSocket.md +9 -0
  6. package/docs/index/type-aliases/WebSocketData.md +11 -0
  7. package/get-context.d.ts +13 -0
  8. package/index.d.ts +2 -0
  9. package/index.js +3 -0
  10. package/package.json +3 -1
  11. package/websocket/index.d.ts +2 -0
  12. package/websocket/index.js +77 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @vercel/functions
2
2
 
3
+ ## 3.7.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 3f3ef14: Add `experimental_upgradeWebSocket()` API
8
+
3
9
  ## 3.6.3
4
10
 
5
11
  ### Patch Changes
package/docs/index/README.md CHANGED
@@ -11,10 +11,13 @@
11
11
  - [PurgeApi](interfaces/PurgeApi.md)
12
12
  - [Request](interfaces/Request.md)
13
13
  - [RuntimeCache](interfaces/RuntimeCache.md)
14
+ - [WebSocket](interfaces/WebSocket.md)
14
15
 
15
16
  ## Type Aliases
16
17
 
17
18
  - [AddCacheTagApi](type-aliases/AddCacheTagApi.md)
19
+ - [WebSocket](type-aliases/WebSocket.md)
20
+ - [WebSocketData](type-aliases/WebSocketData.md)
18
21
 
19
22
  ## Variables
20
23
 
@@ -26,6 +29,7 @@
26
29
  - [attachDatabasePool](functions/attachDatabasePool.md)
27
30
  - [dangerouslyDeleteBySrcImage](functions/dangerouslyDeleteBySrcImage.md)
28
31
  - [dangerouslyDeleteByTag](functions/dangerouslyDeleteByTag.md)
32
+ - [experimental_upgradeWebSocket](functions/experimental_upgradeWebSocket.md)
29
33
  - [geolocation](functions/geolocation.md)
30
34
  - [getCache](functions/getCache.md)
31
35
  - [getEnv](functions/getEnv.md)
package/docs/index/functions/experimental_upgradeWebSocket.md ADDED
@@ -0,0 +1,19 @@
1
+ [**@vercel/functions**](../../README.md)
2
+
3
+ ***
4
+
5
+ # Function: experimental\_upgradeWebSocket()
6
+
7
+ > **experimental\_upgradeWebSocket**(`handler`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)\>
8
+
9
+ Defined in: [packages/functions/src/websocket/index.ts:4](https://github.com/vercel/vercel/blob/main/packages/functions/src/websocket/index.ts#L4)
10
+
11
+ ## Parameters
12
+
13
+ ### handler
14
+
15
+ (`ws`) => `void` \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
16
+
17
+ ## Returns
18
+
19
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Response`](https://developer.mozilla.org/docs/Web/API/Response)\>