From b7ecab5431d13d8d5b97fa8588a1282e27b90029 Mon Sep 17 00:00:00 2001 From: Antoine du Hamel Date: Tue, 7 Jun 2022 07:47:22 +0200 Subject: [PATCH] @uppy/core,@uppy/dashboard: fix types for some events (#3812) --- packages/@uppy/core/types/index.d.ts | 8 ++++---- packages/@uppy/core/types/index.test-d.ts | 6 +++--- packages/@uppy/dashboard/types/index.d.ts | 4 ++-- packages/@uppy/dashboard/types/index.test-d.ts | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/packages/@uppy/core/types/index.d.ts b/packages/@uppy/core/types/index.d.ts index 1e4307b840..70f6f382e2 100644 --- a/packages/@uppy/core/types/index.d.ts +++ b/packages/@uppy/core/types/index.d.ts @@ -209,12 +209,12 @@ export type FilesAddedCallback = (files: UppyFile[]) => void; export type FileRemovedCallback = (file: UppyFile, reason: FileRemoveReason) => void; export type UploadCallback = (data: { id: string, fileIDs: string[] }) => void; export type ProgressCallback = (progress: number) => void; -export type PreProcessCompleteCallback = (file: UppyFile) => void; -export type UploadProgressCallback = (file: UppyFile, progress: FileProgress) => void; -export type UploadSuccessCallback = (file: UppyFile, response: SuccessResponse) => void +export type PreProcessCompleteCallback = (file: UppyFile | undefined) => void; +export type UploadProgressCallback = (file: UppyFile | undefined, progress: FileProgress) => void; +export type UploadSuccessCallback = (file: UppyFile | undefined, response: SuccessResponse) => void export type UploadCompleteCallback = (result: UploadResult) => void export type ErrorCallback = (error: Error) => void; -export type UploadErrorCallback = (file: UppyFile, error: Error, response?: ErrorResponse) => void; +export type UploadErrorCallback = (file: UppyFile | undefined, error: Error, response?: ErrorResponse) => void; export type UploadRetryCallback = (fileID: string) => void; // TODO: reverse the order in the next major version export type RestrictionFailedCallback = (file: UppyFile | undefined, error: Error) => void; diff --git a/packages/@uppy/core/types/index.test-d.ts b/packages/@uppy/core/types/index.test-d.ts index cf70453b79..a08e5f8dd3 100644 --- a/packages/@uppy/core/types/index.test-d.ts +++ b/packages/@uppy/core/types/index.test-d.ts @@ -104,8 +104,8 @@ type anyObject = Record }) // Separate event handlers - const handleUpload = (file: UppyFile) => { - const meta = file.meta.myCustomMetadata + const handleUpload = (file?: UppyFile) => { + const meta = file?.meta.myCustomMetadata } uppy.off<'upload-success', Meta>('upload-success', handleUpload) @@ -114,7 +114,7 @@ type anyObject = Record body?: { someValue: string } } - const onUploadSuccess = async (file: UppyFile, response: CustomResponse) => { + const onUploadSuccess = async (file: UppyFile | undefined, response: CustomResponse) => { const res = response.body?.someValue } uppy.on<'upload-success', Meta>('upload-success', onUploadSuccess) diff --git a/packages/@uppy/dashboard/types/index.d.ts b/packages/@uppy/dashboard/types/index.d.ts index 2869d1fee5..e0e0fca32c 100644 --- a/packages/@uppy/dashboard/types/index.d.ts +++ b/packages/@uppy/dashboard/types/index.d.ts @@ -84,8 +84,8 @@ export default Dashboard // Events -export type DashboardFileEditStartCallback = (file: UppyFile) => void; -export type DashboardFileEditCompleteCallback = (file: UppyFile) => void; +export type DashboardFileEditStartCallback = (file?: UppyFile) => void; +export type DashboardFileEditCompleteCallback = (file?: UppyFile) => void; declare module '@uppy/core' { export interface UppyEventMap { 'dashboard:modal-open': GenericEventCallback diff --git a/packages/@uppy/dashboard/types/index.test-d.ts b/packages/@uppy/dashboard/types/index.test-d.ts index 6121369ed5..4f999b3413 100644 --- a/packages/@uppy/dashboard/types/index.test-d.ts +++ b/packages/@uppy/dashboard/types/index.test-d.ts @@ -54,7 +54,7 @@ import Dashboard from '..' uppy.on('dashboard:file-edit-state', (file) => { // eslint-disable-next-line @typescript-eslint/no-unused-vars - const fileName = file.name + const fileName = file?.name }) }