Socket
Socket
Sign inDemoInstall

@types/ws

Package Overview
Dependencies
2
Maintainers
1
Versions
74
Alerts
File Explorer

Advanced tools

npm Scripts
License

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 7.4.7 to 8.2.0

68

ws/index.d.ts

@@ -1,2 +0,2 @@

// Type definitions for ws 7.4
// Type definitions for ws 8.2
// Project: https://github.com/websockets/ws

@@ -62,3 +62,3 @@ // Definitions by: Paul Loyd <https://github.com/loyd>

onopen: (event: WebSocket.OpenEvent) => void;
onopen: (event: WebSocket.Event) => void;
onerror: (event: WebSocket.ErrorEvent) => void;

@@ -75,3 +75,3 @@ onclose: (event: WebSocket.CloseEvent) => void;

close(code?: number, data?: string): void;
close(code?: number, data?: string | Buffer): void;
ping(data?: any, mask?: boolean, cb?: (err: Error) => void): void;

@@ -90,3 +90,3 @@ pong(data?: any, mask?: boolean, cb?: (err: Error) => void): void;

method: "message",
cb: (event: { data: any; type: string; target: WebSocket }) => void,
cb: (event: WebSocket.MessageEvent) => void,
options?: WebSocket.EventListenerOptions,

@@ -96,3 +96,3 @@ ): void;

method: "close",
cb: (event: { wasClean: boolean; code: number; reason: string; target: WebSocket }) => void,
cb: (event: WebSocket.CloseEvent) => void,
options?: WebSocket.EventListenerOptions,

@@ -102,3 +102,3 @@ ): void;

method: "error",
cb: (event: { error: any; message: any; type: string; target: WebSocket }) => void,
cb: (event: WebSocket.ErrorEvent) => void,
options?: WebSocket.EventListenerOptions,

@@ -108,24 +108,16 @@ ): void;

method: "open",
cb: (event: { target: WebSocket }) => void,
cb: (event: WebSocket.Event) => void,
options?: WebSocket.EventListenerOptions,
): void;
addEventListener(method: string, listener: () => void, options?: WebSocket.EventListenerOptions): void;
removeEventListener(method: "message", cb?: (event: { data: any; type: string; target: WebSocket }) => void): void;
removeEventListener(
method: "close",
cb?: (event: { wasClean: boolean; code: number; reason: string; target: WebSocket }) => void,
): void;
removeEventListener(
method: "error",
cb?: (event: { error: any; message: any; type: string; target: WebSocket }) => void,
): void;
removeEventListener(method: "open", cb?: (event: { target: WebSocket }) => void): void;
removeEventListener(method: string, listener?: () => void): void;
removeEventListener(method: "message", cb: (event: WebSocket.MessageEvent) => void): void;
removeEventListener(method: "close", cb: (event: WebSocket.CloseEvent) => void): void;
removeEventListener(method: "error", cb: (event: WebSocket.ErrorEvent) => void): void;
removeEventListener(method: "open", cb: (event: WebSocket.Event) => void): void;
// Events
on(event: "close", listener: (this: WebSocket, code: number, reason: string) => void): this;
on(event: "close", listener: (this: WebSocket, code: number, reason: Buffer) => void): this;
on(event: "error", listener: (this: WebSocket, err: Error) => void): this;
on(event: "upgrade", listener: (this: WebSocket, request: IncomingMessage) => void): this;
on(event: "message", listener: (this: WebSocket, data: WebSocket.Data) => void): this;
on(event: "message", listener: (this: WebSocket, data: WebSocket.RawData, isBinary: boolean) => void): this;
on(event: "open", listener: (this: WebSocket) => void): this;

@@ -139,6 +131,6 @@ on(event: "ping" | "pong", listener: (this: WebSocket, data: Buffer) => void): this;

once(event: "close", listener: (this: WebSocket, code: number, reason: string) => void): this;
once(event: "close", listener: (this: WebSocket, code: number, reason: Buffer) => void): this;
once(event: "error", listener: (this: WebSocket, err: Error) => void): this;
once(event: "upgrade", listener: (this: WebSocket, request: IncomingMessage) => void): this;
once(event: "message", listener: (this: WebSocket, data: WebSocket.Data) => void): this;
once(event: "message", listener: (this: WebSocket, data: WebSocket.RawData, isBinary: boolean) => void): this;
once(event: "open", listener: (this: WebSocket) => void): this;

@@ -152,6 +144,6 @@ once(event: "ping" | "pong", listener: (this: WebSocket, data: Buffer) => void): this;

off(event: "close", listener: (this: WebSocket, code: number, reason: string) => void): this;
off(event: "close", listener: (this: WebSocket, code: number, reason: Buffer) => void): this;
off(event: "error", listener: (this: WebSocket, err: Error) => void): this;
off(event: "upgrade", listener: (this: WebSocket, request: IncomingMessage) => void): this;
off(event: "message", listener: (this: WebSocket, data: WebSocket.Data) => void): this;
off(event: "message", listener: (this: WebSocket, data: WebSocket.RawData, isBinary: boolean) => void): this;
off(event: "open", listener: (this: WebSocket) => void): this;

@@ -165,6 +157,6 @@ off(event: "ping" | "pong", listener: (this: WebSocket, data: Buffer) => void): this;

addListener(event: "close", listener: (code: number, message: string) => void): this;
addListener(event: "close", listener: (code: number, reason: Buffer) => void): this;
addListener(event: "error", listener: (err: Error) => void): this;
addListener(event: "upgrade", listener: (request: IncomingMessage) => void): this;
addListener(event: "message", listener: (data: WebSocket.Data) => void): this;
addListener(event: "message", listener: (data: WebSocket.RawData, isBinary: boolean) => void): this;
addListener(event: "open", listener: () => void): this;

@@ -178,6 +170,6 @@ addListener(event: "ping" | "pong", listener: (data: Buffer) => void): this;

removeListener(event: "close", listener: (code: number, message: string) => void): this;
removeListener(event: "close", listener: (code: number, reason: Buffer) => void): this;
removeListener(event: "error", listener: (err: Error) => void): this;
removeListener(event: "upgrade", listener: (request: IncomingMessage) => void): this;
removeListener(event: "message", listener: (data: WebSocket.Data) => void): this;
removeListener(event: "message", listener: (data: WebSocket.RawData, isBinary: boolean) => void): this;
removeListener(event: "open", listener: () => void): this;

@@ -192,4 +184,12 @@ removeListener(event: "ping" | "pong", listener: (data: Buffer) => void): this;

declare const WebSocketAlias: typeof WebSocket;
type WebSocketAlias = WebSocket;
declare namespace WebSocket {
/**
* Data represents the raw message payload received over the WebSocket.
*/
type RawData = Buffer | ArrayBuffer | Buffer[];
/**
* Data represents the message payload received over the WebSocket.

@@ -260,3 +260,3 @@ */

interface OpenEvent {
interface Event {
type: string;

@@ -297,3 +297,3 @@ target: WebSocket;

verifyClient?: VerifyClientCallbackAsync | VerifyClientCallbackSync | undefined;
handleProtocols?: any;
handleProtocols?: (protocols: Set<string>, request: IncomingMessage) => string | false;
path?: string | undefined;

@@ -304,2 +304,3 @@ noServer?: boolean | undefined;

maxPayload?: number | undefined;
skipUTF8Validation?: boolean | undefined;
}

@@ -363,2 +364,7 @@

const WebSocketServer: typeof Server;
type WebSocketServer = Server;
const WebSocket: typeof WebSocketAlias;
type WebSocket = WebSocketAlias;
// WebSocket stream

@@ -365,0 +371,0 @@ function createWebSocketStream(websocket: WebSocket, options?: DuplexOptions): Duplex;

6

ws/package.json
{
"name": "@types/ws",
"version": "7.4.7",
"version": "8.2.0",
"description": "TypeScript definitions for ws",

@@ -55,4 +55,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ws",

},
"typesPublisherContentHash": "bfa5f3d19c5c1f1c415aec2e218c5c83c4c88b441bb05b2c022b6cfee2c36dfd",
"typeScriptVersion": "3.6"
"typesPublisherContentHash": "a70b4686f870b5b806e91546b00f3001eb3dbce7104b3a2d2250addef08af760",
"typeScriptVersion": "3.7"
}

2

ws/README.md

@@ -11,3 +11,3 @@ # Installation

### Additional Details
* Last updated: Mon, 19 Jul 2021 23:01:29 GMT
* Last updated: Sat, 25 Sep 2021 12:01:21 GMT
* Dependencies: [@types/node](https://npmjs.com/package/@types/node)

@@ -14,0 +14,0 @@ * Global values: none

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc