@tauri-apps/plugin-websocket

Clases

default

Constructores

new default()

new default(id, listeners): default

Parámetros

Parámetro	Tipo
id	number
listeners	Set<(arg) => void>

Devuelve

default

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

Propiedades

Propiedad	Tipo	Definido en
id	number	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L60

Métodos

addListener()

addListener(cb): () => void

Parámetros

Parámetro	Tipo
cb	(arg) => void

Devuelve

Function

Devuelve

void

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

disconnect()

disconnect(): Promise<void>

Devuelve

Promise<void>

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

send()

send(message): Promise<void>

Parámetros

Parámetro	Tipo
message	string | number[] | Message

Devuelve

Promise<void>

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

connect()

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

Parámetros

Parámetro	Tipo
url	string
config?	ConnectionConfig

Devuelve

Promise<default>

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

Interfaces

CloseFrame

Propiedades

Propiedad	Tipo	Definido en
code	number	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L48
reason	string	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L49

---

ConnectionConfig

Propiedades

Propiedad	Tipo	Descripción	Definido en
acceptUnmaskedFrames?	boolean	Cuando se establece en true, el servidor aceptará y gestionará tramas (frames) no enmascaradas del cliente. De acuerdo con el RFC 6455, el servidor debe cerrar la conexión con el cliente en tales casos, sin embargo parece que hay algunas librerías populares que envían tramas no enmascaradas, ignorando el RFC. Por defecto esta opción está establecida en false, es decir, de acuerdo con el RFC 6455.	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L35
headers?	HeadersInit	Encabezados adicionales de solicitud de conexión.	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L39
maxFrameSize?	number | "none"	El tamaño máximo de una sola trama de mensaje entrante. La cadena "none" significa sin límite de tamaño. El límite es para la carga útil (payload) de la trama, NO incluyendo el encabezado de la trama. El valor por defecto es 16 MiB, lo cual debería ser razonablemente grande para todos los casos de uso normales pero lo suficientemente pequeño para evitar el consumo excesivo de memoria por un usuario malicioso.	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L31
maxMessageSize?	number | "none"	El tamaño máximo de un mensaje entrante. La cadena "none" significa sin límite de tamaño. El valor por defecto es 64 MiB, lo cual debería ser razonablemente grande para todos los casos de uso normales pero lo suficientemente pequeño para evitar el consumo excesivo de memoria por un usuario malicioso.	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L27
maxWriteBufferSize?	number	El tamaño máximo del búfer de escritura en bytes. Configurar esto puede proporcionar contrapresión (backpressure) en caso de que el búfer de escritura se esté llenando debido a errores de escritura. El valor por defecto es ilimitado. Nota: El búfer de escritura solo aumenta más allá de write_buffer_size cuando las escrituras en el flujo subyacente están fallando. Por lo tanto, el búfer de escritura no se puede llenar si no estás observando errores de escritura. Nota: Siempre debería ser al menos write_buffer_size + 1 mensaje y probablemente un poco más dependiendo de la estrategia de manejo de errores.	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L23
readBufferSize?	number	Capacidad del búfer de lectura. El valor por defecto es 128 KiB.	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L11
writeBufferSize?	number	El tamaño mínimo objetivo del búfer de escritura a alcanzar antes de escribir los datos en el flujo subyacente. El valor por defecto es 128 KiB. Si se establece en 0, cada mensaje se escribirá inmediatamente en el flujo subyacente. A menudo es más óptimo permitirles almacenar un poco en búfer, de ahí el valor por defecto.	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L16

---

MessageKind<T, D>

Parámetros de tipo

Parámetro de tipo
T
D

Propiedades

Propiedad	Tipo	Definido en
data	D	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L44
type	T	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/websocket/guest-js/index.ts#L43

Alias de tipos

Message

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

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