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

chore: Add FileRemoveReason type #3283

Merged
merged 3 commits into from
Oct 31, 2021
Merged

chore: Add FileRemoveReason type #3283

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8971b0e
chore: Add `FileRemoveReason` type
bencergazda Oct 29, 2021
5ead438
Update packages/@uppy/core/types/index.d.ts
bencergazda Oct 29, 2021
7610349
fix: remove `null`
bencergazda Oct 29, 2021
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
6 changes: 4 additions & 2 deletions packages/@uppy/core/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ export type UppyFile<

export type FileProgress = UppyUtils.FileProgress;

export type FileRemoveReason = 'removed-by-user' | 'cancel-all';

// Replace the `meta` property type with one that allows omitting internal metadata addFile() will add that
type UppyFileWithoutMeta<TMeta, TBody> = OmitKey<
UppyFile<TMeta, TBody>,
Expand Down Expand Up @@ -203,7 +205,7 @@ export interface SuccessResponse {
export type GenericEventCallback = () => void;
export type FileAddedCallback<TMeta> = (file: UppyFile<TMeta>) => void;
export type FilesAddedCallback<TMeta> = (files: UppyFile<TMeta>[]) => void;
export type FileRemovedCallback<TMeta> = (file: UppyFile<TMeta>, reason: 'removed-by-user' | 'cancel-all') => void;
export type FileRemovedCallback<TMeta> = (file: UppyFile<TMeta>, reason: FileRemoveReason) => void;
export type UploadCallback = (data: { id: string, fileIDs: string[] }) => void;
export type ProgressCallback = (progress: number) => void;
export type UploadProgressCallback<TMeta> = (file: UppyFile<TMeta>, progress: FileProgress) => void;
Expand Down Expand Up @@ -318,7 +320,7 @@ export class Uppy {
file: AddFileOptions<TMeta>
): string

removeFile(fileID: string): void
removeFile(fileID: string, reason?: FileRemoveReason): void

pauseResume(fileID: string): boolean

Expand Down