foster/deno
0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-03-03 17:34:47 -05:00
Code Issues Packages 1 Wiki Activity

docs(std): add some missing JSDoc ws/mod.ts (#8428)

Browse source
This commit is contained in:
ThenMorning 2020-11-25 20:53:24 +08:00 • committed by GitHub
parent adbbd85461
commit bfd1da4871
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
std/ws/mod.ts
View file

@ -31,6 +31,7 @@ export interface WebSocketCloseEvent {
reason?: string; reason?: string;
} }
/** Returns true if input value is a WebSocketCloseEvent, false otherwise. */
export function isWebSocketCloseEvent( export function isWebSocketCloseEvent(
a: WebSocketEvent, a: WebSocketEvent,
): a is WebSocketCloseEvent { ): a is WebSocketCloseEvent {
@ -39,6 +40,7 @@ export function isWebSocketCloseEvent(
export type WebSocketPingEvent = ["ping", Uint8Array]; export type WebSocketPingEvent = ["ping", Uint8Array];
/** Returns true if input value is a WebSocketPingEvent, false otherwise. */
export function isWebSocketPingEvent( export function isWebSocketPingEvent(
a: WebSocketEvent, a: WebSocketEvent,
): a is WebSocketPingEvent { ): a is WebSocketPingEvent {
@ -47,6 +49,7 @@ export function isWebSocketPingEvent(
export type WebSocketPongEvent = ["pong", Uint8Array]; export type WebSocketPongEvent = ["pong", Uint8Array];
/** Returns true if input value is a WebSocketPongEvent, false otherwise. */
export function isWebSocketPongEvent( export function isWebSocketPongEvent(
a: WebSocketEvent, a: WebSocketEvent,
): a is WebSocketPongEvent { ): a is WebSocketPongEvent {
@ -102,7 +105,7 @@ export function unmask(payload: Uint8Array, mask?: Uint8Array): void {
} }
} }
/** Write websocket frame to given writer */ /** Write WebSocket frame to inputted writer. */
export async function writeFrame( export async function writeFrame(
frame: WebSocketFrame, frame: WebSocketFrame,
writer: Deno.Writer, writer: Deno.Writer,
@ -385,7 +388,7 @@ class WebSocketImpl implements WebSocket {
} }
} }
/** Return whether given headers is acceptable for websocket */ /** Returns true if input headers are usable for WebSocket, otherwise false. */
export function acceptable(req: { headers: Headers }): boolean { export function acceptable(req: { headers: Headers }): boolean {
const upgrade = req.headers.get("upgrade"); const upgrade = req.headers.get("upgrade");
if (!upgrade || upgrade.toLowerCase() !== "websocket") { if (!upgrade || upgrade.toLowerCase() !== "websocket") {
@ -401,7 +404,7 @@ export function acceptable(req: { headers: Headers }): boolean {
const kGUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; const kGUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
/** Create sec-websocket-accept header value with given nonce */ /** Create value of Sec-WebSocket-Accept header from inputted nonce. */
export function createSecAccept(nonce: string): string { export function createSecAccept(nonce: string): string {
const sha1 = new Sha1(); const sha1 = new Sha1();
sha1.update(nonce + kGUID); sha1.update(nonce + kGUID);
@ -409,7 +412,7 @@ export function createSecAccept(nonce: string): string {
return btoa(String.fromCharCode(...bytes)); return btoa(String.fromCharCode(...bytes));
} }
/** Upgrade given TCP connection into websocket connection */ /** Upgrade inputted TCP connection into WebSocket connection. */
export async function acceptWebSocket(req: { export async function acceptWebSocket(req: {
conn: Deno.Conn; conn: Deno.Conn;
bufWriter: BufWriter; bufWriter: BufWriter;
@ -439,7 +442,7 @@ export async function acceptWebSocket(req: {
const kSecChars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-.~_"; const kSecChars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-.~_";
/** Create WebSocket-Sec-Key. Base64 encoded 16 bytes string */ /** Returns base64 encoded 16 bytes string for Sec-WebSocket-Key header. */
export function createSecKey(): string { export function createSecKey(): string {
let key = ""; let key = "";
for (let i = 0; i < 16; i++) { for (let i = 0; i < 16; i++) {