@tauri-apps/plugin-websocket

Classes

default

Defined in: plugins/websocket/guest-js/index.ts:59

Constructors

new default()

new default(id, listeners): default;

Defined in: plugins/websocket/guest-js/index.ts:63

Parameters

Parameter	Type
id	number
listeners	Set<(arg) => void>

Returns

default

Properties

Property	Type	Defined in
id	number	plugins/websocket/guest-js/index.ts:60

Methods

addListener()

addListener(cb): () => void;

Defined in: plugins/websocket/guest-js/index.ts:92

Parameters

Parameter	Type
cb	(arg) => void

Returns

() => void

disconnect()

disconnect(): Promise<void>;

Defined in: plugins/websocket/guest-js/index.ts:119

Returns

Promise<void>

send()

send(message): Promise<void>;

Defined in: plugins/websocket/guest-js/index.ts:100

Parameters

Parameter	Type
message	| string | number[] | Message

Returns

Promise<void>

connect()

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

Defined in: plugins/websocket/guest-js/index.ts:68

Parameters

Parameter	Type
url	string
config?	ConnectionConfig

Returns

Promise<default>

Interfaces

CloseFrame

Defined in: plugins/websocket/guest-js/index.ts:47

Properties

Property	Type	Defined in
code	number	plugins/websocket/guest-js/index.ts:48
reason	string	plugins/websocket/guest-js/index.ts:49

---

ConnectionConfig

Defined in: plugins/websocket/guest-js/index.ts:7

Properties

Property	Type	Description	Defined in
acceptUnmaskedFrames?	boolean	When set to true, the server will accept and handle unmasked frames from the client. According to the RFC 6455, the server must close the connection to the client in such cases, however it seems like there are some popular libraries that are sending unmasked frames, ignoring the RFC. By default this option is set to false, i.e. according to RFC 6455.	plugins/websocket/guest-js/index.ts:35
headers?	HeadersInit	Additional connect request headers.	plugins/websocket/guest-js/index.ts:39
maxFrameSize?	number | "none"	The maximum size of a single incoming message frame. The string “none” means no size limit. The limit is for frame payload NOT including the frame header. The default value is 16 MiB which should be reasonably big for all normal use-cases but small enough to prevent memory eating by a malicious user.	plugins/websocket/guest-js/index.ts:31
maxMessageSize?	number | "none"	The maximum size of an incoming message. The string “none” means no size limit. The default value is 64 MiB which should be reasonably big for all normal use-cases but small enough to prevent memory eating by a malicious user.	plugins/websocket/guest-js/index.ts:27
maxWriteBufferSize?	number	The max size of the write buffer in bytes. Setting this can provide backpressure in the case the write buffer is filling up due to write errors. The default value is unlimited. Note: The write buffer only builds up past write_buffer_size when writes to the underlying stream are failing. So the write buffer can not fill up if you are not observing write errors. Note: Should always be at least write_buffer_size + 1 message and probably a little more depending on error handling strategy.	plugins/websocket/guest-js/index.ts:23
readBufferSize?	number	Read buffer capacity. The default value is 128 KiB.	plugins/websocket/guest-js/index.ts:11
writeBufferSize?	number	The target minimum size of the write buffer to reach before writing the data to the underlying stream. The default value is 128 KiB. If set to 0 each message will be eagerly written to the underlying stream. It is often more optimal to allow them to buffer a little, hence the default value.	plugins/websocket/guest-js/index.ts:16

---

MessageKind

Defined in: plugins/websocket/guest-js/index.ts:42

Type Parameters

Type Parameter
T
D

Properties

Property	Type	Defined in
data	D	plugins/websocket/guest-js/index.ts:44
type	T	plugins/websocket/guest-js/index.ts:43

Type Aliases

Message

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

Defined in: plugins/websocket/guest-js/index.ts:52