@tauri-apps/plugin-websocket

类

default

构造函数

new default()

new default(id, listeners): default

参数

参数	类型
ID	数字
listeners	Set<(arg) => void>

返回

default

源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L63

属性

属性	类型	定义于
id	数字	源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L60

方法

addListener()

addListener(cb): () => void

参数

参数	类型
cb	(arg) => void

返回

Function

返回

空

源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L92

disconnect()

disconnect(): Promise<void>

返回

Promise<void>

源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L119

send()

send(message): Promise<void>

参数

参数	类型
消息	string | number[] | Message

返回

Promise<void>

源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L100

connect()

static connect(url, config?): Promise<default>

参数

参数	类型
url	string
config?	ConnectionConfig

返回

Promise<default>

源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L68

接口

CloseFrame

属性

属性	类型	定义于
code	数字	源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L48
reason	string	源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L49

---

ConnectionConfig

属性

属性	类型	描述	定义于
acceptUnmaskedFrames?	布尔值 (boolean)	设置为 true 时，服务器将接受并处理来自客户端的未掩码帧。根据 RFC 6455 规定，在这种情况下，服务器必须关闭与客户端的连接，但是似乎有一些流行的库会发送未掩码帧，从而忽略 RFC。默认情况下，此选项设置为 false，即遵循 RFC 6455。	源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L35
headers?	HeadersInit	额外的连接请求头。	源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L39
maxFrameSize?	number | "none"	单个传入消息帧的最大大小。“none”表示无大小限制。此限制针对帧有效载荷，不包括帧头。默认值为 16 MiB，这对于所有正常用例来说应该足够大，但又足够小以防止恶意用户占用内存。	源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L31
maxMessageSize?	number | "none"	传入消息的最大大小。“none”表示无大小限制。默认值为 64 MiB，这对于所有正常用例来说应该足够大，但又足够小以防止恶意用户占用内存。	源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L27
maxWriteBufferSize?	数字	写入缓冲区的最大大小（以字节为单位）。设置此项可在写入缓冲区因写入错误而填满时提供背压。默认值为无限制。注意：只有当底层流的写入失败时，写入缓冲区才会超出 write_buffer_size。因此，如果您未观察到写入错误，则写入缓冲区不会填满。注意：应始终至少为 write_buffer_size + 1 条消息，并根据错误处理策略再多一点。	源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L23
readBufferSize?	数字	读取缓冲区容量。默认值为 128 KiB。	源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L11
writeBufferSize?	数字	写入缓冲区在将数据写入底层流之前要达到的目标最小大小。默认值为 128 KiB。如果设置为 0，则每条消息都将立即写入底层流。通常，允许它们稍微缓冲一下会更优化，因此有默认值。	源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L16

---

MessageKind<T, D>

类型参数

类型参数
T
D

属性

属性	类型	定义于
data	D	源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L44
type	T	源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L43

类型别名 (Type Aliases)

Message

type Message:
  | MessageKind<"Text", string>
  | MessageKind<"Binary", number[]>
  | MessageKind<"Ping", number[]>
  | MessageKind<"Pong", number[]>
| MessageKind<"Close", CloseFrame | null>;

源文件: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L52