Websocket

GitHubnpmcrates.io

Referencia de API

Abre una conexión WebSocket usando un cliente Rust en JavaScript.

Plataformas Soportadas

Este plugin requiere una versión de Rust de al menos 1.77.2

Plataforma	Nivel	Notas
windows
linux
macos
android
ios

Configuración

Instala el plugin websocket para comenzar.

Automático

Usa el gestor de paquetes de tu proyecto para agregar la dependencia:

npm

npm run tauri add websocket

yarn

yarn run tauri add websocket

pnpm

pnpm tauri add websocket

deno

deno task tauri add websocket

bun

bun tauri add websocket

cargo

cargo tauri add websocket

Manual

1. Ejecuta el siguiente comando en la carpeta src-tauri para agregar el plugin a las dependencias del proyecto en Cargo.toml:

   cargo add tauri-plugin-websocket

2. Modifica lib.rs para inicializar el plugin:

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .plugin(tauri_plugin_websocket::init())
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. Instala los bindings de JavaScript utilizando tu gestor de paquetes de JavaScript preferido:

   npm

   npm install @tauri-apps/plugin-websocket

   yarn

   yarn add @tauri-apps/plugin-websocket

   pnpm

   pnpm add @tauri-apps/plugin-websocket

   deno

   deno add npm:@tauri-apps/plugin-websocket

   bun

   bun add @tauri-apps/plugin-websocket

Uso

El plugin websocket está disponible en JavaScript.

import WebSocket from '@tauri-apps/plugin-websocket';
// when using `"withGlobalTauri": true`, you may use
// const WebSocket = window.__TAURI__.websocket;

const ws = await WebSocket.connect('ws://127.0.0.1:8080');

const removeListener = ws.addListener((msg) => {
  console.log('Received Message:', msg);
});

await ws.send('Hello World!');

// optionally remove the listener
removeListener();

await ws.disconnect();

Permisos

De forma predeterminada, todos los comandos y alcances (scopes) potencialmente peligrosos del plugin están bloqueados y no se puede acceder a ellos. Debes modificar los permisos en tu configuración de capabilities para habilitarlos.

Consulta la Visión General de Capacidades para obtener más información y la guía paso a paso para usar permisos de plugins.

src-tauri/capabilities/default.json

{
  "$schema": "../gen/schemas/desktop-schema.json",
  "identifier": "main-capability",
  "description": "Capability for the main window",
  "windows": ["main"],
  "permissions": ["websocket:default"]
}

Permiso Predeterminado

Permite conectarse y enviar datos a un servidor WebSocket

Este conjunto de permisos predeterminado incluye lo siguiente:

• allow-connect
• allow-send

Tabla de Permisos

Identificador	Descripción
websocket:allow-connect	Habilita el comando connect sin ningún alcance preconfigurado.
websocket:deny-connect	Deniega el comando connect sin ningún alcance preconfigurado.
websocket:allow-send	Habilita el comando send sin ningún alcance preconfigurado.
websocket:deny-send	Deniega el comando send sin ningún alcance preconfigurado.