From 94e686df44d1e7fac58905ca0c3ab0b6cdb60322 Mon Sep 17 00:00:00 2001
From: bencergazda <bencergazda@users.noreply.github.com>
Date: Sun, 31 Oct 2021 19:23:13 +0100
Subject: [PATCH] chore: Add `FileRemoveReason` type (#3283)

* chore: Add `FileRemoveReason` type

* Update packages/@uppy/core/types/index.d.ts

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

* fix: remove `null`

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
---
 packages/@uppy/core/types/index.d.ts | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/packages/@uppy/core/types/index.d.ts b/packages/@uppy/core/types/index.d.ts
index ba995b8d9d..dd7ce6742e 100644
--- a/packages/@uppy/core/types/index.d.ts
+++ b/packages/@uppy/core/types/index.d.ts
@@ -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>,
@@ -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;
@@ -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