Deno•2y ago

Headers for WebSocket client

I need to connect Deno (as a client) to a WebSocket server that requires custom headers on connection. I can't seem to find any currently supported method to accomplish this since the

WebSocket

WebSocket

API only allows for the

url

url

and

protocols

protocols

parameters.

Is there any known best practice to accomplish this?

Deno AI Helper•2/9/24, 10:12 PM

The documentation indicates that as of Deno 1.18, users have the ability to set custom headers on outbound WebSockets. This feature is available through the use of the unstable API. Here's an example from the documentation on how to use this feature:

The property in the options object has the same signature as the headers property in the

fetch

fetch

function, and / constructors. However, it's important to note that this is a non-standard extension and should be used with care.

To use this unstable feature, you might need to run your Deno script with the flag. Here's an example command to run your Deno script with the necessary permissions:

Remember to replace with the path to your actual Deno script file.

Helpful Links:
Deno 1.18 Release Notes
HTTP Server APIs | Deno Docs
HTTP Server: WebSockets - Deno by Example
Deno 1.12 Release Notes