This commit is contained in:
Jonas Kruckenberg
2023-01-06 18:18:16 +01:00
parent b7325b5d1d
commit a2f0e2eb73
17 changed files with 122 additions and 74 deletions
+7 -5
View File
@@ -13,6 +13,7 @@ There are three general methods of installation that we can recommend.
Install the Core plugin by adding the following to your `Cargo.toml` file:
`src-tauri/Cargo.toml`
```toml
[dependencies]
tauri-plugin-websocket = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" }
@@ -26,7 +27,7 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
pnpm add https://github.com/tauri-apps/tauri-plugin-websocket
# or
npm add https://github.com/tauri-apps/tauri-plugin-websocket
# or
# or
yarn add https://github.com/tauri-apps/tauri-plugin-websocket
```
@@ -35,6 +36,7 @@ yarn add https://github.com/tauri-apps/tauri-plugin-websocket
First you need to register the core plugin with Tauri:
`src-tauri/src/main.rs`
```rust
fn main() {
tauri::Builder::default()
@@ -47,13 +49,13 @@ fn main() {
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
```javascript
import { WebSocket } from 'tauri-plugin-websocket-api'
import { WebSocket } from "tauri-plugin-websocket-api";
const ws = await WebSocket.connect('wss://example.com')
const ws = await WebSocket.connect("wss://example.com");
await ws.send('Hello World')
await ws.send("Hello World");
await ws.disconnect()
await ws.disconnect();
```
## Contributing