upgradeWebSocket | /http.ts | cav@0.0.21

Module

x/cav/http.ts>upgradeWebSocket

A server framework for Deno

connorlogin/cav

Go to Latest

mod.ts (default module)

Ctx

Rpc

rpc

Ctx

Rpc

rpc

function upgradeWebSocket

import { upgradeWebSocket } from "https://deno.land/x/cav@0.0.21/http.ts";

upgradeWebSocket<Send = unknown, Message extends Parser | null = null>(req: Request, init?: SocketInit<Message>): { socket: Socket<Send, (Message extends Parser ? ParserOutput<Message> : unknown)>; response: Response; }

The server-side equivalent of the wrapWebSocket function in the client module. Returns the Socket instance and a Response which should be returned by the handler for the socket upgrade to complete successfully.

Type Parameters

optional

Send = unknown

optional

Message extends Parser | null = null

Parameters

req: Request

optional

init: SocketInit<Message>

Returns

{ socket: Socket<Send, (Message extends Parser ? ParserOutput<Message> : unknown)>; response: Response; }