Jesper L. Nielsen
4a5ab18a22
* fix(upload): return type on POST is now string A POST to a webserver can not always be expected to be a JSON response. Success is now determined by the HTTP return code. Upon success the body content is returned as a string. * feat: add content-length on POST Not all embedded devices are acceptable to receiving unspecified amounts of data. Appending the content-length up front helps this devices succeed. * fix: return values unified The return values was not used. On POST the HTTP error code is returned as an enum. * fix: upload, return value as string * Update plugins/upload/src/lib.rs Co-authored-by: Lucas Fernandes Nogueira <lucas@tauri.app> * Update plugins/upload/src/lib.rs Co-authored-by: Lucas Fernandes Nogueira <lucas@tauri.app> * fix: added covector changelog file --------- Co-authored-by: Lucas Fernandes Nogueira <lucas@tauri.app>
Upload files from disk to a remote server over HTTP. Download files from a remote HTTP server to disk.
Install
This plugin requires a Rust version of at least 1.64
There are three general methods of installation that we can recommend.
- Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
- Pull sources directly from Github using git tags / revision hashes (most secure)
- Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
Install the Core plugin by adding the following to your Cargo.toml file:
src-tauri/Cargo.toml
[dependencies]
tauri-plugin-upload = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v1" }
You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
pnpm add https://github.com/tauri-apps/tauri-plugin-upload#v1
# or
npm add https://github.com/tauri-apps/tauri-plugin-upload#v1
# or
yarn add https://github.com/tauri-apps/tauri-plugin-upload#v1
Usage
First you need to register the core plugin with Tauri:
src-tauri/src/main.rs
fn main() {
tauri::Builder::default()
.plugin(tauri_plugin_upload::init())
.run(tauri::generate_context!())
.expect("error while running tauri application");
}
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
import { upload } from "tauri-plugin-upload-api";
upload(
"https://example.com/file-upload",
"./path/to/my/file.txt",
(progress, total) => console.log(`Uploaded ${progress} of ${total} bytes`), // a callback that will be called with the upload progress
{ "Content-Type": "text/plain" }, // optional headers to send with the request
);
import { download } from "tauri-plugin-upload-api";
download(
"https://example.com/file-download-link",
"./path/to/save/my/file.txt",
(progress, total) => console.log(`Downloaded ${progress} of ${total} bytes`), // a callback that will be called with the download progress
{ "Content-Type": "text/plain" }, // optional headers to send with the request
);
Contributing
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
Partners
|
For the complete list of sponsors please visit our website and Open Collective.
License
Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
MIT or MIT/Apache 2.0 where applicable.