Skip to content

fix(upload): wrong progress callback parameter names in README #3406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Zhoucheng133 wants to merge 2 commits into
base: v2
Choose a base branch
from
+6 −3
Open

fix(upload): wrong progress callback parameter names in README #3406

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bead3fc
Update progress callback parameter names in README
Zhoucheng133 Apr 26, 2026
24fccd0
formatting
Zhoucheng133 Apr 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions plugins/upload/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,17 @@ import { upload, HttpMethod } from '@tauri-apps/plugin-upload'
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
(progressTotal, total) =>
console.log(`Uploaded ${progressTotal} of ${total} bytes`), // a callback that will be called with the upload progress
{ 'Content-Type': 'text/plain' } // optional headers to send with the request
)

// Upload with specific HTTP method
upload(
'https://example.com/file-upload',
'./path/to/my/file.txt',
(progress, total) => console.log(`Uploaded ${progress} of ${total} bytes`),
(progressTotal, total) =>
console.log(`Uploaded ${progressTotal} of ${total} bytes`),
{ 'Content-Type': 'text/plain' },
HttpMethod.Put // Use HttpMethod enum - supports POST, PUT, PATCH
)
Expand All @@ -86,7 +88,8 @@ import { download } from '@tauri-apps/plugin-upload'
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
(progressTotal, total) =>
console.log(`Downloaded ${progressTotal} of ${total} bytes`), // a callback that will be called with the download progress
{ 'Content-Type': 'text/plain' } // optional headers to send with the request
)
```
Expand Down