使用 ws-modified-for-modifying-handshake-operations npm 包的教程-JavaScript中文网-JavaScript教程资源分享门户

什么是 ws-modified-for-modifying-handshake-operations

ws-modified-for-modifying-handshake-operations 是一个 npm 包，它是基于 WebSocket 协议实现的模块，目的是帮助用户修改 WebSocket 握手操作。此包的核心代码来自于 ws 包，但是扩展了某些功能。

安装

使用 npm 安装 ws-modified-for-modifying-handshake-operations

npm install ws-modified-for-modifying-handshake-operations

用法

在 Node.js 应用程序中使用 ws-modified-for-modifying-handshake-operations npm 包的例子：

const WebSocket = require('ws-modified-for-modifying-handshake-operations')

const socket = new WebSocket('ws://localhost:8080', {
  handshakeTimeout: 60000,
  headers: {
    'Authorization': 'Bearer XXXXXXXX'
  }
})

上面这个例子创建了一个 WebSocket 连接到本地主机的端口 8080，它包含一个 Authorization 头部，用于连接到保护的 WebSocket 服务器。

可以使用 ws-modified-for-modifying-handshake-operations 包提供的所有 API，还可以使用 ws 包提供的 API。

下面是一些 ws-modified-for-modifying-handshake-operations 中新增的方法：

WebSocket constructor

WebSocket constructor 接受两个参数：URL 和 options 对象。options 对象包含下列属性：

handshakeTimeout

握手超时时间（单位：毫秒）
headers

自定义请求头。

WebSocket#cookies

包含服务器发送的所有 cookies。如果 cookies 不存在，则返回空对象。

WebSocket#readyState

WebSocket 的状态，可能是下列值中的一个：

WebSocket.CONNECTING

连接正在被建立

WebSocket.OPEN

连接已经建立并且可以通讯

WebSocket.CLOSING

连接正在关闭

WebSocket.CLOSED

连接已经关闭或者无法打开

WebSocket#send(message[, options][, callback])

发送消息。

message：将要发送的消息。（必需）
options：传输选项
callback：当成功发送消息时调用的函数

WebSocket#close([code[, reason]])

关闭连接。

code：关闭的状态代码，默认是 1000。
reason：人类可读的字符串，描述关闭原因或者信息。

总结

在本文中，我们介绍了使用 npm 包 ws-modified-for-modifying-handshake-operations 的方法和 API。我们详细讨论了如何使用 ws-modified-for-modifying-handshake-operations 包中的新功能和扩展功能。此包的功能是为了实现 WebSocket 握手操作的修改。我们介绍了在 Node.js 应用程序中如何使用此包的例子。我们还提供了一些示例代码，帮助读者理解使用方法。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/600671158dd3466f61ffe619