@tauri-apps/plugin-websocket

Classes

default

Constructors

constructor()

new default(id, listeners): default

Parameters

Parameter	Type
id	number
listeners	(arg) => void[]

Returns

default

Source: index.ts:37

Properties

Property	Type
id	number
private readonly listeners	(arg) => void[]

Methods

addListener()

addListener(cb): void

Parameters

Parameter	Type
cb	(arg) => void

Returns

void

Source: index.ts:64

---

disconnect()

disconnect(): Promise< void >

Returns

Promise< void >

Source: index.ts:87

---

send()

send(message): Promise< void >

Parameters

Parameter	Type
message	string | number[] | Message

Returns

Promise< void >

Source: index.ts:68

---

connect()

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

Parameters

Parameter	Type
url	string
config?	ConnectionConfig

Returns

Promise< default >

Source: index.ts:42

Interfaces

CloseFrame

Properties

Property	Type
code	number
reason	string

---

ConnectionConfig

Properties

Property	Type
acceptUnmaskedFrames?	boolean
headers?	HeadersInit
maxFrameSize?	number
maxMessageSize?	number
maxWriteBufferSize?	number
writeBufferSize?	number

---

MessageKind

Type parameters

Parameter
T
D

Properties

Property	Type
data	D
type	T

Type Aliases

Message

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

Source: index.ts:26