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

improve cancelAll and destroy() docs #5408

Merged
merged 5 commits into from
Aug 15, 2024
Merged

improve cancelAll and destroy() docs #5408

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6a301c7
improve cancelAll docs
mifi Aug 14, 2024
24d3919
Update uppy-core.mdx
mifi Aug 14, 2024
209e00e
Update uppy-core.mdx
mifi Aug 14, 2024
5f61201
Update uppy-core.mdx
mifi Aug 14, 2024
87c6a54
lint
aduh95 Aug 15, 2024
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
11 changes: 8 additions & 3 deletions docs/uppy-core.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -704,7 +704,8 @@ uppy.removeFile('uppyteamkongjpg1501851828779');
#### `clear()`

Clear the state. Can be useful for manually resetting Uppy after a successful
upload.
upload. Note that this method might throw an error if you try to call it while
an upload is ongoing.

Upload plugins may choose to throw an error if called during an upload.

Expand Down Expand Up @@ -773,7 +774,9 @@ Retry all uploads (after an error, for example).

#### `cancelAll()`

Cancel all uploads, reset progress and remove all files.
Cancel all uploads, reset progress and remove all files. If you are using the
Transloadit plugin, this will also cancel all running assemblies, even after an
upload has finished.

#### `setState(patch)`

Expand Down Expand Up @@ -880,7 +883,9 @@ uppy.getPlugin('Dashboard').setOptions({
#### `destroy()`

Uninstall all plugins and close down this Uppy instance. Also runs
`uppy.cancelAll()` before uninstalling.
`uppy.cancelAll()` before uninstalling. Note that this method should not
normally be used. If you only want reset the Uppy instance so that you can start
a new upload, you probably want to use `clear()` method instead.

#### `logout()`

Expand Down
Loading