Skip to content
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

Jump to bottom

docs(mux-uploader): Explicit return value of null in success callback reference #981

Merged
merged 1 commit into from
Sep 18, 2024
Merged

docs(mux-uploader): Explicit return value of null in success callback reference #981

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion packages/mux-uploader/REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ In addition to the attributes listed below, `<mux-uploader>` supports standard `
| `pausedchange` | `boolean` `paused` state | Dispatched when the `paused` upload state changes. Note that pausing will wait until the currently uploading chunk finishes. |
| `progress` | The `number` percent | Dispatched whenever the chunked upload progress changes, including mid-chunk. Provides the percent of the file uploaded thus far. |
| `reset` | N/A | Dispatched to notify that the uploader's UI and state should be reset, e.g. when a user clicks "retry". As such, manually dispatching this event on `<mux-uploader>` will also prompt a reset (though you should only do this if an upload has failed). |
| `success` | `detail type` | Dispatched when all chunks have been successfully uploaded. |
| `success` | `null` | Dispatched when all chunks have been successfully uploaded. |
| `uploadstart` | `{ file: File; chunkSize: number; }` | Dispatched when uploading the file begins. |
| `uploaderror` | `{ message: string; chunkNumber: number; attempts: number; }` | Dispatched when an error occurs while attempting to upload. Provides the number of (failed) attempts to upload a chunk, the chunk number, and the corresponding error message as a `detail`. |

Expand Down
Loading