@tauri-apps/plugin-websocket
類別
default
建構函式
new default()
new default(id, listeners): default參數
| 參數 | 類型 |
|---|---|
id | number |
listeners | Set<(arg) => void> |
返回
來源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L63
屬性
| 屬性 | 類型 | 定義於 |
|---|---|---|
id | number | 來源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L60 |
方法
addListener()
addListener(cb): () => void參數
| 參數 | 類型 |
|---|---|
cb | (arg) => void |
返回
函式
返回
void
來源: 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>參數
| 參數 | 類型 |
|---|---|
message | 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 |
返回
來源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L68
介面
CloseFrame
屬性
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? | number | 寫入緩衝區的最大大小（以位元組為單位）。在由於寫入錯誤而導致寫入緩衝區填滿的情況下，設定此值可以提供背壓。預設值為無限制。注意：只有在底層流的寫入失敗時，寫入緩衝區才會超出 write_buffer_size。因此，如果您沒有觀察到寫入錯誤，則寫入緩衝區不會填滿。注意：應始終至少為 write_buffer_size + 1 條訊息，並且可能需要更多，具體取決於錯誤處理策略。 | 來源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L23 |
readBufferSize? | number | 讀取緩衝區容量。預設值為 128 KiB。 | 來源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L11 |
writeBufferSize? | number | 寫入緩衝區要達到的目標最小大小，然後再將資料寫入底層流。預設值為 128 KiB。如果設定為 0，則每條訊息都會急切地寫入底層流。通常允許它們緩衝一點是更優的，因此預設值為此。 | 來源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L16 |
MessageKind<T, D>
類型參數
| 類型參數 |
|---|
T |
D |
屬性
類型別名
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
© 2025 Tauri Contributors. CC-BY / MIT